API ReferenceOrders

Create Order

View as Markdown

Creates a new order in ShipBob’s system that will be queued for fulfillment. Orders can be created using either product reference IDs (SKUs) or ShipBob product IDs, with reference IDs being the recommended approach.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token or OAuth2

Headers

shipbob_channel_idstringRequiredformat: "int32"

Retrieve your channel ID from the GET /channel endpoint. Use the channel ID that has write scopes.

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
Allowed values:
financialsobjectOptional
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
retailer_program_dataobjectOptional

Contains properties that needs to be used for fulfilling B2B/Dropship orders.

sales_channelenumOptional
shipping_termsobjectOptional
Contains shipping properties that need to be used for fulfilling an order.
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
channelobject or null
Created by channel metadata
created_datedatetime or null
Date this order was created
financialsobject or null
gift_messagestring or null
Gift message associated with the order
idinteger or null
Unique id of the order
order_numberstring or null
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 null
List of products included in the order
purchase_datedatetime or null
Date this order was purchase by the end user
recipientobject or null
Information about the recipient of an order
reference_idstring or null

Client-defined external unique id of the order

retailer_program_dataobject or null

Contains properties that needs to be used for fulfilling B2B/Dropship orders.

shipmentslist of objects or null
Shipments affiliated with the order
shipping_methodstring or null

Client-defined shipping method

shipping_termsobject or null
Contains shipping properties that need to be used for fulfilling an order.
statusenum or null
tagslist of objects or null

Client-defined order tags

typeenum or null
Allowed values:

Errors