NameDescriptionTypeAdditional information
OrderId

Unique identifier from the BGS 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 BGS 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
Email

string

String length: inclusive between 0 and 100
ShippingMethod

Acceptable values are: 3RDP_LTL, AAAC_LTL, ABFS_LTL, AVRT_LTL, Bestway_LTL, BGS_Freight, BGS_WillCall, CENT_LTL, DAFG_LTL, DHL_ExpressWorldwide, E2OP_LTL, ECHO_LTL, ECHO_LTL_EXPEDITED, EXLA_LTL, FEDEX_1DayFreight, FEDEX_2DayFreight, FEDEX_3DayFreight, FEDEX_ASRStandardOvernight, FEDEX_ASR2Day, FEDEX_ASRExpressSaver3Day, FEDEX_ASRGround, FEDEX_FirstOvernightFreight, FEDEX_FirstOvernight, FEDEX_PriorityOvernight, FEDEX_StandardOvernight, FEDEX_StandardOvernight_Saturday, FEDEX_2DayAM, FEDEX_2Day, FEDEX_ExpressSaver, FEDEX_GroundDelivery, FEDEX_Ground3rdParty, FEDEX_HomeDelivery, FWRD_LTL, GDN_International, HMES_LTL, NVX_Freight, NVX_WillCall, NVX_CustomerCollectAPiWater, NVX_NavispherePoolcorp, NVX_UTSAPiWater, NVX_APiFedEx, ODFL_LTL, RDWY_LTL, RLC_LTL, SAIA_LTL, SEFL_LTL, TAZ_LTL, UPGF_LTL, UPS_ASROvernightSaver, UPS_ASR2Day, UPS_ASR3Day, UPS_ASRGround, UPS_2ndDayAir, UPS_2ndDayAirAM, UPS_3DaySelect, UPS_Ground, UPS_GroundCommercial, UPS_GroundResidential, UPS_Ground3rdParty, UPS_Freight, UPS_MailInnovations, UPS_NextDayAir, UPS_NextDayAir_Saturday, UPS_NextDayAirEarlyAM, UPS_NextDayAirSaver, UPS_StandardtoCanada, UPS_SurePost, UPS_WorldwideExpedited, UPS_WorldwideExpress, USPS_FirstClass, USPS_FirstClassInternational, USPS_PriorityMail, USPS_PriorityMailASR, USPS_PriorityMailExpress, USPS_PriorityMailExpressInternational, USPS_PriorityMailInternational, and XPOL_LTL

 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
OrderDetailData

Collection of OrderDetailData

None.