Webhooks
Orders
- POSTCancel one Shipment by Order Id and Shipment Id
- POSTEstimate Fulfillment Cost For Order
- GETGet shipping methods
- GETGet one Shipment by Order Id and Shipment Id
- GETGet Orders
- POSTCreate Order
- POSTCancel single Order by Order ID
- GETGet all Shipments for Order
- POSTCancel one Shipment by Shipment Id
- GETGet Order Store Json
- POSTSave the Store Order Json
- GETGet one Shipment by Shipment Id
- PUTUpdate a Shipment
- GETGet logs for one Shipment by Shipment Id
- POSTCancel multiple Shipments by Shipment Id
- GETGet one Shipment's status timeline by Order Id and Shipment Id
- GETGet Order
- GETGet one Shipment's status timeline by Shipment Id
- GETGet logs for one Shipment by Order Id and Shipment Id
- POSTUpdate Tracking Uploaded Status for Multiple Shipments by Shipment Id
Locations
Receiving
Returns
Products
- GETGet Product
- PATCHUpdate a single product with Json Merge Patch functionality
- GETRetrieves List of Products based on filters provided
- POSTCreate single product to the store
- PUTUpdate specific channel metadata record from a variant by channel metadata ID
- DELUsed to delete a specific channel metadata record from a variant by channel metadata ID
- GETGet Taxonomy Parent by Id
- GETGet Taxonomies
- GETGet Taxonomy by Id
- GETGet Packaging Requirement
- POSTUsed to Create a new Channel Metadata Entry for a given Variant
Channels
Inventory
Cancel single Order by Order ID
curl --request POST \
--url https://api.shipbob.com/2.0/order/{orderId}/cancel \
--header 'Authorization: <api-key>' \
--header 'shipbob_channel_id: <shipbob_channel_id>'{
"canceled_shipment_results": [
{
"action": "Cancel",
"is_success": true,
"reason": "string",
"shipment_id": 0
}
],
"order": {
"channel": {
"id": 0,
"name": "ShipBobs-Shopify-Store"
},
"created_date": "2019-08-24T14:15:22Z",
"financials": {
"total_price": 0.1
},
"gift_message": "string",
"id": 0,
"order_number": "string",
"products": [
{
"external_line_id": 0,
"gtin": "string",
"id": 0,
"quantity": 0,
"quantity_unit_of_measure_code": "string",
"reference_id": "TShirtBlueM",
"sku": "TShirtBlueM",
"unit_price": 0.1,
"upc": "string"
}
],
"purchase_date": "2019-08-24T14:15:22Z",
"recipient": {
"address": {
"address1": "100 Nowhere Blvd",
"address2": "Suite 100",
"city": "Gotham City",
"company_name": "Wayne Enterprises",
"country": "US",
"state": "NJ",
"zip_code": "07093"
},
"email": "[email protected]",
"name": "John Doe",
"phone_number": "555-555-5555"
},
"reference_id": "string",
"retailer_program_data": {
"addresses": [
{
"address1": "100 Nowhere Blvd",
"address2": "Suite 100",
"city": "Gotham City",
"company_name": "Wayne Enterprises",
"country": "US",
"state": "NJ",
"type": "MarkFor",
"zip_code": "07093"
}
],
"customer_ticket_number": "string",
"delivery_date": "2019-08-24T14:15:22Z",
"department": "string",
"doNotShipBeforeDate": "2019-08-24T14:15:22Z",
"mark_for_store": "string",
"purchase_order_number": "string",
"retailer_program_type": "string",
"shipByDate": "2019-08-24T14:15:22Z"
},
"shipments": [
{
"actual_fulfillment_date": "2019-08-24T14:15:22Z",
"created_date": "2019-08-24T14:15:22Z",
"delivery_date": "2019-08-24T14:15:22Z",
"estimated_fulfillment_date": "2019-08-24T14:15:22Z",
"estimated_fulfillment_date_status": "AwaitingInventoryAllocation",
"gift_message": "string",
"id": 0,
"insurance_value": 0,
"invoice_amount": 0,
"invoice_currency_code": "string",
"is_tracking_uploaded": true,
"last_tracking_update_at": "2019-08-24T14:15:22Z",
"last_update_at": "2019-08-24T14:15:22Z",
"location": {
"id": 0,
"name": "Cicero (IL)"
},
"measurements": {
"depth_in": 0,
"length_in": 0,
"total_weight_oz": 0,
"width_in": 0
},
"order_id": 0,
"package_material_type": "Unknown",
"parent_cartons": [
{
"barcode": "string",
"cartons": [
{
"barcode": "string",
"carton_details": [
{
"products": [
{
"id": 0,
"inventory_items": [
{
"expiration_date": "2019-08-24T14:15:22Z",
"id": 0,
"is_dangerous_goods": true,
"lot": "22222",
"name": "Medium Blue T-Shirt",
"quantity": 0,
"quantity_committed": 0,
"serial_numbers": [
null
]
}
],
"name": "Medium Blue T-Shirt",
"reference_id": "TShirtBlueM",
"sku": "TShirtBlueM"
}
]
}
],
"id": 0,
"measurements": {
"depth_in": 0.1,
"length_in": 0.1,
"total_weight_oz": 0.1,
"width_in": 0.1
},
"type": "Box or pallet"
}
],
"measurements": {
"depth_in": 0.1,
"length_in": 0.1,
"total_weight_oz": 0.1,
"width_in": 0.1
},
"type": "Box or pallet"
}
],
"products": [
{
"id": 0,
"inventory_items": [
{
"expiration_date": "2019-08-24T14:15:22Z",
"id": 0,
"is_dangerous_goods": true,
"lot": "22222",
"name": "Medium Blue T-Shirt",
"quantity": 0,
"quantity_committed": 0,
"serial_numbers": [
"string"
]
}
],
"name": "Medium Blue T-Shirt",
"reference_id": "TShirtBlueM",
"sku": "TShirtBlueM"
}
],
"recipient": {
"address": {
"address1": "100 Nowhere Blvd",
"address2": "Suite 100",
"city": "Gotham City",
"company_name": "Wayne Enterprises",
"country": "US",
"state": "NJ",
"zip_code": "07093"
},
"email": "[email protected]",
"full_name": "John Doe",
"name": "John Doe",
"phone_number": "555-555-5555"
},
"reference_id": "string",
"require_signature": true,
"ship_option": "Standard",
"status": "None",
"status_details": [
{
"description": "string",
"exception_fulfillment_center_id": 0,
"extra_information": {
"validation_messages": [
"string"
]
},
"id": 0,
"inventory_id": 0,
"name": "string"
}
],
"tracking": {
"bol": "string",
"carrier": "USPS",
"carrier_service": "Priority",
"pro_number": "string",
"scac": "string",
"shipping_date": "2019-08-24T14:15:22Z",
"tracking_number": "860C8CDC8F0B4FC7AB69AC86C20539EC",
"tracking_url": "https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"
}
}
],
"shipping_method": "Free 2-day Shipping",
"shipping_terms": {
"carrier_type": "Parcel",
"payment_term": "Collect"
},
"status": "Processing",
"tags": [
{
"name": "Handling instructions",
"value": "Fragile"
}
],
"type": "DTC"
},
"order_id": 0,
"status": "Success"
}Authorizations
Provide your personal access token in the format 'Bearer {your_personal_access_token}'
Headers
Channel ID for Operation
Path Parameters
The order ID to cancel
Response
Results of canceling the shipments associated with the order
CleanSweep, Reassign, ReleaseOrderHold, MoveToOnHoldAndKeepInventory, MoveToOnHoldAndReleaseInventory, Cancel, AddLineItem, RemoveLineItem, UpdateShipOption If the cancel action was successful
The reason the cancellation result
The ID of the shipment
Date this order was created
Sum of all line item prices, discounts, and taxes in USD
Gift message associated with the order
Unique id of the order
User friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId will be used
List of products included in the order
Numeric assignment per item. Used as a reference number for multiple purposes such as split orders, split containers, etc.
Global Trade Item Number - unique and internationally recognized identifier assigned to item by company GS1
Unique id of the product
The quantity of this product ordered
Defined standard for measure for an item (each, inner pack, case, pallet). Values: EA, INP, CS and PL
Unique reference id of the product
"TShirtBlueM"
Stock keeping unit for the product
"TShirtBlueM"
Price for one item
Universal Product Code - Unique external identifier
Date this order was purchase by the end user
Information about the recipient of an order
Address of the recipient
First line of the address
1"100 Nowhere Blvd"
The city
1"Gotham City"
The country (Must be ISO Alpha-2 for estimates)
1"US"
Second line of the address
"Suite 100"
Name of the company receiving the shipment
"Wayne Enterprises"
The state or province
"NJ"
The zip code or postal code
"07093"
Name of the recipient
1 - 300"John Doe"
Email address of the recipient
Phone number of the recipient
50"555-555-5555"
Client-defined external unique id of the order
Contains properties that needs to be used for fulfilling B2B/Dropship orders.
Ship From - Certain retailers want to display the ship from address as their return facility, not Shipbob’s warehouse address /// Mark For Address - Final destination address
Address to used when creating a B2B/DropShip order.
First line of the address
1"100 Nowhere Blvd"
The city
1"Gotham City"
The country (Must be ISO Alpha-2 for estimates)
1"US"
MarkFor, ShipFrom Second line of the address
"Suite 100"
Name of the company receiving the shipment
"Wayne Enterprises"
The state or province
"NJ"
The zip code or postal code
"07093"
Customer Ticket Number
Expected delivery date
Identifies a merchant's store department
The date the retailer does not want the order shipped by.
Store Number
First initial documentation sent from buyer to seller with item(s) and quantities.
1Identifies retailer-merchant combination
1The date the retailer has requested the order to ship by.
Shipments affiliated with the order
Information about a shipment
The datetime of ShipBob’s completion of the fulfillment operation as promised. Currently, this means the shipment has been picked, packed, and label has been printed.
Date this shipment was created
The datetime of Shipment delivered to customer.
The datetime of ShipBob’s commitment for completing the shipment and handing to the carrier for delivery.
AwaitingInventoryAllocation, AwaitingReset, Unavailable, PendingOnTime, FulfilledOnTime, PendingLate, FulfilledLate Gift message associated with the shipment
500Unique id of the shipment
Monetary amount that this shipment was insured for
Monetary amount that was invoiced for this shipment
Indicates whether the Shipment was marked with tracking information uploaded to a third-party system where the order originated.
Timestamp for the last time this shipment had a tracking update
Date this shipment was last updated
Measurements of a shipment
Id of the order this shipment belongs to
Unknown, Box, BubbleMailer, PolyMailer, FragileBox, PosterTube, Custom, Bookfold, OwnContainer, Undefined Carton information for this shipment
Barcode assigned to this carton
Cartons packed inside this parent container
Barcode assigned to this carton
Details about the contents of this carton
ID assigned to this carton
Measurements of a carton
Type of this carton container
"Box or pallet"
Measurements of a carton
Total depth in inches
Total length in inches
Total weight in ounces
Total width in inches
Type of this carton container
"Box or pallet"
Information about the products contained in this shipment
Information about a store product belonging to a shipment
Unique id of the product
Information about fulfillable inventory items belonging to this product
Information about inventory belonging to a store product
Expiration date of the inventory
Unique id of the inventory
Is inventory Dangerous Good
true
Lot number of the inventory
"22222"
Name of the inventory item
"Medium Blue T-Shirt"
Quantity of the inventory item to be included in the fulfillment
The quantity of the inventory item allocated from the assigned fulfillment center and committed to the order. If quantity committed is less than order quantity, then the inventory item is out of stock at the assigned fulfillment center.
Serial number of the inventory
Name of the product
"Medium Blue T-Shirt"
Unique reference id of the product
"TShirtBlueM"
Stock keeping unit for the product
"TShirtBlueM"
Information about the recipient of a shipment
Address of the recipient
First line of the address
1"100 Nowhere Blvd"
The city
1"Gotham City"
The country (Must be ISO Alpha-2 for estimates)
1"US"
Second line of the address
"Suite 100"
Name of the company receiving the shipment
"Wayne Enterprises"
The state or province
"NJ"
The zip code or postal code
"07093"
Email address of the recipient
FullName of the recipient
"John Doe"
Name of the recipient
"John Doe"
Phone number of the recipient
"555-555-5555"
Client-defined external unique id of the order this shipment belongs to
If a shipment requires signature
Name of the shipping option used for this shipment
"Standard"
None, Processing, Completed, Exception, OnHold, Cancelled, CleanSweeped, LabeledCreated, ImportReview Additional details about the shipment status
Describes what the status detail means
The id of the status detail
Inventory Id the detail applies to (if applicable)
Short name of the status detail
Tracking information for a shipment
Bill of lading (BOL) number. Document acknowledging receipt of cargo for shipment.
Carrier of the shipment
"USPS"
The carrier's service which was used for this shipment
"Priority"
Tracking number used for freight carriers
Standard Carrier Alpha Code (SCAC). Unique 2-4 letter code used to identify transportation companies.
Date freight was shipped on
Tracking number of the shipment
"860C8CDC8F0B4FC7AB69AC86C20539EC"
URL to the website where a shipment can be tracked
"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"
Client-defined shipping method
"Free 2-day Shipping"
Processing, Exception, PartiallyFulfilled, Fulfilled, Cancelled, ImportReview DTC, DropShip, B2B The ID of the canceled order
Success, Failure, PartialSuccess Was this page helpful?
curl --request POST \
--url https://api.shipbob.com/2.0/order/{orderId}/cancel \
--header 'Authorization: <api-key>' \
--header 'shipbob_channel_id: <shipbob_channel_id>'{
"canceled_shipment_results": [
{
"action": "Cancel",
"is_success": true,
"reason": "string",
"shipment_id": 0
}
],
"order": {
"channel": {
"id": 0,
"name": "ShipBobs-Shopify-Store"
},
"created_date": "2019-08-24T14:15:22Z",
"financials": {
"total_price": 0.1
},
"gift_message": "string",
"id": 0,
"order_number": "string",
"products": [
{
"external_line_id": 0,
"gtin": "string",
"id": 0,
"quantity": 0,
"quantity_unit_of_measure_code": "string",
"reference_id": "TShirtBlueM",
"sku": "TShirtBlueM",
"unit_price": 0.1,
"upc": "string"
}
],
"purchase_date": "2019-08-24T14:15:22Z",
"recipient": {
"address": {
"address1": "100 Nowhere Blvd",
"address2": "Suite 100",
"city": "Gotham City",
"company_name": "Wayne Enterprises",
"country": "US",
"state": "NJ",
"zip_code": "07093"
},
"email": "[email protected]",
"name": "John Doe",
"phone_number": "555-555-5555"
},
"reference_id": "string",
"retailer_program_data": {
"addresses": [
{
"address1": "100 Nowhere Blvd",
"address2": "Suite 100",
"city": "Gotham City",
"company_name": "Wayne Enterprises",
"country": "US",
"state": "NJ",
"type": "MarkFor",
"zip_code": "07093"
}
],
"customer_ticket_number": "string",
"delivery_date": "2019-08-24T14:15:22Z",
"department": "string",
"doNotShipBeforeDate": "2019-08-24T14:15:22Z",
"mark_for_store": "string",
"purchase_order_number": "string",
"retailer_program_type": "string",
"shipByDate": "2019-08-24T14:15:22Z"
},
"shipments": [
{
"actual_fulfillment_date": "2019-08-24T14:15:22Z",
"created_date": "2019-08-24T14:15:22Z",
"delivery_date": "2019-08-24T14:15:22Z",
"estimated_fulfillment_date": "2019-08-24T14:15:22Z",
"estimated_fulfillment_date_status": "AwaitingInventoryAllocation",
"gift_message": "string",
"id": 0,
"insurance_value": 0,
"invoice_amount": 0,
"invoice_currency_code": "string",
"is_tracking_uploaded": true,
"last_tracking_update_at": "2019-08-24T14:15:22Z",
"last_update_at": "2019-08-24T14:15:22Z",
"location": {
"id": 0,
"name": "Cicero (IL)"
},
"measurements": {
"depth_in": 0,
"length_in": 0,
"total_weight_oz": 0,
"width_in": 0
},
"order_id": 0,
"package_material_type": "Unknown",
"parent_cartons": [
{
"barcode": "string",
"cartons": [
{
"barcode": "string",
"carton_details": [
{
"products": [
{
"id": 0,
"inventory_items": [
{
"expiration_date": "2019-08-24T14:15:22Z",
"id": 0,
"is_dangerous_goods": true,
"lot": "22222",
"name": "Medium Blue T-Shirt",
"quantity": 0,
"quantity_committed": 0,
"serial_numbers": [
null
]
}
],
"name": "Medium Blue T-Shirt",
"reference_id": "TShirtBlueM",
"sku": "TShirtBlueM"
}
]
}
],
"id": 0,
"measurements": {
"depth_in": 0.1,
"length_in": 0.1,
"total_weight_oz": 0.1,
"width_in": 0.1
},
"type": "Box or pallet"
}
],
"measurements": {
"depth_in": 0.1,
"length_in": 0.1,
"total_weight_oz": 0.1,
"width_in": 0.1
},
"type": "Box or pallet"
}
],
"products": [
{
"id": 0,
"inventory_items": [
{
"expiration_date": "2019-08-24T14:15:22Z",
"id": 0,
"is_dangerous_goods": true,
"lot": "22222",
"name": "Medium Blue T-Shirt",
"quantity": 0,
"quantity_committed": 0,
"serial_numbers": [
"string"
]
}
],
"name": "Medium Blue T-Shirt",
"reference_id": "TShirtBlueM",
"sku": "TShirtBlueM"
}
],
"recipient": {
"address": {
"address1": "100 Nowhere Blvd",
"address2": "Suite 100",
"city": "Gotham City",
"company_name": "Wayne Enterprises",
"country": "US",
"state": "NJ",
"zip_code": "07093"
},
"email": "[email protected]",
"full_name": "John Doe",
"name": "John Doe",
"phone_number": "555-555-5555"
},
"reference_id": "string",
"require_signature": true,
"ship_option": "Standard",
"status": "None",
"status_details": [
{
"description": "string",
"exception_fulfillment_center_id": 0,
"extra_information": {
"validation_messages": [
"string"
]
},
"id": 0,
"inventory_id": 0,
"name": "string"
}
],
"tracking": {
"bol": "string",
"carrier": "USPS",
"carrier_service": "Priority",
"pro_number": "string",
"scac": "string",
"shipping_date": "2019-08-24T14:15:22Z",
"tracking_number": "860C8CDC8F0B4FC7AB69AC86C20539EC",
"tracking_url": "https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"
}
}
],
"shipping_method": "Free 2-day Shipping",
"shipping_terms": {
"carrier_type": "Parcel",
"payment_term": "Collect"
},
"status": "Processing",
"tags": [
{
"name": "Handling instructions",
"value": "Fragile"
}
],
"type": "DTC"
},
"order_id": 0,
"status": "Success"
}