Get ASN Spreadsheet Preview
GET/api/shiphero/integration-instances/:integrationInstance/asn/spreadsheet-preview
Preview the backup ASN spreadsheet the connection's 3PL is emailed: the file name, the email subject and recipients, and every row (header row first) in the chosen column layout, for a recent purchase order going to one of the connection's mapped warehouses. Built from the same code that sends the email, so it matches what the 3PL receives. Nothing is sent and ShipHero is not contacted.
integrations:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Requires the integrations.show permission.
purchase_orders lists up to 20 recent purchase orders (newest first) that can be previewed. When there are none, is_sample is true and a two-line sample PO is shown, with the email template's unfilled subject.
The ISN four-column layout is always a CSV named ISN-{PO number}.csv; the default layout uses the account's ASN file format (CSV, XLSX or XLS) and is named ASN {PO number}.{format}.
warnings explains anything that would stop the email going out (no email on the destination address, or the ASN email template turned off); subject is null when the template is off.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.