Create a SKU list

How to create a SKU list via API

To create a new SKU list, send a POST request to the /api/sku_lists endpoint, passing the resource arguments in the request body.

Request

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

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.name	string	Required
attributes.description	string	Optional
attributes.image_url	string	Optional
attributes.manual	boolean	Optional, default is 'true'
attributes.sku_code_regex	string	Required, if manual is falsy
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional
relationships.customer	object	Optional

Example

Request

The following request creates a new SKU list:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/sku_lists' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "sku_lists",
    "attributes": {
      "name": "Personal list",
      "sku_code_regex": "^(A|B).*$"
    }
  }
}'

Response

On success, the API responds with a 201 Created status code, returning the created resource object:

{
  "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"
        }
      },
      "versions": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/sku_lists/XAyRWNUzyN/relationships/versions",
          "related": "https://yourdomain.commercelayer.io/api/sku_lists/XAyRWNUzyN/versions"
        }
      },
      "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"
    }
  }
}