For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DocumentationAPI Reference
DocumentationAPI Reference
  • API Reference
      • POSTMerge Variants
      • GETGet Product
      • DELDelete Product Bundle
      • PATCHUpdate Product
      • GETGet Taxonomies
      • GETGet Products
      • POSTCreate Product
      • GETGet Product Variants
      • POSTAdd Product Variants
      • PATCHUpdate Product Variants
      • POSTMove Variants to New Product
      • GETGet Packaging Requirement
      • GETGet Taxonomy by ID
      • GETGet Taxonomy Parent
      • POSTMove Variants Between Products
      • POSTConvert Variant to Bundle
LogoLogo
API ReferenceProducts

Get Products

||View as Markdown|
GET
https://sandbox-api.shipbob.com/2026-01/product
GET
/2026-01/product
$curl -G https://sandbox-api.shipbob.com/2026-01/product \
>     -H "Authorization: Bearer <token>" \
>     -d Search=string \
>     -d SortBy=string \
>     -d SortOrder=string
1{
2  "first": "string",
3  "items": [
4    {
5      "created_on": "2019-08-24T14:15:22+00:00",
6      "id": 0,
7      "name": "string",
8      "taxonomy": {
9        "id": 0,
10        "name": "string",
11        "parent_id": 0,
12        "parent_name": "string",
13        "path": "string"
14      },
15      "type": "string",
16      "updated_on": "2019-08-24T14:15:22+00:00",
17      "user_id": 0,
18      "variants": [
19        {
20          "barcodes": [
21            {
22              "sticker_url": "string",
23              "value": "string"
24            }
25          ],
26          "channel_metadata": [
27            {
28              "channel_id": 0,
29              "channel_name": "string",
30              "currency": "string",
31              "id": 0,
32              "is_inventory_sync_enabled": true,
33              "legacy_product_id": 0,
34              "platform": "string",
35              "platform_identifier": "string",
36              "platform_inventory_item_id": "string",
37              "price": 0.1,
38              "seller_sku": "string"
39            }
40          ],
41          "additional_hazmat_attributes": {
42            "charge_state_percentage": 0.1,
43            "container_metal": true,
44            "container_type": "string",
45            "lithium_battery_packaging": "string",
46            "lithium_battery_type": "string",
47            "magnet": true,
48            "net_volume": 0.1,
49            "net_weight": 0.1
50          },
51          "associated_bundles": [
52            {
53              "product_id": 0,
54              "product_name": "string",
55              "quantity": 0,
56              "variant_id": 0,
57              "variant_sku": "string"
58            }
59          ],
60          "bundle_definition": [
61            {
62              "product_id": 0,
63              "quantity": 0,
64              "variant_id": 0,
65              "variant_name": "string",
66              "variant_sku": "string"
67            }
68          ],
69          "created_on": "2019-08-24T14:15:22+00:00",
70          "customs": {
71            "country_code_of_origin": "string",
72            "currency": "string",
73            "description": "string",
74            "hs_tariff_code": "string",
75            "is321_eligible": true,
76            "value": 0
77          },
78          "dimension": {
79            "height": 0.1,
80            "is_locked": true,
81            "length": 0.1,
82            "source": "string",
83            "unit": "string",
84            "width": 0.1
85          },
86          "fulfillment_settings": {
87            "dangerous_goods": true,
88            "is_bpm_parcel": true,
89            "is_case_pick": true,
90            "msds_url": "string",
91            "requires_prop65": true,
92            "serial_scan": {
93              "exact_character_length": 0,
94              "is_enabled": true,
95              "prefix": "string",
96              "suffix": "string"
97            }
98          },
99          "gtin": "string",
100          "id": 0,
101          "inventory": {
102            "inventory_id": 0,
103            "on_hand_qty": 0
104          },
105          "is_digital": true,
106          "is_image_uploaded": true,
107          "lot_information": {
108            "is_lot": true,
109            "minimum_shelf_life_days": 0
110          },
111          "merge_children": [
112            {
113              "channel_ids": [
114                0
115              ],
116              "completed_at": "2019-08-24T14:15:22+00:00",
117              "inventory_id": 0,
118              "variant_id": 0,
119              "variant_name": "string"
120            }
121          ],
122          "name": "string",
123          "packaging_material_type": {
124            "id": 0,
125            "name": "string"
126          },
127          "packaging_requirement": {
128            "id": 0,
129            "name": "string"
130          },
131          "return_preferences": {
132            "backup_action": {
133              "id": 0,
134              "name": "string"
135            },
136            "instructions": "string",
137            "primary_action": {
138              "id": 0,
139              "name": "string"
140            },
141            "return_to_sender_backup_action": {
142              "id": 0,
143              "name": "string"
144            },
145            "return_to_sender_primary_action": {
146              "id": 0,
147              "name": "string"
148            }
149          },
150          "reviews_pending": [
151            "string"
152          ],
153          "sku": "string",
154          "status": "string",
155          "upc": "string",
156          "updated_on": "2019-08-24T14:15:22+00:00",
157          "weight": {
158            "unit": "string",
159            "weight": 0.1
160          }
161        }
162      ]
163    }
164  ],
165  "last": "string",
166  "next": "string",
167  "prev": "string"
168}
Retrieves a paginated list of products. Supports filtering by search term, barcode, SKU, status, and other criteria.
Was this page helpful?
Previous

Get Taxonomies

Next

Create Product

Built with

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Query parameters

SearchstringOptional
Search Products by name, sku, inventory id or product Id.
BarcodeintegerOptional
Barcode Associated with variant
Barcodeslist of stringsOptional
Barcodes Associated with variant
CategoryIdslist of integersOptional
List of Category Ids associated with product
ChannelIdslist of integersOptional
Looks for Products variants by their channel IDs
HasDigitalVariantsbooleanOptional

Looks for Products with/without digital variants

HasVariantsbooleanOptional

Looks for Products with/without variants

InventoryIdlist of integersOptional
Looks for variants by its associated inventory id
IsInventorySyncEnabledobjectOptional
Looks for Products variants by their IsInventorySyncEnabled is true
LastUpdatedTimestampdatetimeOptional
Looks for Products that have been updated since the given date
LegacyIdslist of integersOptional

Looks for Products with by Legacy Product Id(s)

NamestringOptional

Looks for Products/Variants by name

OnHandintegerOptional
Looks for Products with inventory
PlatformIdslist of stringsOptional
Looks for Products variants by their external Platform IDs
ProductIdlist of integersOptional
Looks for Products with an assigned Id
ProductTypeintegerOptional
Looks for Products by type
ReviewsPendinglist of stringsOptional
Looks for Products by ReviewsPending
SalesChannellist of stringsOptional

Looks for Products variants assigned to a platform/sales channel

SellerSKUstringOptional
Looks for Products that match the provided Seller query
SKUstringOptional
Looks for Products that match the provided Sku query
TaxonomyIdslist of integersOptional
Looks for Products variants by their taxonomy id or any descendants of the taxonomies sent separated by comma
VariantIdlist of integersOptional
Looks for products that contain a variant with the given ID
VariantStatusstringOptional
Looks for Products with variants that contain provided status
PageSizeintegerOptional

1-250

SortBystringOptional
Id, Name, Category, TotalOnHandQty
SortOrderstringOptional
ASC,DESC

Response

Success
firststring
itemslist of objects
laststring
nextstring
prevstring

Errors

400
Bad Request Error
404
Not Found Error