Skip to main content
PUT
/
1.0
/
product
/
{productId}
Modify a single product
curl --request PUT \
  --url https://api.shipbob.com/1.0/product/{productId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'shipbob_channel_id: <shipbob_channel_id>' \
  --data '
{
  "barcode": "123456789012",
  "gtin": "012345678905",
  "name": "Medium Blue T-Shirt",
  "sku": "TShirtBlueM",
  "unit_price": 20.32,
  "upc": "012345678912"
}
'
{
  "barcode": "123456789012",
  "bundle_root_information": {
    "id": 0,
    "name": "string"
  },
  "channel": {
    "id": 0,
    "name": "House of Slippers"
  },
  "created_date": "2019-08-24T14:15:22Z",
  "fulfillable_inventory_items": [
    {
      "id": 0,
      "name": "Medium Blue T-Shirt",
      "quantity": 0
    }
  ],
  "fulfillable_quantity_by_fulfillment_center": [
    {
      "committed_quantity": 0,
      "fulfillable_quantity": 0,
      "id": 0,
      "name": "Cicero",
      "onhand_quantity": 0
    }
  ],
  "gtin": "012345678905",
  "id": 0,
  "name": "Medium Blue T-Shirt",
  "reference_id": "TShirtBlueM",
  "sku": "TShirtBlueM",
  "total_committed_quantity": 0,
  "total_fulfillable_quantity": 0,
  "total_onhand_quantity": 0,
  "unit_price": 20.32,
  "upc": "012345678912"
}
API 1.0 is deprecated and will be sunset on July 31, 2026. Please migrate to the latest API version. See our Versioning Policy for details.

Authorizations

Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Headers

shipbob_channel_id
string<int32>
required

Channel Id for Operation

Path Parameters

productId
string<int32>
required

Unique identifier of the product to modify

Body

application/json

Updated fields to the product

Updates to an existing product product

name
string
required

The name of the product

Minimum string length: 1
Example:

"Medium Blue T-Shirt"

barcode
string | null

Barcode for the product

Example:

"123456789012"

gtin
string | null

Global Trade Item Number - unique and internationally recognized identifier assigned to item by company GS1.

Example:

"012345678905"

sku
string | null

The stock keeping unit of the product

Example:

"TShirtBlueM"

unit_price
number<double> | null

The price of one unit

Example:

20.32

upc
string | null

Universal Product Code - Unique external identifier

Example:

"012345678912"

Response

Success

barcode
string | null

Barcode for the product

Example:

"123456789012"

bundle_root_information
object
channel
object

Information about a store channel

created_date
string<date-time>

Date the product was created

fulfillable_inventory_items
object[] | null

The inventory that this product will resolve to when packing a shipment

fulfillable_quantity_by_fulfillment_center
object[] | null

Fulfillable quantity of this product broken down by fulfillment center location

gtin
string | null

Global Trade Item Number - unique and internationally recognized identifier assigned to item by company GS1.

Example:

"012345678905"

id
integer<int32>

Unique identifier of the product

name
string | null

The name of the product

Example:

"Medium Blue T-Shirt"

reference_id
string | null

Unique reference identifier of the product

Example:

"TShirtBlueM"

sku
string | null

Stock keeping unit for the product

Example:

"TShirtBlueM"

total_committed_quantity
integer<int32>

Total committed quantity of this product

total_fulfillable_quantity
integer<int32>

Total fulfillable quantity of this product

total_onhand_quantity
integer<int32>

Total on hand quantity of this product

unit_price
number<double> | null

The price of one unit

Example:

20.32

upc
string | null

Universal Product Code - Unique external identifier

Example:

"012345678912"