ShipBob Component

Shipbob offers an end to end fulfillment services for Ecommerce vendors.

Component key: shipbob

Description

Shipbob offers an end to end fulfillment services for Ecommerce vendors.

Use the Shipbob component to manage orders, shipments, labels, and more.

Connections

ShipBob Personal Access Token

If you're building a single-user custom integration, you can use the Personal Access Token (PAT) method. This generates a ready-to-use bearer-type token with full access to the merchant's account.

You can generate credentials from the ShipBob dashboard.

For Production Environment, click here. For Sandbox Environment, click here.

When you request your first PAT, ShipBob automatically generates an application (called "SMA" or single-merchant application) and channel to house all your future PATs. You can request as many as you like, and revoke them at any time.

NOTE: These tokens do not expire, so be extremely cautious when sharing them.

Your PAT should automatically have read and write access to the entire ShipBob account.

To use your PAT, just provide the token as an Authorization header formatted like this:

bearer [your_api_token]

First you should use your PAT to hit the GET Channel endpoint, so you can use your channel ID in the headers of subsequent API calls. Your response will look like this:

Input	Notes
Personal Access Token string / Required apiToken	Log in to https://web.shipbob.com/app/merchant/#/Integrations/token-management to fetch a personal access token for development purposes

Triggers

Webhook

Receive and validate webhook requests from ShipBob for webhooks you configure. | key: webhook

Event Topic Subscription

Get notified when a specific event occurs | key: eventTopicSubscription

Input	Default	Notes
Connection connection / Required connectionInput
Overwrite Webhook Settings boolean overwriteWebhookSettings	false	True to delete existing webhook settings pointing to this flow's URL and create new ones
Topics to Subscribe string / Required Value List topicsToSubscribe		Topics to subscribe to
Version string / Required version	1.0	The version of the ShipBob API to use

Data Sources

Fetch Fulfillment Centers

Fetch an array of Fulfillment Centers | key: fulfillmentCenters | type: picklist

Input	Default	Notes
Connection connection / Required connection
Version string / Required version	1.0	The version of the ShipBob API to use

Example Payload for Fetch Fulfillment Centers

{
  "result": [
    {
      "label": "Cicero (IL)",
      "key": "0"
    },
    {
      "label": "5900 W Ogden Ave Suite 100 / USA, IL, Cicero",
      "key": "47012"
    }
  ]
}

Fetch Inventory

Fetch an array of Inventories | key: inventory | type: picklist

Input	Default	Notes
Connection connection / Required connection
Version string / Required version	1.0	The version of the ShipBob API to use

Example Payload for Fetch Inventory

{
  "result": [
    {
      "label": "TShirtBlueM",
      "key": "0"
    },
    {
      "label": "Medium Blue T-Shirt",
      "key": "47012"
    }
  ]
}

Fetch Locations

Fetch an array of locations | key: locations | type: picklist

Input	Default	Notes
Connection connection / Required connection
Version string / Required version	1.0	The version of the ShipBob API to use

Example Payload for Fetch Locations

{
  "result": [
    {
      "label": "Cicero (IL)",
      "key": "0"
    },
    {
      "label": "Other",
      "key": "47012"
    }
  ]
}

Fetch Products

Fetch an array of Products | key: products | type: picklist

Input	Default	Notes
Connection connection / Required connection
Version string / Required version	1.0	The version of the ShipBob API to use

Example Payload for Fetch Products

{
  "result": [
    {
      "label": "TShirtBlueM",
      "key": "0"
    },
    {
      "label": "Other",
      "key": "47012"
    }
  ]
}

Actions

Cancel Order

Cancel an existing Order by Order ID | key: cancelOrder

Input	Default	Notes
Connection connection / Required connection
Order ID string / Required orderId		The order ID to retrieve
ShipBob Channel ID string / Required shipbob_channel_id		Channel Id for Operation
Version string / Required version	1.0	The version of the ShipBob API to use

Cancel Shipments

Cancel multiple Shipments by Shipment ID | key: cancelShipment

Input	Default	Notes
Connection connection / Required connection
ShipBob Channel ID string / Required shipbob_channel_id		Channel Id for Operation
Shipment IDs string Value List shipment_ids	000xxx	Shipment IDs to cancel
Version string / Required version	1.0	The version of the ShipBob API to use

Cancel Warehouse Receiving Order

Cancels a Warehouse Receiving Order by Order ID | key: cancelWarehouseReceivingOrder

