Download OpenAPI specification:Download
The Inbound Advance Shipping Notice API allows clients to notify our system when a shipment is inbound. The data sent will be used to receive and reconcile against.
The ASN API will return a HTTP status code 202 to indicate that the request was processed successfully and that the provided ASN is queued for creation.
Error response will be HTTP status code 400 for other bad/unparseable requests.
Error response will be HTTP status code 401 for missing or bad api_key (these have no body).
Error response will be HTTP status code 422 for validation errors (missing or invalid fields in this case).
{- "program_identifier": "consumer_returns",
- "from": {
- "identifier": 22,
- "type": "Warehouse"
}, - "to": {
- "identifier": 1352,
- "type": "Store"
}, - "asn_number": "SO00001234",
- "shipment_identifier": "SI1ZAAAAAAZZ97764680",
- "tracking_number": "1Z123123123123",
- "carrier": "UPS",
- "ship_date": "2019-03-15T00:00:00Z",
- "status": "shipped",
- "details_type": "unit",
- "asn_type": "MR",
- "cartons": [
- {
- "identifier": "CTAA1234567",
- "reference": {
- "type": "RMA",
- "identifier": 12345,
- "alternate_identifier": "OR12345678"
}, - "details": [
- {
- "line_identifier": 123456789,
- "unit_identifier": 123456891011,
- "reference_line_identifier": 1,
- "sku": "S123456",
- "upc": 12345678905,
- "quantity": 1,
- "vendor_identifier": "vnd_3001",
- "serial_number": 12345689,
- "condition": "N",
- "eligibility_flags": [
- [
- "personalized"
]
], - "sell_date": "2021-01-10T00:00:00Z",
- "return_date": "2021-01-10T00:00:00Z",
- "labels": [
- {
- "type": "text",
- "name": "title",
- "value": "Printing this title"
}
], - "merchant": "Best Buy",
- "concept": "Insignia",
- "asin": 1234567890,
- "return_reason": "Wrong Item Sent"
}
]
}
], - "messagetimestamp": "2019-10-16T10:59:20"
}
{- "message": "Validation Failed",
- "errors": [
- {
- "field": "reference_number",
- "code": "missing_field"
}
]
}
ASNs may be updated to change the status of the ASN overall or the status of a detail line. See above for permitted status values. ASN Number should be included as part of the url.
api-version required | string There are currently two supported versions of the Inbound Advance Shipping Notice API. Version 2 adds support for the Example: 1 |
The ASN API will return a HTTP status code 202 to indicate that the request was processed successfully and that the provided ASN is queued for creation.
Error response will be HTTP status code 400 for other bad/unparseable requests.
Error response will be HTTP status code 401 for missing or bad api_key (these have no body).
Error response will be HTTP status code 422 for validation errors (missing or invalid fields in this case).
{- "status": "cancelled",
- "program_identifier": "program_identifier"
}
{- "message": "Validation Failed",
- "errors": [
- {
- "field": "reference_number",
- "code": "missing_field"
}
]
}