ShipBob
App · 20 actions
Read ShipBob products, orders, shipments and inventory, with separate sandbox access.
Actions
| Action | What it does |
|---|---|
| Cancel order | Cancel order. |
| Create order | Create order. |
| Create product | Create product. |
| Get inventory | Get inventory. |
| Get order | Get order. |
| Get product | Get product. |
| Get receiving order | Get receiving order. |
| Get return | Get return. |
| Get shipment | Get shipment. |
| Get shipment timeline | Get shipment timeline. |
| List channels | List channels. |
| List fulfillment centers | List fulfillment centers. |
| List inventory | List inventory. |
| List inventory levels | List inventory levels. |
| List order shipments | List order shipments. |
| List orders | List orders. |
| List products | List products. |
| List receiving orders | List receiving orders. |
| List returns | List returns. |
| Update product | Update product. |
Cancel order
Cancel order.
Inputs
- Order id
order_idnumberRequired - The order ID to cancel
Outputs
dataobject- Order cancellation result.
Example output
{
"data": {
"canceled_shipment_results": [],
"order": {
"channel": {
"id": 1,
"name": "example"
},
"created_date": "example",
"financials": {
"total_price": 1.0
},
"gift_message": "example",
"id": 1,
"order_number": "example",
"products": [],
"purchase_date": "example",
"recipient": {
"address": {
"address1": "example",
"address2": "example",
"city": "example",
"company_name": "example",
"country": "example",
"state": "example",
"zip_code": "example"
},
"email": "example",
"name": "example",
"phone_number": "example"
},
"reference_id": "example",
"retailer_program_data": {
"addresses": [],
"customer_ticket_number": "example",
"delivery_date": "example",
"department": "example",
"do_not_ship_before_date": "example",
"mark_for_store": "example",
"purchase_order_number": "example",
"retailer_program_type": "example",
"ship_by_date": "example"
},
"shipments": [],
"shipping_method": "example",
"shipping_terms": {
"carrier_type": "Parcel",
"payment_term": "Collect"
},
"status": "Processing",
"tags": [],
"type": "DTC"
},
"order_id": 1,
"status": "Success"
}
}Create order
Create order.
Inputs
- Channel
channel_idnumberRequired - Channel from List channels.At least 1.
- Financials total price
financials_total_pricenumber - Sum of all line item prices, discounts, and taxes in USD
- Gift message
gift_messagetext - Gift message associated with the order
- Location id
location_idnumber - Desired Fulfillment Center Location ID. If not specified, ShipBob will determine the location that fulfills this order.
- Order number
order_numbertext - User friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId will be used
- Origin platform program
origin_platform_programtext - Origin platform program for the order. Accepts a program name.
- Products
productslistRequired - Products included in the order. Products identified by reference_id must also include the product name if there is no matching ShipBob product.
- Purchase date
purchase_datedate and time - Date this order was purchase by the end user
- Recipient address
recipient_addressobjectRequired - Address of the recipient
- Recipient email
recipient_emailtext - Email address of the recipient
- Recipient name
recipient_nametextRequired - Name of the recipient
- Recipient phone number
recipient_phone_numbertext - Phone number of the recipient
- Reference id
reference_idtextRequired - Unique and immutable order identifier from your upstream system
- Requested delivery date
requested_delivery_datedate and time - The delivery date requested by the source platform for the order in UTC
- Retailer program data
retailer_program_dataobject - Contains properties that needs to be used for fulfilling B2B/Dropship orders.
- Sales channel
sales_channeltext - Sales channel.One of:
amazon,bigcommerce,ebay,faire,macy,magento,shein,shopify,squarespace,targetplus, and 5 more. - Shipping method
shipping_methodtextRequired - 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
- Shipping terms carrier type
shipping_terms_carrier_typetext - Shipping terms carrier type.One of:
Parcel,Freight. - Shipping terms payment term
shipping_terms_payment_termtext - Shipping terms payment term.One of:
Collect,ThirdParty,Prepaid,MerchantResponsible. - Tags
tagslist - 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.
- Type
typetextRequired - Order type. DTC is a direct to consumer order. DropShip and B2B are retailer program order types.One of:
DTC,DropShip,B2B.
Outputs
dataobject- Service response.
Example output
{
"data": {
"channel": {
"id": 1,
"name": "example"
},
"created_date": "example",
"financials": {
"total_price": 1.0
},
"gift_message": "example",
"id": 1,
"order_number": "example",
"products": [],
"purchase_date": "example",
"recipient": {
"address": {
"address1": "example",
"address2": "example",
"city": "example",
"company_name": "example",
"country": "example",
"state": "example",
"zip_code": "example"
},
"email": "example",
"name": "example",
"phone_number": "example"
},
"reference_id": "example",
"retailer_program_data": {
"addresses": [],
"customer_ticket_number": "example",
"delivery_date": "example",
"department": "example",
"do_not_ship_before_date": "example",
"mark_for_store": "example",
"purchase_order_number": "example",
"retailer_program_type": "example",
"ship_by_date": "example"
},
"shipments": [],
"shipping_method": "example",
"shipping_terms": {
"carrier_type": "Parcel",
"payment_term": "Collect"
},
"status": "Processing",
"tags": [],
"type": "DTC"
}
}Create product
Create product.
Inputs
- Channel
channel_idnumberRequired - Channel from List channels.At least 1.
- Is quarantine
is_quarantinetrue/false - Flag indicating whether the product should be created in quarantine status
- Variants
variantslist - List of variants to create with the product. At least one variant is required. Each variant must have a unique SKU.
- Name
nametext - The name of the product
- Taxonomy id
taxonomy_idnumber - The taxonomy ID for categorizing the product
- Type id
type_idnumber - The product type ID (1 = Regular, 2 = Bundle)One of:
1,2.
Outputs
dataobject- Service response.
Example output
{
"data": {
"created_on": "example",
"id": 1,
"name": "example",
"taxonomy": {
"id": 1,
"name": "example",
"parent_id": 1,
"parent_name": "example",
"path": "example"
},
"type": "example",
"updated_on": "example",
"user_id": 1,
"variants": []
}
}Get inventory
Get inventory.
Inputs
- Inventory id
inventory_idnumberRequired - Unique identifier for the inventory item to retrieve. This ID is returned when listing all inventories and is used to fetch detailed information about a specific inventory item.
Outputs
dataobject- Service response.
Example output
{
"data": {
"barcode": "example",
"dimensions": {
"height": 1.0,
"is_locked": false,
"length": 1.0,
"unit": "example",
"validated": false,
"width": 1.0
},
"inventory_id": 1,
"is_case": false,
"is_lot": false,
"name": "example",
"sku": "example",
"user_id": 1,
"variant": {
"hazmat": {
"is_hazmat": false,
"validated": false
},
"is_active": false,
"is_bundle": false,
"is_digital": false
},
"weight": {
"unit": "example",
"value": 1.0
}
}
}Get order
Get order.
Inputs
- Order id
order_idnumberRequired - Order id.
Outputs
dataobject- Service response.
Example output
{
"data": {
"channel": {
"id": 1,
"name": "example"
},
"created_date": "example",
"financials": {
"total_price": 1.0
},
"gift_message": "example",
"id": 1,
"order_number": "example",
"products": [],
"purchase_date": "example",
"recipient": {
"address": {
"address1": "example",
"address2": "example",
"city": "example",
"company_name": "example",
"country": "example",
"state": "example",
"zip_code": "example"
},
"email": "example",
"name": "example",
"phone_number": "example"
},
"reference_id": "example",
"retailer_program_data": {
"addresses": [],
"customer_ticket_number": "example",
"delivery_date": "example",
"department": "example",
"do_not_ship_before_date": "example",
"mark_for_store": "example",
"purchase_order_number": "example",
"retailer_program_type": "example",
"ship_by_date": "example"
},
"shipments": [],
"shipping_method": "example",
"shipping_terms": {
"carrier_type": "Parcel",
"payment_term": "Collect"
},
"status": "Processing",
"tags": [],
"type": "DTC"
}
}Get product
Get product.
Inputs
- Product id
product_idnumberRequired - The ShipBob product id, as returned in the id field by GET /product.
Outputs
dataobject- Service response.
Example output
{
"data": {
"created_on": "example",
"id": 1,
"name": "example",
"taxonomy": {
"id": 1,
"name": "example",
"parent_id": 1,
"parent_name": "example",
"path": "example"
},
"type": "example",
"updated_on": "example",
"user_id": 1,
"variants": []
}
}Get receiving order
Get receiving order.
Inputs
- Id
idnumberRequired - Id of the receiving order
Outputs
dataobject- Service response.
Example output
{
"data": {
"box_labels_uri": "example",
"box_packaging_type": "EverythingInOneBox",
"expected_arrival_date": "example",
"external_sync_timestamp": "example",
"final_destination_fulfillment_center_id": 1,
"fulfillment_center": {
"address1": "example",
"address2": "example",
"city": "example",
"country": "example",
"email": "example",
"id": 1,
"name": "example",
"phone_number": "example",
"state": "example",
"timezone": "example",
"zip_code": "example"
},
"id": 1,
"insert_date": "example",
"inventory_quantities": [],
"last_updated_date": "example",
"package_type": "Package",
"purchase_order_number": "example",
"status": "Awaiting",
"status_history": []
}
}Get return
Get return.
Inputs
- Id
idnumberRequired - The Id of the Return
Outputs
dataobject- The details of a public return order, including the transactions and inventory items
Example output
{
"data": {
"arrived_date": "example",
"awaiting_arrival_date": "example",
"cancelled_date": "example",
"channel": {
"id": 1,
"name": "example"
},
"completed_date": "example",
"customer_name": "example",
"fulfillment_center": {
"id": 1,
"name": "example"
},
"id": 1,
"insert_date": "example",
"inventory": [],
"invoice": {
"amount": 1.0,
"currency_code": "example"
},
"original_shipment_id": 1,
"processing_date": "example",
"reference_id": "example",
"return_type": "example",
"shipment_tracking_number": "example",
"status": "example",
"status_history": [],
"store_order_id": "example",
"tracking_number": "example",
"transactions": []
}
}Get shipment
Get shipment.
Inputs
- Shipment id
shipment_idnumberRequired - The shipment id to get
Outputs
dataobject- Information about a shipment
Example output
{
"data": {
"actual_fulfillment_date": "example",
"created_date": "example",
"delivery_date": "example",
"estimated_fulfillment_date": "example",
"estimated_fulfillment_date_status": "AwaitingInventoryAllocation",
"gift_message": "example",
"id": 1,
"insurance_value": 1.0,
"invoice_amount": 1.0,
"invoice_currency_code": "example",
"is_tracking_uploaded": false,
"last_tracking_update_at": "example",
"last_update_at": "example",
"location": {
"id": 1,
"name": "example"
},
"measurements": {
"depth_in": 1,
"length_in": 1,
"total_weight_oz": 1,
"width_in": 1
},
"order_id": 1,
"package_material_type": "Unknown",
"parent_cartons": [],
"products": [],
"recipient": {
"address": {
"address1": "example",
"address2": "example",
"city": "example",
"company_name": "example",
"country": "example",
"state": "example",
"zip_code": "example"
},
"email": "example",
"full_name": "example",
"name": "example",
"phone_number": "example"
},
"reference_id": "example",
"require_signature": false,
"ship_option": "example",
"status": "None",
"status_details": [],
"tracking": {
"bol": "example",
"carrier": "example",
"carrier_service": "example",
"pro_number": "example",
"scac": "example",
"shipping_date": "example",
"tracking_number": "example",
"tracking_url": "example"
}
}
}Get shipment timeline
Get shipment timeline.
Inputs
- Shipment id
shipment_idnumberRequired - The shipment id to get
Outputs
datalist- Service response.
Example output
{
"data": []
}List channels
List channels. Returns one page; use the continuation fields for more results.
Inputs
- Records per page
records_per_pagenumber - The number of records to return per page. This parameter is used for pagination. If not provided, a default value will be used.Default:
50. - Cursor
cursortext - A cursor for pagination. This parameter is used to fetch the next set of results.
- Next page url
next_page_urltext - Next page URL returned by this action. Leave empty for the first page; only its query values are used.
Outputs
dataobject- Get Channels response
Example output
{
"data": {
"items": [],
"next": "example",
"prev": "example"
}
}List fulfillment centers
List fulfillment centers. Returns one page; use the continuation fields for more results.
Inputs
None.
Outputs
datalist- Service response.
Example output
{
"data": []
}List inventory
List inventory. Returns one page; use the continuation fields for more results.
Inputs
- Search by
search_bytext - Search is available for 3 fields: Inventory ID, Name, and SKU. Expected behavior for search by Inventory ID is exact match. Expected behavior for search by Inventory Name or SKU is partial match (consecutive characters, case insensitive).
- Filter operations
filter_operationslist - Advanced filtering operations. Apply multiple key-value filters to refine inventory results. Each filter operation contains a 'key' (field name) and 'rawValue' (filter value) to match.
- Inventory ids
inventory_idslist - Comma-separated list of inventory IDs to filter results. Use this to retrieve information for specific inventory items only. To find an item by SKU or name, use SearchBy instead.
- Is active
is_activetrue/false - Filter by active status. True returns only active inventory items, False returns only inactive items. Omit to return both.
- Is digital
is_digitaltrue/false - Filter by digital product status. True returns only digital products (no physical fulfillment), False returns only physical products. Omit to return both.
- Page size
page_sizenumber - Results per page.From 1 to 250.
- Sort by
sort_bytext - Sort results by field name. Valid fields: id, inventory_id, name, barcode, sku. Results are returned in ascending order by default; append ' desc' to a field for descending order (e.g., 'name desc' sorts by name descending).
- Cursor
cursortext - Continuation cursor from the previous page.
- Next page url
next_page_urltext - Next page URL returned by this action. Leave empty for the first page; only its query values are used.
Outputs
dataobject- Service response.
Example output
{
"data": {
"first": "example",
"items": [],
"last": "example",
"next": "example",
"prev": "example"
}
}List inventory levels
List inventory levels. Returns one page; use the continuation fields for more results.
Inputs
- Search by
search_bytext - Search is available for 3 fields: Inventory ID, Name, and SKU. Expected behavior for search by Inventory ID is exact match. Expected behavior for search by Inventory Name or SKU is partial match (consecutive characters, case insensitive).
- Inventory ids
inventory_idslist - Comma-separated list of inventory IDs to filter results. Use this to retrieve inventory levels for specific inventory items only.
- Is active
is_activetrue/false - Filter inventory levels by active status. Set to true to return only active inventory items, false for inactive items. Omit to return all items regardless of status.
- Is digital
is_digitaltrue/false - Filter inventory levels by digital product status. Set to true to return only digital products, false for physical products. Digital products are items that don't require physical fulfillment.
- Has quarantine
has_quarantinetrue/false - Has quarantine.
- Page size
page_sizenumber - Results per page.From 1 to 250.
- Sort by
sort_bytext - Sort results by field name. Valid fields: id, inventory_id, name, sku, total_fulfillable_quantity, total_on_hand_quantity, total_committed_quantity, total_sellable_quantity, total_awaiting_quantity, total_exception_quantity, total_internal_transfer_quantity, total_backordered_quantity, total_in_fulfillment_quantity, total_quarantine_quantity. Results are returned in ascending order by default; append ' desc' to a field for descending order (e.g., 'total_on_hand_quantity desc' sorts by quantity descending).
- Cursor
cursortext - Continuation cursor from the previous page.
- Next page url
next_page_urltext - Next page URL returned by this action. Leave empty for the first page; only its query values are used.
Outputs
dataobject- Service response.
Example output
{
"data": {
"first": "example",
"items": [],
"last": "example",
"next": "example",
"prev": "example"
}
}List order shipments
List order shipments. Returns one page; use the continuation fields for more results.
Inputs
- Order id
order_idnumberRequired - The order id to get shipments for
Outputs
datalist- Service response.
Example output
{
"data": []
}List orders
List orders. Returns one page; use the continuation fields for more results.
Inputs
- Page
pagenumber - Page of orders to getFrom 1.0 to 2147483647.0.
- Limit
limitnumber - Amount of orders per page to requestFrom 1.0 to 250.0.
- Ids
idslist - order ids to filter by, comma separated <br /><strong>Example:</strong> ?IDs=1,2
- Reference ids
reference_idslist - Reference ids to filter by, comma separated <br /><strong>Example:</strong> ?ReferenceIds=Ref1,Ref2
- Start date
start_datedate and time - Start date to filter orders inserted later than
- End date
end_datedate and time - End date to filter orders inserted earlier than
- Sort order
sort_ordertext - Order to sort results inOne of:
Newest,Oldest. - Has tracking
has_trackingtrue/false - Has any portion of this order been assigned a tracking number
- Last update start date
last_update_start_datedate and time - Start date to filter orders updated later than
- Last update end date
last_update_end_datedate and time - End date to filter orders updated later than
- Is tracking uploaded
is_tracking_uploadedtrue/false - Filter orders that their tracking information was fully uploaded
- Last tracking update start date
last_tracking_update_start_datedate and time - Start date to filter orders with tracking updates later than the supplied date. Will only return orders that have tracking information
- Last tracking update end date
last_tracking_update_end_datedate and time - End date to filter orders updated later than the supplied date. Will only return orders that have tracking information
Outputs
datalist- Service response.
Example output
{
"data": []
}List products
List products. Returns one page; use the continuation fields for more results.
Inputs
- Search
searchtext - Search Products by name, sku, inventory id or product Id.
- Barcode
barcodetext - Barcode Associated with variant
- Barcodes
barcodestext - Barcodes Associated with variant
- Category ids
category_idstext - List of Category Ids associated with product
- Channel ids
channel_idstext - Looks for Products variants by their channel IDs
- Has digital variants
has_digital_variantstext - Looks for Products with/without digital variants
- Has variants
has_variantstext - Looks for Products with/without variants
- Inventory id
inventory_idtext - Looks for variants by its associated inventory id
- Is inventory sync enabled
is_inventory_sync_enabledtext - Looks for Products variants by their IsInventorySyncEnabled is true
- Last updated timestamp
last_updated_timestampdate and time - Looks for Products that have been updated since the given date
- Legacy ids
legacy_idstext - Looks for Products with by Legacy Product Id(s)
- Name
nametext - Looks for Products/Variants by name
- On hand
on_handtext - Looks for Products with inventory
- Platform ids
platform_idstext - Looks for Products variants by their external Platform IDs
- Product id
product_idtext - Looks for Products with an assigned Id
- Product type
product_typetext - Looks for Products by type
- Reviews pending
reviews_pendingtext - Looks for Products by ReviewsPending
- Sales channel
sales_channeltext - Looks for Products variants assigned to a platform/sales channel
- Seller sku
seller_skutext - Looks for Products that match the provided Seller query
- Sku
skutext - Looks for Products that match the provided Sku query
- Taxonomy ids
taxonomy_idstext - Looks for Products variants by their taxonomy id or any descendants of the taxonomies sent separated by comma
- Variant id
variant_idtext - Looks for products that contain a variant with the given ID
- Variant status
variant_statustext - Looks for Products with variants that contain provided status
- Page size
page_sizenumber - Results per page.From 1 to 250.
- Sort by
sort_bytext - Id, Name, Category, TotalOnHandQtyOne of:
Id,Name,Category,TotalOnHandQty. - Sort order
sort_ordertext - ASC,DESCOne of:
ASC,DESC. - Cursor
cursortext - Continuation cursor from the previous page.
- Next page url
next_page_urltext - Next page URL returned by this action. Leave empty for the first page; only its query values are used.
Outputs
dataobject- Service response.
Example output
{
"data": {
"first": "example",
"first_cursor": "example",
"items": [],
"last": "example",
"last_cursor": "example",
"next": "example",
"next_cursor": "example",
"prev": "example",
"prev_cursor": "example"
}
}List receiving orders
List receiving orders. Returns one page; use the continuation fields for more results.
Inputs
- Page
pagenumber - Page of WROs to get
- Limit
limitnumber - Number of WROs per page to request
- Ids
idslist - Comma separated list of WRO IDs to filter by
- Statuses
statuseslist - Comma separated list of WRO statuses to filter byOne or more of:
Awaiting,Processing,Completed,Cancelled,Incomplete,Arrived,PartiallyArrived,PartiallyArrivedAtHub,ArrivedAtHub,ProcessingAtHub,InternalTransfer. - Insert start date
insert_start_datedate and time - Earliest date that a WRO was created
- Insert end date
insert_end_datedate and time - Latest date that a WRO was created
- Fulfillment center ids
fulfillment_center_idslist - Comma separated list of WRO fulfillment center IDs to filter by
- Purchase order numbers
purchase_order_numberslist - Comma separated list of WRO PO numbers to filter by
- External sync
external_synctrue/false - Flag to return external_sync_timestamp WROs
- Completed start date
completed_start_datedate and time - Earliest date that a WRO was completed
- Completed end date
completed_end_datedate and time - Latest date that a WRO was completed
Outputs
datalist- Service response.
Example output
{
"data": []
}List returns
List returns. Returns one page; use the continuation fields for more results.
Inputs
- Ids
idstext - The IDs of the returns to fetch. Accepts a comma-separated list of return IDs (e.g., 123,456,789).
- Reference ids
reference_idstext - Comma-separated list of return reference IDs (RMA numbers) to filter by.
- Status
statustext - Comma-separated list of return statuses to filter by (e.g., AwaitingArrival, Arrived, Processing, Completed, Cancelled).
- Fulfillment center ids
fulfillment_center_idstext - Comma-separated list of fulfillment center IDs to filter by.
- Tracking numbers
tracking_numberstext - Comma-separated list of tracking numbers to filter by.
- Original shipment ids
original_shipment_idstext - Comma-separated list of original shipment IDs to filter by.
- Inventory ids
inventory_idstext - Comma-separated list of inventory IDs to filter by.
- Start date
start_datedate and time - Filter returns created on or after this date (ISO 8601 format).
- End date
end_datedate and time - Filter returns created on or before this date (ISO 8601 format).
- Return types
return_typestext - Comma-separated list of return types to filter by (e.g., Regular, ReturnToSender).
- Return actions
return_actionstext - Comma-separated list of return actions to filter by (e.g., Restock, Quarantine, Dispose).
- Store order ids
store_order_idstext - Comma-separated list of store order IDs to filter by.
- Sortby
sortbytext - Field to sort results by.
- Completed start date
completed_start_datedate and time - Filter returns completed on or after this date (ISO 8601 format).
- Completed end date
completed_end_datedate and time - Filter returns completed on or before this date (ISO 8601 format).
- Cursor
cursornumber - Page number to retrieve. Used for pagination through result sets.From 1.0 to 2147483647.0.
- Limit
limitnumber - Maximum number of records to return per page.
- Sort order
sort_ordertext - Sort order for results. Desc = newest to oldest, Asc = oldest to newest, Desc is defaultOne of:
Asc,Desc. - Next page url
next_page_urltext - Next page URL returned by this action. Leave empty for the first page; only its query values are used.
Outputs
dataobject- Service response.
Example output
{
"data": {
"first": "example",
"items": [],
"last": "example",
"next": "example",
"prev": "example"
}
}Update product
Update product.
Inputs
- Channel
channel_idnumberRequired - Channel from List channels.At least 1.
- Product id
product_idnumberRequired - The product identifier
- Id
idnumber - Unique reference ID for the product
- Variants
variantslist - List of variants to update. Each variant must include an ID. Only provided fields will be updated.
- Name
nametext - The name of the product
- Taxonomy id
taxonomy_idnumber - The taxonomy ID for categorizing the product
- Type id
type_idnumber - The product type ID (1 = Regular, 2 = Bundle)One of:
1,2.
Outputs
dataobject- Service response.
Example output
{
"data": {
"created_on": "example",
"id": 1,
"name": "example",
"taxonomy": {
"id": 1,
"name": "example",
"parent_id": 1,
"parent_name": "example",
"path": "example"
},
"type": "example",
"updated_on": "example",
"user_id": 1,
"variants": []
}
}