Input	Default	Notes
Connection connection / Required connectionInput
Receiving ID string / Required receivingId		Id of the receiving order
Version string / Required version	2.0	The version of the ShipBob API to use

Create Order

Create a new Order | key: createOrder

Input	Default	Notes
Connection connection / Required connection
Financials code financials		Sum of all line item prices, discounts, and taxes in USD
Gift Message string gift_message		Gift message associated with the order
Location ID string location_id		Desired Fulfillment Center Location ID. If not specified, ShipBob will determine the location that fulfills this order.
Order Number string order_number		User friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId will be used
Products code / Required products		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 string purchase_date		Date this order was purchase by the end user
Recipient code / Required recipient		Information about the recipient of an order
Reference ID string / Required reference_id		Unique and immutable order identifier from your upstream system
Retailer Program Data code retailer_program_data		Contains shipping properties that need to be used for fulfilling an order.
ShipBob Channel ID string / Required shipbob_channel_id		Channel Id for Operation
Shipping Method string / Required shipping_method		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 code shipping_terms		Contains shipping properties that need to be used for fulfilling an order.
Tags string Key Value List tags		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 string type		Defaults to Direct to Consumer (DTC) if not provided. Note: B2B is not supported at this time. One of DTC, B2B, DropShip
Version string / Required version	1.0	The version of the ShipBob API to use

Create Warehouse Receiving Order

Create a new Warehouse Receiving Order | key: createWarehouseReceivingOrder

Input	Default	Notes
Box Packaging Type string / Required box_packaging_type
Boxes code / Required boxes		Box shipments to be added to this receiving order
Connection connection / Required connectionInput
Expected Arrival Date string / Required expected_arrival_date		Expected arrival date of all the box shipments in this receiving order
Fulfillment Center code / Required fulfillment_center		Model containing information that assigns a receiving order to a fulfillment center. If the fulfillment center provided is in a receiving hub region, then the response will be the receiving hub location.
Package Type string / Required package_type
Purchase Order Number string purchase_order_number		Purchase order number for this receiving order
Version string / Required version	2.0	The version of the ShipBob API to use

Create Webhook

Creates a new Webhook | key: createWebhook

Input	Default	Notes
Connection connection / Required connectionInput
ShipBob Channel ID string shipbob_channel_id		Channel Id for Operation
Subscription URL string / Required subscription_url		URL we will call when an event matching the subscription topic is raised. Must have ssl enabled (https) and accept POST requests with content type of application/json
Topic string / Required Topic		Topic of the webhooks requested
Version string / Required version	1.0	The version of the ShipBob API to use

Delete All Instanced Webhooks

Delete all webhooks that point to a flow in this instance | key: deleteAllWebhooks

Input	Default	Notes
Connection connection / Required connectionInput
Version string / Required version	1.0	The version of the ShipBob API to use

Delete Webhook

Delete a Webhook by Webhook ID | key: deleteWebhook

Input	Default	Notes
Connection connection / Required connectionInput
Version string / Required version	1.0	The version of the ShipBob API to use
Webhook ID string / Required webhookId		Id of the webhook

Get a list of Inventory Items by Product ID

Retrieve a list of Inventory Items by their Product ID | key: listByProductId

Input	Default	Notes
Connection connection / Required connection
Product ID string / Required productId		The product ID to retrieve
ShipBob Channel ID string shipbob_channel_id		Channel Id for Operation
Version string / Required version	1.0	The version of the ShipBob API to use

Example Payload for Get a list of Inventory Items by Product ID

{
  "data": [
    {
      "inventoryId": 0,
      "name": "Medium Blue T-Shirt",
      "isDigital": true,
      "isCasePick": true,
      "isLot": true,
      "dimensions": {
        "weight": 0,
        "length": 0,
        "width": 0,
        "depth": 0
      },
      "totalFulfillableQuantity": 0,
      "totalOnHandQuantity": 0,
      "totalCommitedQuantity": 0,
      "totalSellableQuantity": 0,
      "totalAwaitingQuantity": 0,
      "totalExceptionQuantity": 0,
      "totalInternalTransferQuantity": 0,
      "totalBackorderedQuantity": 0,
      "isActive": true,
      "fulfillableQuantityByFulfillmentCenter": [
        {
          "fulfillmentCenterId": 0,
          "name": "Cicero",
          "fulfillableQuantity": 0,
          "onHandQuantity": 0,
          "committedQuantity": 0,
          "awaitingQuantity": 0,
          "internalTransferQuantity": 0
        }
      ],
      "fulfillableQuantityByLot": [
        {
          "lotNumber": "1234",
          "expirationDate": "2019-08-24T14:15:22Z",
          "fulfillableQuantity": 0,
          "onHandQuantity": 0,
          "committedQuantity": 0,
          "awaitingQuantity": 0,
          "internalTransferQuantity": 0,
          "fulfillableQuantityByFulfillmentCenter": [
            {
              "fulfillmentCenterId": 0,
              "name": "Cicero",
              "fulfillableQuantity": 0,
              "onHandQuantity": 0,
              "committedQuantity": 0,
              "awaitingQuantity": 0,
              "internalTransferQuantity": 0
            }
          ]
        }
      ],
      "packagingAttribute": "None"
    }
  ]
}

