v1
latestOpenAPI 3.1.02026-07-2689175245.8 KBCollections
List Collections
Retrieve a list of collections. The list can be filtered, sorted, and paginated using the parameters below.
get/collections
Query parameters
external_idstring
An external_id used to filter the collections.
limitinteger
The maximum number of collections returned.
sort_order'asc' | 'desc'
The sort order for the results.
cursorstring
The cursor to return the next page of results.
Response
Success
Example response
{
"collections": [
{
"products": [
{
"id": 810772,
"external_id": "564400c7-7a6b-4f29-b6a5-7bb580b2992c",
"sku": "SHOES-US44-M-Brwn",
"name": "Classic Brown Dress Shoes",
"weight_grams": 440,
"type": "shoes",
"vendor": "Internal",
"price": {
"amount": 50000,
"currency_code": "USD"
},
"created_at": "2023-04-25T13:25:00-05:00",
"updated_at": "2023-04-25T13:45:00-05:00",
"collections": [
{
"id": 891009,
"external_id": "62291d16-9b61-4fbb-b868-21c2d32dc155"
}
],
"options": [
{
"position": 1,
"values": [
"red"
],
"name": "Colors"
}
],
"images": [
"https://example.com/example.jpg"
],
"tags": [
"shoes"
],
"source": "Shopify",
"default_variant_id": 810773
}
]
}
]
}