| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderId |
Unique identifier from the WMS system that is assigned at order creation, and it can be used as the id parameter. |
integer |
None. |
| ClientOrderId |
Unique order identifier from your system. |
string |
Required String length: inclusive between 1 and 100 |
| ClientOrderId2 |
Alternate order identifier from your system. For example, a PO number. |
string |
None. |
| WarehouseCode |
Use "MEM" to send the order to the Memphis warehouse. Use "SLC" to send the order to the Salt Lake City warehouse. The default is "MEM". |
string |
None. |
| OrderStatus |
Assigned by WMS to show the current status of the order. |
string |
None. |
| OrderDate | date |
Required |
|
| ShipByDate | date |
None. |
|
| DeliverByDate | date |
None. |
|
| CompanyOrName | string |
Required String length: inclusive between 2 and 35 |
|
| Attention | string |
String length: inclusive between 2 and 35 |
|
| AddressLine1 | string |
Required String length: inclusive between 2 and 35 |
|
| AddressLine2 | string |
String length: inclusive between 2 and 35 |
|
| AddressLine3 | string |
String length: inclusive between 2 and 35 |
|
| City | string |
Required String length: inclusive between 2 and 35 |
|
| State |
Can accept the 2 digit state code or the state's full name. |
string |
Required String length: inclusive between 2 and 35 |
| PostalCode | string |
Required String length: inclusive between 2 and 35 |
|
| Country |
Can accept the 2 digit ISO code, the 3 digit ISO code, or the country's full name. |
string |
Required String length: inclusive between 2 and 35 |
| Phone | string |
String length: inclusive between 0 and 35 |
|
| string |
String length: inclusive between 0 and 100 |
||
| ShippingMethod |
Acceptable values are: ISC_Economy, ISC_Freight, ISC_WillCall, FEDEX_Ground, FEDEX_Home, UPS_2ndDayAir, UPS_2ndDayAirAM, UPS_3DaySelect, UPS_Ground, UPS_GroundCommercial, UPS_GroundResidential, UPS_MailInnovations, UPS_NextDayAir, UPS_NextDayAirEarlyAM, UPS_NextDayAirSaver, UPS_StandardtoCanada, UPS_SurePost, UPS_WorldwideExpedited, UPS_WorldwideSaver, UPS_WorldwideExpress, USPS_FirstClassInternational, USPS_GroundAdvantage, USPS_PriorityMail, USPS_PriorityMailExpress, USPS_PriorityMailExpressInternational, and USPS_PriorityMailInternational |
string |
None. |
| ShippingBillingProfileId |
As an option, you can choose which ShippingBillingProfileId to use for the order. These profiles are setup beforehand in the WMS. If no value (or an unknown value) is supplied, then the default profile for the client will be used. |
integer |
None. |
| NotesToCustomerPackingSlip |
Text submitted here will appear on the packing slip to the end customer. |
string |
String length: inclusive between 0 and 500 |
| NotesToWarehouse |
Text submitted here will appear on screen when picking an order. |
string |
String length: inclusive between 0 and 255 |
| OrderDetailData |
Includes the product line items for the order. |
Collection of OrderDetailData |
None. |
| OrderMetaData |
Includes any additional meta data for the order. |
Collection of OrderMetaData |
None. |
| ShippingData |
Includes the ShipDate and Tracking information for the order. |
Collection of ShippingData |
None. |