API reference
Search
K
Links

List all SKU lists

How to fetch a collection of SKU lists via API
To fetch a collection of SKU lists, send a GET request to the /api/sku_lists endpoint.

Request

GET https://yourdomain.commercelayer.io/api/sku_lists

Example

Request
Response
The following request fetches a collection of SKU lists:
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/sku_lists/' \
-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": "xYZkjABcde",
"type": "sku_lists",
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_lists/xYZkjABcde"
},
"attributes": {
"name": "Personal list",
"slug": "personal-list-1",
"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/skus/xYZkjABcde.png",
"manual": false,
"sku_code_regex": "^(A|B).*$",
"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": {
"customer": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_lists/xYZkjABcde/relationships/customer",
"related": "https://yourdomain.commercelayer.io/api/sku_lists/xYZkjABcde/customer"
}
},
"skus": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_lists/xYZkjABcde/relationships/skus",
"related": "https://yourdomain.commercelayer.io/api/sku_lists/xYZkjABcde/skus"
}
},
"sku_list_items": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_lists/xYZkjABcde/relationships/sku_list_items",
"related": "https://yourdomain.commercelayer.io/api/sku_lists/xYZkjABcde/sku_list_items"
}
},
"bundles": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_lists/xYZkjABcde/relationships/bundles",
"related": "https://yourdomain.commercelayer.io/api/sku_lists/xYZkjABcde/bundles"
}
},
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_lists/xYZkjABcde/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/sku_lists/xYZkjABcde/attachments"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_lists/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/sku_lists/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
},
{
"other": "... 9 sku_lists (first page)"
}
],
"meta": {
"record_count": 140,
"page_count": 14
},
"links": {
"first": "https://yourdomain.commercelayer.io/api/sku_lists?page[number]=1&page[size]=10",
"next": "https://yourdomain.commercelayer.io/api/sku_lists?page[number]=2&page[size]=10",
"last": "https://yourdomain.commercelayer.io/api/sku_lists?page[number]=14&page[size]=10"
}
}
Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of SKU lists can be sorted by the following fields:
  • name
  • slug
  • manual
  • id
  • created_at
  • updated_at
  • reference
  • reference_origin

Filterable fields

The list of SKU lists can be filtered by the following fields:

Attributes

  • name
  • slug
  • description
  • image_url
  • manual
  • sku_code_regex
  • id
  • created_at
  • updated_at
  • reference
  • reference_origin

Relationships

  • customer
  • sku_list_items
  • bundles
  • attachments
  • versions