Get multiple products

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Query parameters

ReferenceIdsstringOptional

Comma separated list of reference ids to filter by

PageintegerOptional0-2147483647

Page of products to get - Valid Range is 0 to integer max with a default of 1

LimitintegerOptional1-250

Amount of products per page to request - Valid Range is 1 to 250 with a default of 50

IDsstringOptional

Comma separated list of product ids to filter by

SearchstringOptional

Search is available for 2 fields of the inventory record related to the product: Inventory ID and Name -

Expected behavior for search by Inventory ID is exact match
Expected behavior for search by Inventory Name is partial match, i.e. does not have to be start of word, but must be consecutive characters. This is not case sensitive.

Search is available for 2 fields of the inventory record related to the product: Inventory ID and Name - 1. Expected behavior for search by Inventory ID is exact match 2. Expected behavior for search by Inventory Name is partial match, i.e. does not have to be start of word, but must be consecutive characters. This is not case sensitive.

ActiveStatusstringOptional

Status filter for products:

Any: Include both active and inactive
Active: Filter products that are Active
Inactive: Filter products that are Inactive”,

Status filter for products: - Any: Include both active and inactive - Active: Filter products that are Active - Inactive: Filter products that are Inactive",

BundleStatusstringOptional

Bundle filter for products:

Any: Don’t filter and consider products that are bundles or not bundles
Bundle: Filter by products that are bundles
NotBundle: Filter by products that are not bundles”

Bundle filter for products: - Any: Don't filter and consider products that are bundles or not bundles - Bundle: Filter by products that are bundles - NotBundle: Filter by products that are not bundles"

Response headers

Page-Numberstring or null

Number of the current page

Total-Pagesstring or null

Total number of pages of results

Total-Countstring or null

Total number of results

Page-Sizestring or null

Number of results per page

Next-Pagestring or null

The href of the next page of results, if there is a next page

Response

Success

barcodestring or null

Barcode for the product

bundle_root_informationobject or null

channelobject or null

Information about a store channel

created_datedatetime or null

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 or null

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 or null

Total committed quantity of this product

total_fulfillable_quantityinteger or null

Total fulfillable quantity of this product

total_onhand_quantityinteger or null

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

1	import requests
2
3	url = "https://api.shipbob.com/1.0/product"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	[
2	{
3	"barcode": "123456789012",
4	"bundle_root_information": {
5	"id": 0,
6	"name": "string"
7	},
8	"channel": {
9	"id": 0,
10	"name": "House of Slippers"
11	},
12	"created_date": "2019-08-24T14:15:22Z",
13	"fulfillable_inventory_items": [
14	{
15	"id": 0,
16	"name": "Medium Blue T-Shirt",
17	"quantity": 0
18	}
19	],
20	"fulfillable_quantity_by_fulfillment_center": [
21	{
22	"committed_quantity": 0,
23	"fulfillable_quantity": 0,
24	"id": 0,
25	"name": "Cicero",
26	"onhand_quantity": 0
27	}
28	],
29	"gtin": "012345678905",
30	"id": 0,
31	"name": "Medium Blue T-Shirt",
32	"reference_id": "TShirtBlueM",
33	"sku": "TShirtBlueM",
34	"total_committed_quantity": 0,
35	"total_fulfillable_quantity": 0,
36	"total_onhand_quantity": 0,
37	"unit_price": 20.32,
38	"upc": "012345678912"
39	}
40	]

Authentication

Headers

Query parameters

Response headers

Response

Errors