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
Orders
Cancel one Shipment by Order Id and Shipment Id
Orders
Cancel one Shipment by Order Id and Shipment Id
POST
/
order
/
{orderId}
/
shipment
/
{shipmentId}
/
cancel
curl --request POST \
--url https://api.shipbob.com/2.0/order/{orderId}/shipment/{shipmentId}/cancel \
--header 'Authorization: Bearer <token>'
{
"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": [
"string"
]
}
],
"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"
}
}
Authorizations
Authentication using Personal Access Token (PAT) token
Headers
Channel Id for Operation
Response
200
application/json
Success
Information about a shipment
Information about a shipment
Information about a shipment
Was this page helpful?
Previous
Estimate Fulfillment Cost For OrderThis endpoint will provide, where possible, an estimate of pricing and fulfillment center assignment of a potential standard (direct to consumer) order. Keep in mind that there are ways for the merchant to change FC assignment or product configuration after order creation that could invalidate this estimate. Estimates cannot be returned for items that are unknown, out of stock, or too large for fulfillment using standard box sizes. Additional services such as high-pick fees, shipping insurance, auto-splitting or auto-adding items to orders, and signature required are not included in this estimate.
Next
curl --request POST \
--url https://api.shipbob.com/2.0/order/{orderId}/shipment/{shipmentId}/cancel \
--header 'Authorization: Bearer <token>'
{
"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": [
"string"
]
}
],
"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"
}
}