Vendor Shipments API v1 Reference
Access vendor retail shipping data.
Overview
The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
Version information
Version : v1
Contact information
Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html
License information
License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0
URI scheme
Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS
Consumes
application/json
Produces
application/json
Operations
SubmitShipmentConfirmations
GetShipmentDetails
SubmitShipments
Paths
POST /vendor/shipping/v1/shipmentConfirmations
Operation: SubmitShipmentConfirmations
Description
Submits one or more shipment confirmations for vendor orders.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 10 | 10 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | body required | A request to submit shipment confirmation. | SubmitShipmentConfirmationsRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
| 404 | The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
| 415 | The request payload is in an unsupported format. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
GET /vendor/shipping/v1/shipments
Operation: GetShipmentDetails
Description
Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters value that you specify.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 10 | 10 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | limit optional | The limit to the number of records returned. Default value is 50 records. Minimum : 1 Maximum : 50 | integer (int64) |
| Query | sortOrder optional | Sort in ascending or descending order by purchase order creation date. | enum (SortOrder) |
| Query | nextToken optional | Used for pagination when there are more shipments than the specified result size limit. | string |
| Query | createdAfter optional | Get Shipment Details that became available after this timestamp will be included in the result. Must be in ISO 8601 format. | string (date-time) |
| Query | createdBefore optional | Get Shipment Details that became available before this timestamp will be included in the result. Must be in ISO 8601 format. | string (date-time) |
| Query | shipmentConfirmedBefore optional | Get Shipment Details by passing Shipment confirmed create Date Before. Must be in ISO 8601 format. | string (date-time) |
| Query | shipmentConfirmedAfter optional | Get Shipment Details by passing Shipment confirmed create Date After. Must be in ISO 8601 format. | string (date-time) |
| Query | packageLabelCreatedBefore optional | Get Shipment Details by passing Package label create Date by buyer. Must be in ISO 8601 format. | string (date-time) |
| Query | packageLabelCreatedAfter optional | Get Shipment Details by passing Package label create Date After by buyer. Must be in ISO 8601 format. | string (date-time) |
| Query | shippedBefore optional | Get Shipment Details by passing Shipped Date Before. Must be in ISO 8601 format. | string (date-time) |
| Query | shippedAfter optional | Get Shipment Details by passing Shipped Date After. Must be in ISO 8601 format. | string (date-time) |
| Query | estimatedDeliveryBefore optional | Get Shipment Details by passing Estimated Delivery Date Before. Must be in ISO 8601 format. | string (date-time) |
| Query | estimatedDeliveryAfter optional | Get Shipment Details by passing Estimated Delivery Date Before. Must be in ISO 8601 format. | string (date-time) |
| Query | shipmentDeliveryBefore optional | Get Shipment Details by passing Shipment Delivery Date Before. Must be in ISO 8601 format. | string (date-time) |
| Query | shipmentDeliveryAfter optional | Get Shipment Details by passing Shipment Delivery Date After. Must be in ISO 8601 format. | string (date-time) |
| Query | requestedPickUpBefore optional | Get Shipment Details by passing Before Requested pickup date. Must be in ISO 8601 format. | string (date-time) |
| Query | requestedPickUpAfter optional | Get Shipment Details by passing After Requested pickup date. Must be in ISO 8601 format. | string (date-time) |
| Query | scheduledPickUpBefore optional | Get Shipment Details by passing Before scheduled pickup date. Must be in ISO 8601 format. | string (date-time) |
| Query | scheduledPickUpAfter optional | Get Shipment Details by passing After Scheduled pickup date. Must be in ISO 8601 format. | string (date-time) |
| Query | currentShipmentStatus optional | Get Shipment Details by passing Current shipment status. | string |
| Query | vendorShipmentIdentifier optional | Get Shipment Details by passing Vendor Shipment ID | string |
| Query | buyerReferenceNumber optional | Get Shipment Details by passing buyer Reference ID | string |
| Query | buyerWarehouseCode optional | Get Shipping Details based on buyer warehouse code. This value should be same as 'shipToParty.partyId' in the Shipment. | string |
| Query | sellerWarehouseCode optional | Get Shipping Details based on vendor warehouse code. This value should be same as 'sellingParty.partyId' in the Shipment. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentDetailsResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentDetailsResponse |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentDetailsResponse |
| 404 | The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentDetailsResponse |
| 415 | The request payload is in an unsupported format. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentDetailsResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentDetailsResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentDetailsResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentDetailsResponse |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
POST /vendor/shipping/v1/shipments
Operation: SubmitShipments
Description
Submits one or more shipment request for vendor Orders.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 10 | 10 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | body required | A request to submit shipment request. | SubmitShipments |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
| 404 | The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
| 415 | The request payload is in an unsupported format. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
Error Responses and Schemas
This table contains HTTP status codes and associated information for error responses.
| HTTP Code | Description | Schema |
|---|---|---|
| 401 | The request's Authorization header is not formatted correctly or does not contain a valid token. Headers: x-amzn-RequestId (string):Unique request reference identifier. | GetShipmentDetailsResponse |
| 413 | The request size exceeded the maximum accepted size. Headers: x-amzn-RequestId (string):Unique request reference identifier. | SubmitShipmentConfirmationsResponse |
Definitions
SubmitShipmentConfirmationsRequest
The request schema for the SubmitShipmentConfirmations operation.
| Name | Description | Schema |
|---|---|---|
| shipmentConfirmations optional | A list of one or more shipment confirmations. | < ShipmentConfirmation > array |
SubmitShipments
The request schema for the SubmitShipments operation.
| Name | Description | Schema |
|---|---|---|
| shipments optional | A list of one or more shipments with underlying details. | < Shipment > array |
GetShipmentDetailsResponse
The response schema for the GetShipmentDetails operation.
| Name | Description | Schema |
|---|---|---|
| payload optional | The request schema for the GetShipmentDetails operation. | ShipmentDetails |
| errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
ShipmentDetails
The request schema for the GetShipmentDetails operation.
| Name | Description | Schema |
|---|---|---|
| pagination optional | The pagination elements required to retrieve the remaining data. | Pagination |
| shipments optional | A list of one or more shipments with underlying details. | < Shipment > array |
Pagination
The pagination elements required to retrieve the remaining data.
| Name | Description | Schema |
|---|---|---|
| nextToken optional | A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more shipment items to return. | string |
ShipmentConfirmation
A list of one or more shipment confirmations.
| Name | Description | Schema |
|---|---|---|
| shipmentIdentifier required | Unique shipment ID (not used over the last 365 days). | string |
| shipmentConfirmationType required | Indicates if this shipment confirmation is the initial confirmation, or intended to replace an already posted shipment confirmation. If replacing an existing shipment confirmation, be sure to provide the identical shipmentIdentifier and sellingParty information as in the previous confirmation. | enum (ShipmentConfirmationType) |
| shipmentType optional | The type of shipment. | enum (ShipmentType) |
| shipmentStructure optional | Shipment hierarchical structure. | enum (ShipmentStructure) |
| transportationDetails optional | Transportation details for this shipment. | TransportationDetailsForShipmentConfirmation |
| amazonReferenceNumber optional | The Amazon Reference Number is a unique identifier generated by Amazon for all Collect/WePay shipments when you submit a routing request. This field is mandatory for Collect/WePay shipments. | string |
| shipmentConfirmationDate required | Date on which the shipment confirmation was submitted. | string (date-time) |
| shippedDate optional | The date and time of the departure of the shipment from the vendor's location. Vendors are requested to send ASNs within 30 minutes of departure from their warehouse/distribution center or at least 6 hours prior to the appointment time at the buyer destination warehouse, whichever is sooner. Shipped date mentioned in the shipment confirmation should not be in the future. | string (date-time) |
| estimatedDeliveryDate optional | The date and time on which the shipment is estimated to reach buyer's warehouse. It needs to be an estimate based on the average transit time between ship from location and the destination. The exact appointment time will be provided by the buyer and is potentially not known when creating the shipment confirmation. | string (date-time) |
| sellingParty required | Name/Address and tax details of the selling party. | PartyIdentification |
| shipFromParty required | Name/Address and tax details of the ship from party. | PartyIdentification |
| shipToParty required | Name/Address of the destination warehouse where the shipment is being shipped to. | PartyIdentification |
| shipmentMeasurements optional | Shipment measurement details. | ShipmentMeasurements |
| importDetails optional | Provide these fields only if this shipment is a direct import. | ImportDetails |
| shippedItems required | A list of the items in this shipment and their associated details. If any of the item detail fields are common at a carton or a pallet level, provide them at the corresponding carton or pallet level. | < Item > array |
| cartons optional | A list of the cartons in this shipment. | < Carton > array |
| pallets optional | A list of the pallets in this shipment. | < Pallet > array |
Shipment
A list of one or more shipments with respective details.
| Name | Description | Schema |
|---|---|---|
| vendorShipmentIdentifier required | Unique Transportation ID created by Vendor (Should not be used over the last 365 days). | string |
| transactionType required | Indicates the type of transportation request such as (New,Cancel,Confirm and PackageLabelRequest). Each transactiontype has a unique set of operation and there are corresponding details to be populated for each operation. | enum (TransactionType) |
| buyerReferenceNumber optional | The buyer Reference Number is a unique identifier generated by buyer for all Collect/WePay shipments when you submit a transportation request. This field is mandatory for Collect/WePay shipments. | string |
| transactionDate required | Date on which the transportation request was submitted. | string (date-time) |
| currentShipmentStatus optional | Indicates the current shipment status. | enum (CurrentShipmentStatus) |
| currentshipmentStatusDate optional | Date and time when the last status was updated. | string (date-time) |
| shipmentStatusDetails optional | Indicates the list of current shipment status details and when the last update was received from carrier this is available on shipment Details response. | < ShipmentStatusDetails > array |
| shipmentCreateDate optional | The date and time of the shipment request created by vendor. | string (date-time) |
| shipmentConfirmDate optional | The date and time of the departure of the shipment from the vendor's location. Vendors are requested to send ASNs within 30 minutes of departure from their warehouse/distribution center or at least 6 hours prior to the appointment time at the Buyer destination warehouse, whichever is sooner. Shipped date mentioned in the shipment confirmation should not be in the future. | string (date-time) |
| packageLabelCreateDate optional | The date and time of the package label created for the shipment by buyer. | string (date-time) |
| shipmentFreightTerm optional | Indicates if this transportation request is WePay/Collect or TheyPay/Prepaid. This is a mandatory information. | enum (ShipmentFreightTerm) |
| sellingParty required | Name/Address and tax details of the selling party. | PartyIdentification |
| shipFromParty required | Name/Address and tax details of the ship from party. | PartyIdentification |
| shipToParty required | Name/Address of the destination warehouse where the shipment is being shipped to. | PartyIdentification |
| shipmentMeasurements optional | Indicates the shipment measurement details on how many cartons and pallets and the total transportation weight and volume as part of this request. This is a mandatory detail which will help determining the transportation cost, truck allocations and route determination efficiently. | TransportShipmentMeasurements |
| collectFreightPickupDetails optional | Indicates the earliest pickup date for the transportation from vendor warehouse. This information is mandatory to be filled for requesting transportation from Buyer (WePay/Collect). | CollectFreightPickupDetails |
| purchaseOrders optional | Indicates the purchase orders involved for the transportation request. This group is an array create 1 for each PO and list their corresponding items. This information is used for deciding the route,truck allocation and storage efficiently. This is a mandatory information for Buyer performing transportation from vendor warehouse (WePay/Collect) | < PurchaseOrders > array |
| importDetails optional | Provide these fields only if this shipment is a direct import. | ImportDetails |
| containers optional | A list of the items in this transportation and their associated inner container details. If any of the item detail fields are common at a carton or a pallet level, provide them at the corresponding carton or pallet level. | < Containers > array |
| transportationDetails optional | Transportation details this a mandatory information which states delivery date, shipping date and carrier details. | TransportationDetails |
ShipmentMeasurements
Shipment measurement details.
| Name | Description | Schema |
|---|---|---|
| grossShipmentWeight optional | Gross weight of the shipment. | Weight |
| shipmentVolume optional | Gross Volume of the shipment. | Volume |
| cartonCount optional | Number of cartons present in the shipment. Provide the cartonCount only for non-palletized shipments. | integer |
| palletCount optional | Number of pallets present in the shipment. Provide the palletCount only for palletized shipments. | integer |
ShipmentStatusDetails
Shipment Status details.
| Name | Description | Schema |
|---|---|---|
| shipmentStatus optional | Current status of the shipment on whether it is picked up or scheduled. | enum (ShipmentStatus) |
| shipmentStatusDate optional | Date and time on last status update received for the shipment | string (date-time) |
TransportShipmentMeasurements
Shipment measurement details.
| Name | Description | Schema |
|---|---|---|
| totalCartonCount optional | Total number of cartons present in the shipment. Provide the cartonCount only for non-palletized shipments. | integer |
| totalPalletStackable optional | Total number of Stackable Pallets present in the shipment. | integer |
| totalPalletNonStackable optional | Total number of Non Stackable Pallets present in the shipment. | integer |
| shipmentWeight optional | Total Weight of the shipment. | Weight |
| shipmentVolume optional | Total Volume of the shipment. | Volume |
CollectFreightPickupDetails
Transport Request pickup date from Vendor Warehouse by Buyer
| Name | Description | Schema |
|---|---|---|
| requestedPickUp optional | Date on which the items can be picked up from vendor warehouse by Buyer used for WePay/Collect vendors. | string (date-time) |
| scheduledPickUp optional | Date on which the items are scheduled to be picked from vendor warehouse by Buyer used for WePay/Collect vendors. | string (date-time) |
| carrierAssignmentDate optional | Date on which the carrier is being scheduled to pickup items from vendor warehouse by Byer used for WePay/Collect vendors. | string (date-time) |
PurchaseOrders
Transport Request pickup date
| Name | Description | Schema |
|---|---|---|
| purchaseOrderNumber optional | Purchase order numbers involved in this shipment, list all the PO that are involved as part of this shipment. | string |
| purchaseOrderDate optional | Purchase order numbers involved in this shipment, list all the PO that are involved as part of this shipment. | string (date-time) |
| shipWindow optional | Date range in which shipment is expected for these purchase orders. | string |
| items optional | A list of the items that are associated to the PO in this transport and their associated details. | < PurchaseOrderItems > array |
TransportationDetails
Transportation details for this shipment.
| Name | Description | Schema |
|---|---|---|
| shipMode optional | The type of shipment. | enum (ShipMode) |
| transportationMode optional | The mode of transportation for this shipment. | enum (TransportationMode) |
| shippedDate optional | Date when shipment is performed by the Vendor to Buyer | string (date-time) |
| estimatedDeliveryDate optional | Estimated Date on which shipment will be delivered from Vendor to Buyer | string (date-time) |
| shipmentDeliveryDate optional | Date on which shipment will be delivered from Vendor to Buyer | string (date-time) |
| carrierDetails optional | Indicates the carrier details and their contact informations | CarrierDetails |
| billOfLadingNumber optional | The Bill of Lading (BOL) number is a unique number assigned to each shipment of goods by the vendor or shipper during the creation of the Bill of Lading. This number must be unique for every shipment and cannot be a date/time or single character. The BOL numer is mandatory in Shipment Confirmation message for FTL and LTL shipments, and must match the paper BOL provided with the shipment. Instead of BOL, an alternative reference number (like Delivery Note Number) for the shipment can also be sent in this field. | string |
TransportationDetailsForShipmentConfirmation
Transportation details for this shipment.
| Name | Description | Schema |
|---|---|---|
| carrierScac optional | Code that identifies the carrier for the shipment. The Standard Carrier Alpha Code (SCAC) is a unique two to four letter code used to identify a carrier. Carrier SCAC codes are assigned and maintained by the NMFTA (National Motor Freight Association). This field is mandatory for US, CA, MX shipment confirmations. | string |
| carrierShipmentReferenceNumber optional | The field also known as PRO number is a unique number assigned by the carrier. It is used to identify and track the shipment that goes out for delivery. This field is mandatory for UA, CA, MX shipment confirmations. | string |
| transportationMode optional | The mode of transportation for this shipment. | enum (TransportationMode) |
| billOfLadingNumber optional | The Bill of Lading (BOL) number is a unique number assigned to each shipment of goods by the vendor or shipper during the creation of the Bill of Lading. This number must be unique for every shipment and cannot be a date/time or single character. The BOL numer is mandatory in Shipment Confirmation message for FTL and LTL shipments, and must match the paper BOL provided with the shipment. Instead of BOL, an alternative reference number (like Delivery Note Number) for the shipment can also be sent in this field. | string |
CarrierDetails
Indicates the carrier details and their contact informations
| Name | Description | Schema |
|---|---|---|
| name optional | The field is used to represent the carrier used for performing the shipment. | string |
| code optional | Code that identifies the carrier for the shipment. The Standard Carrier Alpha Code (SCAC) is a unique two to four letter code used to identify a carrier. Carrier SCAC codes are assigned and maintained by the NMFTA (National Motor Freight Association). | string |
| phone optional | The field is used to represent the Carrier contact number. | string |
| email optional | The field is used to represent the carrier Email id. | string |
| shipmentReferenceNumber optional | The field is also known as PRO number is a unique number assigned by the carrier. It is used to identify and track the shipment that goes out for delivery. This field is mandatory for US, CA, MX shipment confirmations. | string |
ImportDetails
Provide these fields only if this shipment is a direct import.
| Name | Description | Schema |
|---|---|---|
| methodOfPayment optional | This is used for import purchase orders only. If the recipient requests, this field will contain the shipment method of payment. | enum (MethodOfPayment) |
| sealNumber optional | The container's seal number. | string |
| route optional | The route and stop details for this shipment. | Route |
| importContainers optional | Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if shipment has multiple containers. maxLength : 64 | string |
| billableWeight optional | Billable weight of the direct imports shipment. | Weight |
| estimatedShipByDate optional | Date on which the shipment is expected to be shipped. This value should not be in the past and not more than 60 days out in the future. | string (date-time) |
| handlingInstructions optional | Identification of the instructions on how specified item/carton/pallet should be handled. | enum (HandlingInstructions) |
Containers
A list of the items in this transportation and their associated inner container details. If any of the item detail fields are common at a carton or a pallet level, provide them at the corresponding carton or pallet level.
| Name | Description | Schema |
|---|---|---|
| containerType required | The type of container. | enum (ContainerType) |
| containerSequenceNumber optional | An integer that must be submitted for multi-box shipments only, where one item may come in separate packages. | string |
| containerIdentifiers required | A list of carton identifiers. | < ContainerIdentification > array |
| trackingNumber optional | The tracking number used for identifying the shipment. | string |
| dimensions optional | Physical dimensional measurements of a container. | Dimensions |
| weight optional | The weight of the shipment. | Weight |
| tier optional | Number of layers per pallet. | integer |
| block optional | Number of cartons per layer on the pallet. | integer |
| innerContainersDetails optional | Details of the innerContainersDetails. | InnerContainersDetails |
| packedItems optional | A list of packed items. | < PackedItems > array |
PackedItems
Details of the item being shipped.
| Name | Description | Schema |
|---|---|---|
| itemSequenceNumber optional | Item sequence number for the item. The first item will be 001, the second 002, and so on. This number is used as a reference to refer to this item from the carton or pallet level. | string |
| buyerProductIdentifier optional | Buyer Standard Identification Number (ASIN) of an item. | string |
| vendorProductIdentifier optional | The vendor selected product identification of the item. Should be the same as was sent in the purchase order. | string |
| packedQuantity optional | Total item quantity shipped in this shipment. | ItemQuantity |
| itemDetails optional | Item details for be provided for every item in shipment at either the item or carton or pallet level, whichever is appropriate. | PackageItemDetails |
Item
Details of the item being shipped.
| Name | Description | Schema |
|---|---|---|
| itemSequenceNumber required | Item sequence number for the item. The first item will be 001, the second 002, and so on. This number is used as a reference to refer to this item from the carton or pallet level. | string |
| amazonProductIdentifier optional | Buyer Standard Identification Number (ASIN) of an item. | string |
| vendorProductIdentifier optional | The vendor selected product identification of the item. Should be the same as was sent in the purchase order. | string |
| shippedQuantity required | Total item quantity shipped in this shipment. | ItemQuantity |
| itemDetails optional | Item details for be provided for every item in shipment at either the item or carton or pallet level, whichever is appropriate. | ItemDetails |
PurchaseOrderItems
Details of the item being shipped.
| Name | Description | Schema |
|---|---|---|
| itemSequenceNumber required | Item sequence number for the item. The first item will be 001, the second 002, and so on. This number is used as a reference to refer to this item from the carton or pallet level. | string |
| buyerProductIdentifier optional | Amazon Standard Identification Number (ASIN) for a SKU | string |
| vendorProductIdentifier optional | The vendor selected product identification of the item. Should be the same as was sent in the purchase order. | string |
| shippedQuantity required | Total item quantity shipped in this shipment. | ItemQuantity |
| maximumRetailPrice optional | An amount of money, including units in the form of currency. | Money |
Carton
Details of the carton/package being shipped.
| Name | Description | Schema |
|---|---|---|
| cartonIdentifiers optional | A list of carton identifiers. | < ContainerIdentification > array |
| cartonSequenceNumber required | Carton sequence number for the carton. The first carton will be 001, the second 002, and so on. This number is used as a reference to refer to this carton from the pallet level. | string |
| dimensions optional | Physical dimensional measurements of a container. | Dimensions |
| weight optional | The weight of the shipment. | Weight |
| trackingNumber optional | This is required to be provided for every carton in the small parcel shipments. | string |
| items required | A list of container item details. | < ContainerItem > array |
InnerContainersDetails
Details of the innerContainersDetails.
| Name | Description | Schema |
|---|---|---|
| containerCount optional | Total containers as part of the shipment | integer |
| containerSequenceNumbers optional | Container sequence numbers that are involved in this shipment. | < ContainerSequenceNumbers > array |
ContainerSequenceNumbers
Container sequence numbers that are involved in this shipment.
| Name | Description | Schema |
|---|---|---|
| containerSequenceNumber optional | A list of containers shipped | string |
Pallet
Details of the Pallet/Tare being shipped.
| Name | Description | Schema |
|---|---|---|
| palletIdentifiers required | A list of pallet identifiers. | < ContainerIdentification > array |
| tier optional | Number of layers per pallet. Only applicable to container type Pallet. | integer |
| block optional | Number of cartons per layer on the pallet. Only applicable to container type Pallet. | integer |
| dimensions optional | Physical dimensional measurements of a container. | Dimensions |
| weight optional | The weight of the shipment. | Weight |
| cartonReferenceDetails optional | Carton reference details. | CartonReferenceDetails |
| items optional | A list of container item details. | < ContainerItem > array |
ItemDetails
Item details for be provided for every item in shipment at either the item or carton or pallet level, whichever is appropriate.
| Name | Description | Schema |
|---|---|---|
| purchaseOrderNumber optional | The purchase order number for the shipment being confirmed. If the items in this shipment belong to multiple purchase order numbers that are in particular carton or pallet within the shipment, then provide the purchaseOrderNumber at the appropriate carton or pallet level. Formatting Notes: 8-character alpha-numeric code. | string |
| lotNumber optional | The batch or lot number associates an item with information the manufacturer considers relevant for traceability of the trade item to which the Element String is applied. The data may refer to the trade item itself or to items contained. This field is mandatory for all perishable items. | string |
| expiry optional | Expiry refers to the collection of dates required for certain items. These could be either expiryDate or mfgDate and expiryAfterDuration. These are mandatory for perishable items. | Expiry |
| maximumRetailPrice optional | Maximum retail price of the item being shipped. | Money |
| handlingCode optional | Identification of the instructions on how specified item/carton/pallet should be handled. | enum (HandlingCode) |
PackageItemDetails
Item details for be provided for every item in shipment at either the item or carton or pallet level, whichever is appropriate.
| Name | Description | Schema |
|---|---|---|
| purchaseOrderNumber optional | The purchase order number for the shipment being confirmed. If the items in this shipment belong to multiple purchase order numbers that are in particular carton or pallet within the shipment, then provide the purchaseOrderNumber at the appropriate carton or pallet level. Formatting Notes: 8-character alpha-numeric code. | string |
| lotNumber optional | The batch or lot number associates an item with information the manufacturer considers relevant for traceability of the trade item to which the Element String is applied. The data may refer to the trade item itself or to items contained. This field is mandatory for all perishable items. | string |
| expiry optional | Either expiryDate or mfgDate and expiryAfterDuration are mandatory for perishable items. | Expiry |
ContainerIdentification
A list of carton identifiers.
| Name | Description | Schema |
|---|---|---|
| containerIdentificationType required | The container identification type. | enum (ContainerIdentificationType) |
| containerIdentificationNumber required | Container identification number that adheres to the definition of the container identification type. | string |
ContainerItem
Carton/Pallet level details for the item.
| Name | Description | Schema |
|---|---|---|
| itemReference required | The reference number for the item. Please provide the itemSequenceNumber from the 'items' segment to refer to that item's details here. | string |
| shippedQuantity required | Total item quantity shipped in this carton/pallet. | ItemQuantity |
| itemDetails optional | Item details for be provided for every item in shipment at either the item or carton or pallet level, whichever is appropriate. | ItemDetails |
CartonReferenceDetails
Carton reference details.
| Name | Description | Schema |
|---|---|---|
| cartonCount optional | Pallet level carton count is mandatory for single item pallet and optional for mixed item pallet. | integer |
| cartonReferenceNumbers required | Array of reference numbers for the carton that are part of this pallet/shipment. Please provide the cartonSequenceNumber from the 'cartons' segment to refer to that carton's details here. | < string > array |
PartyIdentification
Name/Address and tax details of the party.
| Name | Description | Schema |
|---|---|---|
| address optional | Identification of the party by address. | Address |
| partyId required | Assigned identification for the party. | string |
| taxRegistrationDetails optional | Tax registration details of the entity. | < TaxRegistrationDetails > array |
TaxRegistrationDetails
Tax registration details of the entity.
| Name | Description | Schema |
|---|---|---|
| taxRegistrationType required | Tax registration type for the entity. | enum (TaxRegistrationType) |
| taxRegistrationNumber required | Tax registration number for the entity. For example, VAT ID. | string |
Address
Address of the party.
| Name | Description | Schema |
|---|---|---|
| name required | The name of the person, business or institution at that address. | string |
| addressLine1 required | First line of the address. | string |
| addressLine2 optional | Additional street address information, if required. | string |
| addressLine3 optional | Additional street address information, if required. | string |
| city optional | The city where the person, business or institution is located. | string |
| county optional | The county where person, business or institution is located. | string |
| district optional | The district where person, business or institution is located. | string |
| stateOrRegion optional | The state or region where person, business or institution is located. | string |
| postalCode optional | The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation. | string |
| countryCode required | The two digit country code in ISO 3166-1 alpha-2 format. | string |
| phone optional | The phone number of the person, business or institution located at that address. | string |
Route
This is used only for direct import shipment confirmations.
| Name | Description | Schema |
|---|---|---|
| stops required | The port or location involved in transporting the cargo, as specified in transportation contracts or operational plans. | < Stop > array |
Stop
Contractual or operational port or point relevant to the movement of the cargo.
| Name | Description | Schema |
|---|---|---|
| functionCode required | Provide the function code. | enum (FunctionCode) |
| locationIdentification optional | Location identifier. | Location |
| arrivalTime optional | Date and time of the arrival of the cargo. | string (date-time) |
| departureTime optional | Date and time of the departure of the cargo. | string (date-time) |
Location
Location identifier.
| Name | Description | Schema |
|---|---|---|
| type optional | Type of location identification. | string |
| locationCode optional | Location code. | string |
| countryCode optional | The two digit country code. In ISO 3166-1 alpha-2 format. | string |
Dimensions
Physical dimensional measurements of a container.
| Name | Description | Schema |
|---|---|---|
| length required | The length of the container. | Decimal |
| width required | The width of the container. | Decimal |
| height required | The height of the container. | Decimal |
| unitOfMeasure required | The unit of measure for dimensions. | enum (UnitOfMeasure) |
Volume
The volume of the shipment.
| Name | Description | Schema |
|---|---|---|
| unitOfMeasure required | The unit of measurement. | enum (UnitOfMeasure) |
| value required | The measurement value. | Decimal |
Weight
The weight of the shipment.
| Name | Description | Schema |
|---|---|---|
| unitOfMeasure required | The unit of measurement. | enum (UnitOfMeasure) |
| value required | The measurement value. | Decimal |
Money
An amount of money, including units in the form of currency.
| Name | Description | Schema |
|---|---|---|
| currencyCode required | Three digit currency code in ISO 4217 format. | string |
| amount required | A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. Pattern : ^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$. | Decimal |
Decimal
A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
Pattern : ^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$.
Type : string
ItemQuantity
Details of item quantity.
| Name | Description | Schema |
|---|---|---|
| amount required | Amount of units shipped for a specific item at a shipment level. If the item is present only in certain cartons or pallets within the shipment, please provide this at the appropriate carton or pallet level. | integer |
| unitOfMeasure required | Unit of measure for the shipped quantity. | enum (UnitOfMeasure) |
| unitSize optional | The case size, in the event that we ordered using cases. Otherwise, 1. | integer |
Expiry
Expiry refers to the collection of dates required for certain items. These could be either expiryDate or mfgDate and expiryAfterDuration. These are mandatory for perishable items.
| Name | Description | Schema |
|---|---|---|
| manufacturerDate optional | Production, packaging or assembly date determined by the manufacturer. Its meaning is determined based on the trade item context. | string (date-time) |
| expiryDate optional | The date that determines the limit of consumption or use of a product. Its meaning is determined based on the trade item context. | string (date-time) |
| expiryAfterDuration optional | Duration after manufacturing date during which the product is valid for consumption. | Duration |
Duration
Duration after manufacturing date during which the product is valid for consumption.
| Name | Description | Schema |
|---|---|---|
| durationUnit required | Unit for duration. | enum (DurationUnit) |
| durationValue required | Value for the duration in terms of the durationUnit. | integer |
SubmitShipmentConfirmationsResponse
The response schema for the SubmitShipmentConfirmations operation.
| Name | Description | Schema |
|---|---|---|
| payload optional | The response payload for the SubmitShipmentConfirmations operation. | TransactionReference |
| errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
TransactionReference
The response payload for the SubmitShipmentConfirmations operation.
| Name | Description | Schema |
|---|---|---|
| transactionId optional | GUID assigned by Buyer to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction. | string |
ErrorList
A list of error responses returned when a request is unsuccessful.
Type : < Error > array
Error
Error response returned when the request is unsuccessful.
| Name | Description | Schema |
|---|---|---|
| code required | An error code that identifies the type of error that occurred. | string |
| message required | A message that describes the error condition. | string |
| details optional | Additional details that can help the caller understand or fix the issue. | string |
MethodOfPayment
This is used for import purchase orders only. If the recipient requests, this field will contain the shipment method of payment.
Type : enum
| Value | Description |
|---|---|
| PaidByBuyer | Buyer pays for shipping. |
| CollectOnDelivery | Buyer pays for shipping on delivery. |
| DefinedByBuyerAndSeller | Shipping costs paid as agreed upon between buyer and seller. |
| FOBPortOfCall | Seller pays for transportation incl. loading, shipping. |
| PrepaidBySeller | Seller prepays for shipping. |
| PaidBySeller | Seller pays for shipping. |
TransactionType
Indicates the type of transportation request such as (New,Cancel,Confirm and PackageLabelRequest). Each transactiontype has a unique set of operation and there are corresponding details to be populated for each operation.
Type : enum
| Value | Description |
|---|---|
| New | Initial shipment Request. |
| Cancel | Cancel existing shipment Request message. should be used only to cancel Shipment request |
TransportationMode
The mode of transportation for this shipment.
Type : enum
| Value | Description |
|---|---|
| Road | The mode of transportation is by Road (on a truck). |
| Air | The mode of transportation is by Air (on a plane). |
| Ocean | The mode of transportation is by Ocean (on a ship). |
HandlingCode
Identification of the instructions on how specified item/carton/pallet should be handled.
Type : enum
| Value | Description |
|---|---|
| Oversized | A package weighing 150 pounds or less and measuring greater than 130 inches in length and girth is classified as an oversized package. |
| Fragile | A package containing easily breakable items. |
| Food | A package containing edible items. |
| HandleWithCare | A package containing fragile or dangerous items. |
ShipmentFreightTerm
Indicates if this transportation request is WePay/Collect or TheyPay/Prepaid. This is a mandatory information.
Type : enum
| Value | Description |
|---|---|
| Collect | Buyer Pays / We Pay for the the transportation. Buyer pays for the shipment and provides Vendor and picks up shipment from vendor warehouse / location |
| Prepaid | Vendor pays / They Pay for the transportation. Vendor pays for the shipment and ships the goods to buyer warehouse / location |
ContainerType
The type of container.
Type : enum
| Value | Description |
|---|---|
| carton | A carton is a box or container usually made of liquid packaging board, paperboard and sometimes of corrugated fiberboard |
| pallet | A flat transport structure which supports goods in a stable fashion while being lifted by a forklift. |
TaxRegistrationType
Tax registration type for the entity.
Type : enum
| Value | Description |
|---|---|
| VAT | Value-added tax. |
| GST | Goods and Services tax. |
CurrentShipmentStatus
Indicates the current shipment status.
Type : enum
| Value | Description |
|---|---|
| Created | Shipment request was received by buyer. |
| TransportationRequested | - |
| CarrierAssigned | - |
| Shipped | Shipment sent to buyer warehouse. |
FunctionCode
Provide the function code.
Type : enum
| Value | Description |
|---|---|
| PortOfDischarge | Port of Discharge is a place where a vessel discharges or unloads some or all of its shipments. |
| FreightPayableAt | Place where the payment for the freight is made. |
| PortOfLoading | The port where goods are put on a ship. |
SortOrder
Sort in ascending or descending order by purchase order creation date.
Type : enum
| Value | Description |
|---|---|
| ASC | Sort in ascending order by shipment creation date. |
| DESC | Sort in descending order by shipment creation date. |
ContainerIdentificationType
The container identification type.
Type : enum
| Value | Description |
|---|---|
| SSCC | 2 Digit Application Identifier (00) followed by unique 18-digit Serial Shipment Container Code (SSCC) to be included to define a pallet/carton and to identify its contents. |
| AMZNCC | Amazon Container Code - a substitute for a SSCC that is generated by Amazon for small vendors and associated with a pallet/carton label. |
| GTIN | Global Trade Identification Number (part of the standard GS1 barcoding and product identification system). |
| BPS | Barcode Packing Slip. |
| CID | Container identifier for import shipments. |
ShipmentConfirmationType
Indicates if this shipment confirmation is the initial confirmation, or intended to replace an already posted shipment confirmation. If replacing an existing shipment confirmation, be sure to provide the identical shipmentIdentifier and sellingParty information as in the previous confirmation.
Type : enum
| Value | Description |
|---|---|
| Original | Initial shipment confirmation message. |
| Replace | Replace the original shipment confirmation message. |
ShipmentStructure
Shipment hierarchical structure.
Type : enum
| Value | Description |
|---|---|
| PalletizedAssortmentCase | Shipment -> Order -> Pallet/Tare -> Carton/Package -> Item |
| LooseAssortmentCase | Shipment -> Order -> Carton/Package -> Item |
| PalletOfItems | Shipment -> Order -> Pallet/Tare -> Item |
| PalletizedStandardCase | Shipment -> Order -> Pallet/Tare -> Item -> Carton/Package |
| LooseStandardCase | Shipment -> Order -> Item -> Carton/Package |
| MasterPallet | Shipment -> Pallet/Tare -> Order -> Item |
| MasterCase | Shipment -> Carton/Package -> Order -> Item |
ShipmentType
The type of shipment.
Type : enum
| Value | Description |
|---|---|
| TruckLoad | Truckload shipping is the movement of large amounts of homogeneous cargo, generally the amount necessary to fill an entire semi-trailer or intermodal container. |
| LessThanTruckLoad | Shipping does not fill the entire truck. |
| SmallParcel | Small parcel shipments are under 70 pounds per and shipped in your own packaging or carrier supplied boxes. |
HandlingInstructions
Identification of the instructions on how specified item/carton/pallet should be handled.
Type : enum
| Value | Description |
|---|---|
| Oversized | A package weighing 150 pounds or less and measuring greater than 130 inches in length and girth is classified as an oversized package. |
| Fragile | A package containing easily breakable items. |
| Food | A package containing edible items. |
| HandleWithCare | A package containing fragile or dangerous items. |
ShipmentStatus
Current status of the shipment on whether it is picked up or scheduled.
Type : enum
| Value | Description |
|---|---|
| Created | Shipment request was received by buyer. |
| TransportationRequested | - |
| CarrierAssigned | - |
| Shipped | Shipment done to buyer warehouse. |
DurationUnit
Unit for duration.
Type : enum
| Value | Description |
|---|---|
| Days | Days |
| Months | Months |
ShipMode
The type of shipment.
Type : enum
| Value | Description |
|---|---|
| TruckLoad | Truckload shipping is the movement of large amounts of homogeneous cargo, generally the amount necessary to fill an entire semi-trailer or intermodal container. |
| LessThanTruckLoad | Shipping does not fill the entire truck. |
| SmallParcel | Small parcel shipments are under 70 pounds per parcel and shipped with your own packaging or carrier supplied boxes. |
UnitOfMeasure
Type : enum
For use with the definition(s): Weight
The unit of measurement.
| Value | Description |
|---|---|
| G | Grams |
| Kg | Kilograms |
| Oz | Ounces |
| Lb | Pounds |
For use with the definition(s): Dimensions
The unit of measure for dimensions.
| Value | Description |
|---|---|
| In | Inches |
| Ft | Feet |
| Meter | Meters |
| Yard | Yards |
For use with the definition(s): Volume
The unit of measurement.
| Value | Description |
|---|---|
| CuFt | Cubic feet. |
| CuIn | Cubic inches. |
| CuM | Cubic meter. |
| CuY | Cubic yard. |
For use with the definition(s): ItemQuantity
Unit of measure for the shipped quantity.
| Value | Description |
|---|---|
| Cases | Packing of individual items into a case. |
| Eaches | Individual items. |
Updated 4 months ago