Request
This endpoint expects an object.
productslist of objectsRequired
Products included in the order. Products identified by reference_id must also include the product name if there is no matching ShipBob product.
recipientobjectRequired
Information about the recipient of an order
reference_idstringRequired1-300 characters
Unique and immutable order identifier from your upstream system
shipping_methodstringRequired>=1 character
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
typeenumRequired
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.
gift_messagestring or nullOptional<=500 characters
Gift message associated with the order
location_idinteger or nullOptional
Desired Fulfillment Center Location ID. If not specified, ShipBob will determine the location that fulfills this order.
order_numberstring or nullOptional<=400 characters
User friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId will be used
origin_platform_programstring or nullOptional<=100 characters
Origin platform program for the order. Accepts a program name.
purchase_datedatetime or nullOptional
Date this order was purchase by the end user
requested_delivery_datedatetime or nullOptional
The delivery date requested by the source platform for the order in UTC
retailer_program_dataobjectOptional
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.
sales_channelenumOptional
shipping_termsobjectOptional
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.
tagslist of objects or nullOptional
Key value pair array to store extra information at the order level for API purposes. ShipBob won't display the info in the ShipBob Merchant Portal or react based on this data.
Response
Created
channelobjectOptional
Created by channel metadata
created_datedatetimeOptional
Date this order was created
gift_messagestring or nullOptional
Gift message associated with the order
idintegerOptional
Unique id of the order
order_numberstring or nullOptional
User friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId will be used
productslist of objects or nullOptional
List of products included in the order
purchase_datedatetime or nullOptional
Date this order was purchase by the end user
recipientobjectOptional
Information about the recipient of an order
reference_idstring or nullOptional
Client-defined external unique id of the order
retailer_program_dataobjectOptional
Contains properties that needs to be used for fulfilling B2B/Dropship orders.
shipmentslist of objects or nullOptional
Shipments affiliated with the order
shipping_methodstring or nullOptional
Client-defined shipping method
shipping_termsobjectOptional
Contains shipping properties that need to be used for fulfilling an order.
tagslist of objects or nullOptional
Client-defined order tags
typeenumOptional
Order type. DTC is a direct to consumer order. DropShip and B2B are retailer program order types.