Get All Shipments for Order

Retrieve all Shipments on an Order by Order ID | key: getAllShipmentsForOrder

Input	Default	Notes
Connection connection / Required connection
Order ID string / Required orderId		The order ID to retrieve
ShipBob Channel ID string shipbob_channel_id		Channel Id for Operation
Version string / Required version	1.0	The version of the ShipBob API to use

Get Inventory Item

Get single inventory item by Inventory ID | key: getInventoryItem

Input	Default	Notes
Connection connection / Required connection
Inventory ID string / Required inventoryId		The inventory ID to retrieve
ShipBob Channel ID string shipbob_channel_id		Channel Id for Operation
Version string / Required version	1.0	The version of the ShipBob API to use

Example Payload for Get Inventory Item

{
  "data": {
    "inventoryId": 0,
    "name": "Medium Blue T-Shirt",
    "isDigital": true,
    "isCasePick": true,
    "isLot": true,
    "dimensions": {
      "weight": 0,
      "length": 0,
      "width": 0,
      "depth": 0
    },
    "totalFulfillableQuantity": 0,
    "totalOnHandQuantity": 0,
    "totalCommitedQuantity": 0,
    "totalSellableQuantity": 0,
    "totalAwaitingQuantity": 0,
    "totalExceptionQuantity": 0,
    "totalInternalTransferQuantity": 0,
    "totalBackorderedQuantity": 0,
    "isActive": true,
    "fulfillableQuantityByFulfillmentCenter": [
      {
        "fulfillmentCenterId": 0,
        "name": "Cicero",
        "fulfillableQuantity": 0,
        "onHandQuantity": 0,
        "committedQuantity": 0,
        "awaitingQuantity": 0,
        "internalTransferQuantity": 0
      }
    ],
    "fulfillableQuantityByLot": [
      {
        "lotNumber": "1234",
        "expirationDate": "2019-08-24T14:15:22Z",
        "fulfillableQuantity": 0,
        "onHandQuantity": 0,
        "committedQuantity": 0,
        "awaitingQuantity": 0,
        "internalTransferQuantity": 0,
        "fulfillableQuantityByFulfillmentCenter": [
          {
            "fulfillmentCenterId": 0,
            "name": "Cicero",
            "fulfillableQuantity": 0,
            "onHandQuantity": 0,
            "committedQuantity": 0,
            "awaitingQuantity": 0,
            "internalTransferQuantity": 0
          }
        ]
      }
    ],
    "packagingAttribute": "None"
  }
}

Get Logs for Shipment

Retrieve logs for a Shipment by Shipment ID | key: getLogsShipment

Input	Default	Notes
Connection connection / Required connection
ShipBob Channel ID string shipbob_channel_id		Channel Id for Operation
Shipment ID string / Required shipmentId		The shipment ID to retrieve
Version string / Required version	1.0	The version of the ShipBob API to use

Get Multiple Products

Retrieve a list of several Products | key: listProduct

Input	Default	Notes
Active Status string ActiveStatus
Bundle Status string BundleStatus
Connection connection / Required connection
Order IDs string IDs		Comma separated list of product ids to filter by
Limit string Limit		Amount of orders per page to request
Page string Page		Page of orders to get
Reference IDs string ReferenceIds		Reference ids to filter by, comma separated
Search string Search		Search is available for 2 fields of the inventory record related to the product: Inventory ID and Name
ShipBob Channel ID string shipbob_channel_id		Channel Id for Operation
Version string / Required version	1.0	The version of the ShipBob API to use

Example Payload for Get Multiple Products

