API Reference

Retrieve List of Products

get
https://api.shipmonk.com/v1/products

This endpoint doesn't guarantee the result set to be consistent between calls.

In other words, when filtering by dateUpdatedStart field, you might get product #123 on the first page and if enough products are updated in the meantime the same product can appear again on later requested page 2.

If you need consistent results, consider using Products for Inventory Sync endpoint instead.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string | null
Defaults to null

Free-text filter matched against product SKU, name, or barcode.

integer
≥ 1
Defaults to 1

1-based page number to return. Defaults to 1.

integer
1 to 500
Defaults to 50

Number of products returned per page (default and maximum values are documented at the endpoint level).

string | null
Defaults to null

Field to sort the results by; one of 'id', 'created_at', or 'updated_at'.

string
enum
Defaults to ASC

Sort direction for the results: ASC (ascending) or DESC (descending). Defaults to DESC.

Allowed:
Product Status Filter Enum | null
Defaults to null

Return only products in this status (e.g., active, inactive, discontinued). See the enum schema for the full list of allowed values.

date-time
Defaults to null

Return only products updated at or after this ISO 8601 timestamp.

date-time
Defaults to null

Return only products updated at or before this ISO 8601 timestamp.

date-time
Defaults to null

Return only products created at or after this ISO 8601 timestamp.

date-time
Defaults to null

Return only products created at or before this ISO 8601 timestamp.

Response

Updated 4 days ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 days ago