​
Overview

This documentation provides an overview and API request examples for creating, retrieving, and modifying products through the ShipBob product catalog.

​
Base URL

All requests should be directed to the following base URL: 
https://api.shipbob.com/2.0/

​
Creating a Product

​
Endpoint: POST /product

{
  "name": "Saturn Shirt",
  "type_id": 1,
  "taxonomy_id": 266,
  "variants": [
    {
      "name": "Saturn Shirt",
      "sku": "saturn-shirt",
      "packaging_requirement_id": 7,
      "packaging_material_type_id": 10,
      "barcode": "06547321109",
      "upc": "9011233234",
      "gtin": "7334568872",
      "customs": {
        "country_code_of_origin": "US",
        "hs_tariff_code": "6103.22.00",
        "value": "15",
        "description": "t-shirt"
      }
    }
  ]
}

​
Notes:

  • Type ID: 1 indicates a regular product (not a bundle).
  • Taxonomy ID: Categorizes products in the UI. (266 represents “Clothing”).
  • Packaging Requirement ID: Determines special handling (e.g., 7 for apparel).
  • Customs Information: Required for international shipments.

​
Creating a Varying Product

​
Endpoint: POST /product

{
  "name": "Space Shirts",
  "type_id": 1,
  "taxonomy_id": 266,
  "variants": [
    {
      "name": "Saturn Shirt Small",
      "sku": "saturn-shirt-s",
      "packaging_requirement_id": 7,
      "packaging_material_type_id": 10,
      "barcode": "06547321110",
      "customs": {
        "country_code_of_origin": "US",
        "hs_tariff_code": "6103.22",
        "value": "15",
        "description": "t-shirt"
      }
    }
  ]
}

​
Updating Existing Products

​
Endpoint: PATCH /product/{product-id}

{
  "variants": [
    {
      "id": 6,
      "barcode": "4324323212",
      "packaging_material_type_id": 6
    },
    {
      "id": 8,
      "name": "Jupiter Shirt (Small)"
    }
  ]
}

​
Retrieving Products

​
Endpoint: GET /product

/product?productTypeId=1&variantStatus=1&hasDigitalVariants=false

​
Product Attributes

​
Product-Level Attributes

FieldTypeDescription
namestringName of the product
type_idintRegular Product (1) or Bundle (2)
taxonomy_idintProduct category ID

​
Variant-Level Attributes

FieldTypeDescription
namestringVariant name (should match product name for non-varying products)
status_idintActive (1) or Inactive (2)
skustringUnique SKU for the variant
barcodestringBarcode for scanning
packaging_requirement_idintPackaging requirement
packaging_material_type_idintPackaging material
is_digitalbooleanTrue for digital items
customsobjectCustoms details for international shipping

​
Packaging Requirements

IDName
1No Requirements
2Fragile
7Is Apparel

​
Packaging Material Types

IDName
1Box
2Bubble Mailer
10Custom Poly Mailer

​
Taxonomy Values

Taxonomy values can be found using the lookup tool (requires login): ShipBob Taxonomy Lookup