Count filtered products
Counts products based on specified filters
query Parameters
statusesstring[] · style: form · explode: trueFilter by product status - must be included in array format.
Enum values:PENDINGCLASSIFICATION_COMPLETEIN_REVIEWstart_datestring · date-timeOnly count records with last_updated_date > start_date
end_datestring · date-timeOnly count records with last_updated_date < end_date
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
A count of products matching the criteria.
countintegerTotal count of products matching the filters.
Lookup product by UPC
path Parameters
upcstring · pattern:^(?=.*[1-9])[0-9]{1,…· required · style: simpleUPC for the desired product
A valid UPC. Must contain at least one non-zero digit and must not exceed 14 characters.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
PUT product attributes by UPC
For the provided UPC, overwrite the existing product's attributes.
path Parameters
upcstring · pattern:^(?=.*[1-9])[0-9]{1,…· required · style: simpleUPC for the desired product
A valid UPC. Must contain at least one non-zero digit and must not exceed 14 characters.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
PATCH product attributes by UPC
Update or append attributes to the product identified by the provided UPC.
path Parameters
upcstring · pattern:^(?=.*[1-9])[0-9]{1,…· required · style: simpleUPC for the desired product
A valid UPC. Must contain at least one non-zero digit and must not exceed 14 characters.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Bulk upload products
Upload products in text/csv format. The header row (case insensitive) must include either UPC, product_name, or both. For the best classification results, please provide "product_name", "brand_name" and "description".
Additionally, the CSV can include any parameters you wish to be persisted and returned back in future results to make integration with your application easier (for example, an internal SKU).
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Product batch successfully created
batchIdstring
Retrieve filtered products
Returns products based on specified filters with pagination. Products will be ordered by last_updated_date descending.
query Parameters
start_datestring · date-timeOnly include records with last_updated_date > start_date
end_datestring · date-timeOnly include records with last_updated_date < end_date
statusesstring[] · style: form · explode: trueFilter by product status - must be included in array format.
Enum values:PENDINGCLASSIFICATION_COMPLETEIN_REVIEWpage_sizeinteger · min: 1 · max: 100Number of products per page (default 50, max 100)
Default: 50page_tokenstringA pagination token used to continue retrieving results from a previous query. If omitted, the query starts from the beginning. Use the value returned in the response to request the next batch of results.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
A list of products matching the criteria.
paginationobjectPagination details.
productsobject[]