List all products

GET {{baseUrl}}/v1/products

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

Request Params

KeyDatatypeRequiredDescription
activestringOnly return products that are active or inactive (e.g., pass false to list all inactive products).
created[gt]stringOnly return products that were created during the given date interval.
created[gte]stringOnly return products that were created during the given date interval.
created[lt]stringOnly return products that were created during the given date interval.
created[lte]stringOnly return products that were created during the given date interval.
ending_beforestringA cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
expand[0]stringSpecifies which fields in the response should be expanded.
expand[1]stringSpecifies which fields in the response should be expanded.
ids[0]stringOnly return products with the given IDs. Cannot be used with starting_after or ending_before.
ids[1]stringOnly return products with the given IDs. Cannot be used with starting_after or ending_before.
limitstringA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
shippablestringOnly return products that can be shipped (i.e., physical, not digital products).
starting_afterstringA cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
urlstringOnly return products with the given url.

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring