You are here:
ASN (Advanced Shipping Notice) Feed
The Advanced Shipping Notice (ASN) feed provides specifications for inbound shipping notices in Point of Sale. Warehouse shipping information is sent to receiving clerks before merchandise arrives at the store. Receiving clerks use ASN to verify delivered merchandise by scanning barcodes, labels, pallets, cartons, or UPC tags. Once received, the merchandise is added to the on-hand item list.
Format
The feed formats are CSV (comma-separated), TSV (tab-separated), and ASN EDI 856 (EDI Advance Ship Notice).
Important:
- All feed files should be saved in a UTF-8 (not to be confused with UTF-8 with BOM) format else you receive an error during upload.
orderId,palletId, andcartonId(via feed or API) must be unique. When the app sends the ID to the scan endpoint and receives a response, it cannot distinguish between an order, pallet, or carton within the same ASN. As a result, it defaults to the top-level order, even if the scanned item was a carton or pallet, which may lead to downstream issues.
Content
| CMS Field Display Name | Mandatory | Description | Data Type | MAX CHARACTER LIMIT | Sample Data |
|---|---|---|---|---|---|
| cartonId | Yes | The carton ID (barcode of the carton). A pallet can have multiple unique cartonId. Important: Must be a unique from palletId and orderId. |
Number | 128 | 1 |
| createdOn | Yes | The timestamp of when a shipment was created. This needs to be in the format of yyyyMMddHHmm. | Number | TIMESTAMP | 202010210900 |
| orderId | Yes | The order ID (barcode of the order which generated this ASN). Important: Must be a unique from palletId and cartonId. |
Number | 128 | 1 |
| palletId | Yes | The pallet ID (barcode of the pallet). ASN feed can have either an empty palletId or have multiple unique palletIds. Important: Must be a unique from orderId and cartonId. |
Number | 128 | 1 |
| productId | Yes | The product ID. A carton can have multiple products with the same ID. | String | 128 | prod123 |
| quantity | Yes | The product quantity. This needs to be an integer value rather than a decimal. | Number | INT | 5 |
| shipFromLocationId | Yes | The ID of the ship from location (store ID of store/warehouse added in Retail Cloud. | Number | 128 | 1 |
| shipmentId | Yes | The ID of the shipment (also known as the ASN ID). | Number | 128 | 1 |
| shippedOn | Yes | The timestamp of when a shipment has been shipped in the format of yyyyMMddHHmm. | Number | TIMESTAMP | 202010211100 |
| shipToLocationId | Yes | The ID of the ship to location (store ID of store/warehouse added in Retail Cloud). | Number | 128 | 2 |
| carrier | No | The shipment carrier, if available. | String | 128 | UPS |
| externalDocNumber | No | The document number in the external system. | 64 | ||
| externalLineNumber | No | The document line number in the external system. | 64 | ||
| poNumber | No | The shipment PO number, if available. | String | 128 | 1-1-2-1-1-1-1 |
| serialNumbers | No | Serial number of product | String | 128 | |
| shipFromAddress1 | No | The ship from address line 1, if available. | String | 128 | 123 Main St |
| shipFromAddress2 | No | The ship from address line 2, if available. | String | 128 | Ste 210 |
| shipFromCity | No | The ship from city, if available. | String | 64 | Los Altos |
| shipFromCountry | No | The ship from country, if available. | String | 2 | US |
| shipFromName | No | The ship from name, if available. | String | 128 | Store1 |
| shipFromPostalCode | No | The ship from postal/zip code, if available. | Number | 24 | 94301 |
| shipFromState | No | The ship from state, if available. | String | 64 | CA |
| shipToAddress1 | No | The ship to address line 1, if available. | String | 128 | 123 Main St |
| shipToAddress2 | No | The ship to address line 2, if available. | String | 128 | Ste 210 |
| shipToCity | No | The ship to city, if available. | String | 64 | Los Altos |
| shipToCountry | No | The ship to country, if available. | String | 2 | US |
| shipToName | No | The ship to name, if available. | String | 128 | Store1 |
| shipToPostalCode | No | The ship to postal/zip code, if available. | Number | 24 | 94301 |
| shipToState | No | The ship to state, if available. | String | 64 | CA |
| trackingNumber | No | The shipment tracking number, if available. | String | 64 | 1Z123 |
- For columns that do not conform to the following feed spec names/values, we are able to apply field mappings and optionally field transformations so that product data gets indexed correctly.
- In the initial file upload, the required Target Fields (denoted by an asterisk) must be mapped so they can be available as columns. However, they don’t need to have values and just need to line up with the schema.
Example feeds: ASNTestFeed.csv
