Modify a single product | ShipBob Developer API

curl -X PUT https://gateway-dev.shipbob.dev/1.0/product/1 \
     -H "shipbob_channel_id: 1" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Medium Blue T-Shirt",
  "barcode": "123456789012",
  "gtin": "012345678905",
  "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:22+00:00",
  "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"
}

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Path parameters

productIdintegerRequired

Unique identifier of the product to modify

Request

Updated fields to the product

namestringRequired>=1 character

The name of the product

barcodestring or nullOptional

Barcode for the product

gtinstring or nullOptional

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

skustring or nullOptional

The stock keeping unit of the product

unit_pricedouble or nullOptional

The price of one unit

upcstring or nullOptional

Universal Product Code - Unique external identifier

Response

Success

barcodestring or null

Barcode for the product

bundle_root_informationobject

channelobject

Information about a store channel

created_datedatetime

Date the product was created

fulfillable_inventory_itemslist of objects or null

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

fulfillable_quantity_by_fulfillment_centerlist of objects or null

Fulfillable quantity of this product broken down by fulfillment center location

gtinstring or null

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

idinteger

Unique identifier of the product

namestring or null

The name of the product

reference_idstring or null

Unique reference identifier of the product

skustring or null

Stock keeping unit for the product

total_committed_quantityinteger

Total committed quantity of this product

total_fulfillable_quantityinteger

Total fulfillable quantity of this product

total_onhand_quantityinteger

Total on hand quantity of this product

unit_pricedouble or null

The price of one unit

upcstring or null

Universal Product Code - Unique external identifier

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Request

Response

Errors