{
  "data": [
    {
      "id": 0,
      "reference_id": "TShirtBlueM",
      "bundle_root_information": {},
      "created_date": "2019-08-24T14:15:22Z",
      "channel": {},
      "sku": "TShirtBlueM",
      "name": "Medium Blue T-Shirt",
      "barcode": "123456789012",
      "gtin": "012345678905",
      "upc": "012345678912",
      "unit_price": 20.32,
      "total_fulfillable_quantity": 0,
      "total_onhand_quantity": 0,
      "total_committed_quantity": 0,
      "fulfillable_inventory_items": [],
      "fulfillable_quantity_by_fulfillment_center": []
    }
  ]
}

Get Order

Retrieve an order by Order ID | key: getOrder

Input	Default	Notes
Connection connection / Required connection
Order ID string / Required orderId		The order ID to retrieve
ShipBob Channel ID string shipbob_channel_id		Channel Id for Operation
Version string / Required version	1.0	The version of the ShipBob API to use

Get Shipment

Retrieve a Shipment by Shipment ID | key: getShipment

Input	Default	Notes
Connection connection / Required connection
ShipBob Channel ID string shipbob_channel_id		Channel Id for Operation
Shipment ID string / Required shipmentId		The shipment ID to retrieve
Version string / Required version	1.0	The version of the ShipBob API to use

Get Single Product

Retrieve a single product by Product ID | key: getProduct

Input	Default	Notes
Connection connection / Required connection
Product ID string / Required productId		The product ID to retrieve
ShipBob Channel ID string shipbob_channel_id		Channel Id for Operation
Version string / Required version	1.0	The version of the ShipBob API to use

Example Payload for Get Single Product

{
  "data": {
    "id": 0,
    "reference_id": "TShirtBlueM",
    "bundle_root_information": {
      "id": 0,
      "name": "string"
    },
    "created_date": "2019-08-24T14:15:22Z",
    "channel": {
      "id": 0,
      "name": "House of Slippers"
    },
    "sku": "TShirtBlueM",
    "name": "Medium Blue T-Shirt",
    "barcode": "123456789012",
    "gtin": "012345678905",
    "upc": "012345678912",
    "unit_price": 20.32,
    "total_fulfillable_quantity": 0,
    "total_onhand_quantity": 0,
    "total_committed_quantity": 0,
    "fulfillable_inventory_items": [
      {}
    ],
    "fulfillable_quantity_by_fulfillment_center": [
      {}
    ]
  }
}

Get Warehouse Receiving Order Box Labels

Retrieves Receiving Order Box Labels by Order ID | key: getWarehouseReceivingOrderBoxLabels

Input	Default	Notes
Connection connection / Required connectionInput
Receiving ID string / Required receivingId		Id of the receiving order
Version string / Required version	2.0	The version of the ShipBob API to use

Get Warehouse Receiving Orders

Receive a Warehouse Receiving Order by ID | key: getWarehouseReceivingOrders

Input	Default	Notes
Connection connection / Required connectionInput
Receiving ID string / Required receivingId		Id of the receiving order
Version string / Required version	2.0	The version of the ShipBob API to use

List Channels

List user-authorized channels info | key: listChannels

Input	Default	Notes
Connection connection / Required connection
Version string / Required version	1.0	The version of the ShipBob API to use

List Fulfillment Centers

Retrieves a list of Fulfillment Centers | key: listFulfillmentCenters

Input	Default	Notes
Connection connection / Required connectionInput
Version string / Required version	1.0	The version of the ShipBob API to use

List Inventory Items

Retrieve a list of Inventory Items | key: listInventoryItems

Input	Default	Notes
Connection connection / Required connection
Order IDs string IDs		Order ids to filter by, comma separated
IsActive boolean IsActive	false	Whether the inventory should be active or not
IsDigital boolean IsDigital	false	Whether the inventory is digital or not
Limit string Limit		Amount of orders per page to request
Location Type string LocationType		LocationType is valid for hub, spoke, or lts. LocationType will default to all locations.
Page string Page		Page of orders to get
Search string Search		Search is available for 2 fields of the inventory record related to the product: Inventory ID and Name
ShipBob Channel ID string shipbob_channel_id		Channel Id for Operation
Sort string Sort		Sort will default to ascending order for each field. To sort in descending order please pass a ' - ' in front of the field name. For example, Sort=-onHand,name will sort by onHand descending
Version string / Required version	1.0	The version of the ShipBob API to use

Example Payload for List Inventory Items

