Create Order

Products included in the order. Products identified by reference_id must also include the product name if there is no matching ShipBob product.

Required when type is DropShip or B2B. Omitting this object entirely, or supplying a retailer_program_type that is unrecognized or not enrolled, returns a 422 validation error; including the object without its required purchase_order_number or retailer_program_type fields returns a 400 validation error instead. Not used for DTC orders, where the API ignores this object.

Origin platform source for the order. Accepts a sales channel name that is case insensitive and the list of acceptable values can be found at https://support.shipbob.com/s/article/ShipBob-Developer-API

Client-defined shipping method matching what the user has listed as the shipping method on the Ship Option Mapping setup page in the ShipBob Merchant Portal. If they don’t match, we will create a new one and default it to Standard

Required when type is DropShip or B2B. For those order types both carrier_type and payment_term must be present. A carrier_type of Freight with a payment_term of ThirdParty is rejected. For DTC orders the only accepted combination is a carrier_type of Parcel with a payment_term of Prepaid, or both values left empty.

Order type. Accepted values are DTC, DropShip and B2B. DropShip and B2B orders must also include retailer_program_data and shipping_terms, or the create request fails validation with a 422 response. For DTC orders the API ignores retailer_program_data.