List all bundles
How to fetch a collection of bundles via API
To fetch a collection of bundles, send a GET request to the /api/bundles endpoint.
Request
GET https://yourdomain.commercelayer.io/api/bundles
Example
The following request fetches a collection of bundles:
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/bundles/' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token'On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:
{
"data": [
{
"id": "XAyRWNUzyN",
"type": "bundles",
"links": {
"self": "https://yourdomain.commercelayer.io/api/bundles/XAyRWNUzyN"
},
"attributes": {
"code": "BUNDMM000000FFFFFFXLXX",
"name": "Men's Black T-shirt (XL) with Black Cap and Socks, all with White Logo",
"currency_code": "EUR",
"description": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
"image_url": "https://img.yourdomain.com/bundles/xYZkjABcde.png",
"do_not_ship": false,
"do_not_track": false,
"price_amount_cents": 10000,
"price_amount_float": 100.0,
"formatted_price_amount": "€100,00",
"compare_at_amount_cents": 13000,
"compare_at_amount_float": 130.0,
"formatted_compare_at_amount": "€130,00",
"skus_count": 2,
"created_at": "2018-01-01T12:00:00.000Z",
"updated_at": "2018-01-01T12:00:00.000Z",
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"metadata": {
"foo": "bar"
}
},
"relationships": {
"market": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/bundles/XAyRWNUzyN/relationships/market",
"related": "https://yourdomain.commercelayer.io/api/bundles/XAyRWNUzyN/market"
}
},
"sku_list": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/bundles/XAyRWNUzyN/relationships/sku_list",
"related": "https://yourdomain.commercelayer.io/api/bundles/XAyRWNUzyN/sku_list"
}
},
"skus": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/bundles/XAyRWNUzyN/relationships/skus",
"related": "https://yourdomain.commercelayer.io/api/bundles/XAyRWNUzyN/skus"
}
},
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/bundles/XAyRWNUzyN/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/bundles/XAyRWNUzyN/attachments"
}
},
"events": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/bundles/XAyRWNUzyN/relationships/events",
"related": "https://yourdomain.commercelayer.io/api/bundles/XAyRWNUzyN/events"
}
},
"tags": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/bundles/XAyRWNUzyN/relationships/tags",
"related": "https://yourdomain.commercelayer.io/api/bundles/XAyRWNUzyN/tags"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/bundles/XAyRWNUzyN/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/bundles/XAyRWNUzyN/versions"
}
},
"event_stores": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/bundles/XAyRWNUzyN/relationships/event_stores",
"related": "https://yourdomain.commercelayer.io/api/bundles/XAyRWNUzyN/event_stores"
}
}
},
"meta": {
"mode": "test",
"organization_id": "xRRkjDFafe",
"trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
}
},
{
"other": "... 9 bundles (first page)"
}
],
"meta": {
"record_count": 140,
"page_count": 14
},
"links": {
"first": "https://yourdomain.commercelayer.io/api/bundles?page[number]=1&page[size]=10",
"next": "https://yourdomain.commercelayer.io/api/bundles?page[number]=2&page[size]=10",
"last": "https://yourdomain.commercelayer.io/api/bundles?page[number]=14&page[size]=10"
}
}Remember that when you fetch a list of resources you get paginated result.
Sortable fields
The list of bundles can be sorted by the following fields:
Attributes
codecurrency_codeprice_amount_centscompare_at_amount_centsidcreated_atupdated_atreferencereference_origin
Relationships
marketsku_list
Filterable fields
The list of bundles can be filtered by the following fields:
Attributes
codenamecurrency_codedescriptionimage_urldo_not_shipdo_not_trackprice_amount_centscompare_at_amount_centsidcreated_atupdated_atreferencereference_originmetadata
Relationships
marketsku_listattachmentseventstags
Last updated