{
  "data": [
    {
      "inventoryId": 0,
      "name": "Medium Blue T-Shirt",
      "isDigital": true,
      "isCasePick": true,
      "isLot": true,
      "dimensions": {
        "weight": 0,
        "length": 0,
        "width": 0,
        "depth": 0
      },
      "totalFulfillableQuantity": 0,
      "totalOnHandQuantity": 0,
      "totalCommitedQuantity": 0,
      "totalSellableQuantity": 0,
      "totalAwaitingQuantity": 0,
      "totalExceptionQuantity": 0,
      "totalInternalTransferQuantity": 0,
      "totalBackorderedQuantity": 0,
      "isActive": true,
      "fulfillableQuantityByFulfillmentCenter": [
        {
          "fulfillmentCenterId": 0,
          "name": "Cicero",
          "fulfillableQuantity": 0,
          "onHandQuantity": 0,
          "committedQuantity": 0,
          "awaitingQuantity": 0,
          "internalTransferQuantity": 0
        }
      ],
      "fulfillableQuantityByLot": [
        {
          "lotNumber": "1234",
          "expirationDate": "2019-08-24T14:15:22Z",
          "fulfillableQuantity": 0,
          "onHandQuantity": 0,
          "committedQuantity": 0,
          "awaitingQuantity": 0,
          "internalTransferQuantity": 0,
          "fulfillableQuantityByFulfillmentCenter": [
            {
              "fulfillmentCenterId": 0,
              "name": "Cicero",
              "fulfillableQuantity": 0,
              "onHandQuantity": 0,
              "committedQuantity": 0,
              "awaitingQuantity": 0,
              "internalTransferQuantity": 0
            }
          ]
        }
      ],
      "packagingAttribute": "None"
    }
  ]
}

List Locations

Receives a list of the physical locations across a fulfillment network | key: listLocations

Input	Default	Notes
Access Granted boolean AccessGranted	false	Return all the access granted locations
Connection connection / Required connectionInput
Include Inactive boolean IncludeInactive	false	Whether the inactive locations should be included or not
Receiving Enabled boolean ReceivingEnabled	false	Return all the receiving enabled locations
Version string / Required version	1.0	The version of the ShipBob API to use

List Orders

Retrieve all Orders | key: listOrders

Input	Default	Notes
Connection connection / Required connectionInput
Delivery En Date string DeliveryEndDate		End date to filter orders with delivery date earlier than the supplied date. Will only return orders that have tracking information
Delivery Start Date string DeliveryStartDate		Start date to filter orders with delivery date later than the supplied date. Will only return orders that have tracking information
End Date string EndDate		End date to filter orders inserted earlier than
Fulfillment End Date string FulfillmentEndDate		End date to filter orders fulfillment date later than the supplied date. Will only return orders that have tracking information
Fulfillment Start Date string FulfillmentStartDate		Start date to filter orders with fulfillment date later than the supplied date. Will only return orders that have tracking information
Has Tracking boolean HasTracking	false	Has any portion of this order been assigned a tracking number
Order IDs string IDs		Order ids to filter by, comma separated
Is Tracking Uploaded boolean IsTrackingUploaded	false	Filter orders that their tracking information was fully uploaded
Last Tracking Update End Date string LastTrackingUpdateEndDate		End date to filter orders updated later than the supplied date. Will only return orders that have tracking information
Last Tracking Update Start Date string LastTrackingUpdateStartDate		Start date to filter orders with tracking updates later than the supplied date. Will only return orders that have tracking information
Last Update End Date string LastUpdateEndDate		End date to filter orders updated earlier than
Last Update Start Date string LastUpdateStartDate		Start date to filter orders updated later than
Limit string Limit		Amount of orders per page to request
Page string Page		Page of orders to get
Reference IDs string ReferenceIds		Reference ids to filter by, comma separated
ShipBob Channel ID string shipbob_channel_id		Channel Id for Operation
Sort Order string SortOrder		Order to sort results in. One Of Newest, Oldest
Start Date string StartDate		Start date to filter orders inserted later than
Version string / Required version	1.0	The version of the ShipBob API to use

List Warehouse Receiving Orders

Retrieve all Warehouse Receiving Orders | key: listWarehouseReceivingOrders

Input	Default	Notes
Connection connection / Required connectionInput
Fulfillment Center IDs string Value List FulfillmentCenterIds	000xxx	Comma separated list of WRO fulfillment center IDs to filter by
Order IDs string IDs		Order ids to filter by, comma separated
Insert End Date string InsertEndDate		Latest date that a WRO was created
Insert Start Date string InsertStartDate		Earliest date that a WRO was created
Limit string Limit		Number of WROs per page to request
Page string Page		Page of WROs to get
Purchase Order Numbers string Value List PurchaseOrderNumbers	000xxx	Comma separated list of WRO PO numbers to filter by
Statuses string Value List Statuses	000xxx	Items Enum: 'Awaiting' 'Processing' 'Completed' 'Cancelled' 'Incomplete' 'Arrived' 'PartiallyArrived' Comma separated list of WRO statuses to filter by
Version string / Required version	2.0	The version of the ShipBob API to use

