Get multiple products

View as Markdown

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Headers

shipbob_channel_idstringOptionalformat: "int32"
Channel Id for Operation

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 - 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",
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"

Response headers

Page-Numberstring
Number of the current page
Total-Pagesstring
Total number of pages of results
Total-Countstring
Total number of results
Page-Sizestring
Number of results per page
Next-Pagestring
The href of the next page of results, if there is a next page

Response

Success

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error