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

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'

Response

On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:

{
  "data": [
    {
      "id": "XAyRWNUzyN",
      "type": "sku_lists",
      "links": {
        "self": "https://yourdomain.commercelayer.io/api/sku_lists/XAyRWNUzyN"
      },
      "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/XAyRWNUzyN/relationships/customer",
            "related": "https://yourdomain.commercelayer.io/api/sku_lists/XAyRWNUzyN/customer"
          }
        },
        "skus": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/sku_lists/XAyRWNUzyN/relationships/skus",
            "related": "https://yourdomain.commercelayer.io/api/sku_lists/XAyRWNUzyN/skus"
          }
        },
        "sku_list_items": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/sku_lists/XAyRWNUzyN/relationships/sku_list_items",
            "related": "https://yourdomain.commercelayer.io/api/sku_lists/XAyRWNUzyN/sku_list_items"
          }
        },
        "bundles": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/sku_lists/XAyRWNUzyN/relationships/bundles",
            "related": "https://yourdomain.commercelayer.io/api/sku_lists/XAyRWNUzyN/bundles"
          }
        },
        "attachments": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/sku_lists/XAyRWNUzyN/relationships/attachments",
            "related": "https://yourdomain.commercelayer.io/api/sku_lists/XAyRWNUzyN/attachments"
          }
        },
        "links": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/sku_lists/XAyRWNUzyN/relationships/links",
            "related": "https://yourdomain.commercelayer.io/api/sku_lists/XAyRWNUzyN/links"
          }
        },
        "event_stores": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/sku_lists/XAyRWNUzyN/relationships/event_stores",
            "related": "https://yourdomain.commercelayer.io/api/sku_lists/XAyRWNUzyN/event_stores"
          }
        }
      },
      "meta": {
        "mode": "test",
        "organization_id": "xRRkjDFafe",
        "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
      }
    },
    {
      "other": "... 9 sku_lists (first page)"
    }
  ],
  "meta": {
    "record_count": 140,
    "page_count": 14,
    "page_size": 10,
    "page_number": 1,
    "mode": "test",
    "organization_id": "xRRkjDFafe",
    "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
  },
  "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:

Attributes

• name
• slug
• manual
• id
• created_at
• updated_at
• reference
• reference_origin

Relationships

• customer

Filterable fields

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

Attributes

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

Relationships

• customer
• sku_list_items
• attachments
• links