List Webhooks

Get a list of active Webhooks | key: listWebhooks

Input	Default	Notes
Connection connection / Required connectionInput
Limit string Limit		Amount of Webhooks per page to request
Page string Page		Page of Webhooks to get
Topic string Topic		Topic of the webhooks requested
Version string / Required version	1.0	The version of the ShipBob API to use

Raw Request

Send raw HTTP request to ShipBob | key: rawRequest

Input	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt. Specify 0 for no retries.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required url		This is the URL to call.	Input the path only (/orders), The base URL is already included (https://api.shipbob.com/1.0). For example, to connect to https://api.shipbob.com/1.0/orders, only /orders is entered in this field. e.g. /orders
Use Exponential Backoff boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.
Version string / Required version	1.0	The version of the ShipBob API to use

Update Product

Update information on a single Product | key: updateProduct

Input	Default	Notes
Barcode string barcode		Barcode for the product
Connection connection / Required connection
GTIN string gtin		Global Trade Item Number - unique and internationally recognized identifier assigned to item by company GS1.
Name string / Required name		The name of the product
Product ID string / Required productId		The product ID to retrieve
ShipBob Channel ID string / Required shipbob_channel_id		Channel Id for Operation
Sku string sku		The stock keeping unit of the product
Unit Price string unit_price		The price of one unit
UPC string upc		Universal Product Code - Unique external identifier
Version string / Required version	1.0	The version of the ShipBob API to use

Example Payload for Update Product

{
  "data": {
    "id": 0,
    "reference_id": "TShirtBlueM",
    "bundle_root_information": {
      "id": 0,
      "name": "string"
    },
    "created_date": "2019-08-24T14:15:22Z",
    "channel": {
      "id": 0,
      "name": "House of Slippers"
    },
    "sku": "TShirtBlueM",
    "name": "Medium Blue T-Shirt",
    "barcode": "123456789012",
    "gtin": "012345678905",
    "upc": "012345678912",
    "unit_price": 20.32,
    "total_fulfillable_quantity": 0,
    "total_onhand_quantity": 0,
    "total_committed_quantity": 0,
    "fulfillable_inventory_items": [
      {}
    ],
    "fulfillable_quantity_by_fulfillment_center": [
      {}
    ]
  }
}

Shipbob offers an end to end fulfillment services for Ecommerce vendors.

Description​

Connections​

ShipBob Personal Access Token​

Triggers​

Webhook​

Event Topic Subscription​

Data Sources​

Fetch Fulfillment Centers​

Fetch Inventory​

Fetch Locations​

Fetch Products​

Actions​

Cancel Order​

Cancel Shipments​

Cancel Warehouse Receiving Order​

Create Order​

Create Warehouse Receiving Order​

Create Webhook​

Delete All Instanced Webhooks​

Delete Webhook​

Get a list of Inventory Items by Product ID​

Get All Shipments for Order​

Get Inventory Item​

Get Logs for Shipment​

Get Multiple Products​

Get Order​

Get Shipment​

Get Single Product​

Get Warehouse Receiving Order Box Labels​

Get Warehouse Receiving Orders​

List Channels​

List Fulfillment Centers​

List Inventory Items​

List Locations​

List Orders​

List Warehouse Receiving Orders​

List Webhooks​

Raw Request​

Update Product​

Description

Connections

ShipBob Personal Access Token

Triggers

Webhook

Event Topic Subscription

Data Sources

Fetch Fulfillment Centers

Fetch Inventory

Fetch Locations

Fetch Products

Actions

Cancel Order

Cancel Shipments

Cancel Warehouse Receiving Order

Create Order

Create Warehouse Receiving Order

Create Webhook

Delete All Instanced Webhooks

Delete Webhook

Get a list of Inventory Items by Product ID

Get All Shipments for Order

Get Inventory Item

Get Logs for Shipment

Get Multiple Products

Get Order

Get Shipment

Get Single Product

Get Warehouse Receiving Order Box Labels

Get Warehouse Receiving Orders

List Channels

List Fulfillment Centers

List Inventory Items

List Locations

List Orders

List Warehouse Receiving Orders

List Webhooks

Raw Request

Update Product