Order Shipment Notification Array
Field | Description | Required | Best Practice |
purchaseOrderNumber | The associated purchase order. | TRUE | |
complete | All shipments for this purchase order are complete. | TRUE | |
SalesOrderArray | An array of sales orders associated with the purchase order. 4 | FALSE |
Sales Order
Field | Description | Required | Best Practice |
salesOrderNumber | The associated sales order. | TRUE | |
complete | All shipments for this sales order are complete. | TRUE | |
ShipmentLocationArray | An array of shipment locations. 5 | TRUE |
Shipment Location
Field | Description | Required | Best Practice |
id | The id of the location. | FALSE | |
complete | All shipments for this location are complete. | TRUE | |
shipFromAddress | Ship-From address 6 | TRUE | |
shipToAddress | Ship-To address 6 | TRUE | |
shipmentDestinationType | Used to identify the type of destination for the Ship-To address. | FALSE | |
PackageArray | An array of shipment packages. 7 | FALSE |
Address
Field | Description | Required | Best Practice |
address1 | Address Line 1 | TRUE | |
address2 | Address Line 2 | FALSE | |
address3 | Address Line 3 | FALSE | |
address4 | Address Line 4 | FALSE | |
city | Address City | TRUE | |
region | Address Region | TRUE | |
postalCode | Address Postal Code | TRUE | |
country | Address Country | FALSE |
Package
Field | Description | Required | Best Practice |
id | The id of the package | FALSE | |
trackingNumber | The tracking number for the package | TRUE | |
shipmentDate | The date for the shipment in UTC. 8 ISO 8601 | TRUE | |
dimUOM | The dimensional unit of measure | FALSE | |
length | The length of the package | FALSE | |
width | The width of the package | FALSE | |
height | The height of the package | FALSE | |
weightUOM | The weight unit of measure | FALSE | |
weight | The weight of the package | FALSE | |
carrier | The carrier delivering the package | FALSE | |
shipmentMethod | The method used for shipping (Ground) | FALSE | |
shippingAccount | The shipping account used for this shipment | FALSE | |
shipmentTerms | The terms of the shipment | FALSE | |
ItemArray | A list of items and quantities contained in the package 9 | FALSE |
Item
Field | Description | Required | Best Practice |
supplierProductId | The supplier product Id | FALSE | |
supplierPartId | The supplier part Id associated to the supplier product Id | FALSE | |
distributorProductId | The distributor product Id | FALSE | |
distributorPartId | The distributor part Id associated to the supplier product Id | FALSE | |
purchaseOrderLineNumber | The line number of the item on the purchase order. | FALSE | |
quantity | The quantity of the item. | FALSE |
Error Codes