| 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 |
Required |
| ClientOrderId |
Unique order identifier from your system. |
string |
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 BGS to show the current status of the order. |
string |
None. |
| OrderDate | date |
None. |
|
| CompanyOrName | string |
String length: inclusive between 2 and 35 |
|
| Attention | string |
String length: inclusive between 2 and 35 |
|
| AddressLine1 | string |
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 |
String length: inclusive between 2 and 35 |
|
| State |
Can accept the 2 digit state code or the state's full name. |
string |
String length: inclusive between 2 and 35 |
| PostalCode | string |
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 |
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 |
If no ShippingMethod is submitted the default will be ISC_Economy (lowest cost option). The current 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. |
| 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 |
| OrderDetailEditData | Collection of OrderDetailEditData |
None. |
|
| OrderMetaData | Collection of OrderMetaData |
None. |