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

String to filter products by SKU, name or barcode.

integer
≥ 1
Defaults to 1

Page number for pagination, starting from 1.

integer
1 to 500
Defaults to 50

Number of products returned per page.

string | null
Defaults to null

Field name to sort the results by (can be id, created_at or updated_at).

string
enum
Defaults to ASC

Sort direction for the results.

Allowed:
enum

Filter products by their current status.

date-time
Defaults to null

Return only products updated at or after this timestamp.

date-time
Defaults to null

Return only products updated at or before this timestamp.

date-time
Defaults to null

Return only products created at or after this timestamp.

date-time
Defaults to null

Return only products created at or before this date and time.

Response

Updated 2 months 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 2 months ago