API documentation for managing products through the ShipBob product catalog.
This documentation provides an overview and API request examples for creating, retrieving, and modifying products through the ShipBob product catalog.
All requests should be directed to the following base URL:
POST /product
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.
POST /product
PATCH /product/{product-id}
GET /product
Field | Type | Description |
---|---|---|
name | string | Name of the product |
type_id | int | Regular Product (1) or Bundle (2) |
taxonomy_id | int | Product category ID |
Field | Type | Description |
---|---|---|
name | string | Variant name (should match product name for non-varying products) |
status_id | int | Active (1) or Inactive (2) |
sku | string | Unique SKU for the variant |
barcode | string | Barcode for scanning |
packaging_requirement_id | int | Packaging requirement |
packaging_material_type_id | int | Packaging material |
is_digital | boolean | True for digital items |
customs | object | Customs details for international shipping |
ID | Name |
---|---|
1 | No Requirements |
2 | Fragile |
7 | Is Apparel |
ID | Name |
---|---|
1 | Box |
2 | Bubble Mailer |
10 | Custom Poly Mailer |
Taxonomy values can be found using the lookup tool (requires login): ShipBob Taxonomy Lookup