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.POST https://yourdomain.commercelayer.io/api/sku_lists
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 |
Request
Response
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).*$"
}
}
}'
On success, the API responds with a
201 Created
status code, returning the created resource object:{
"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"
}
}
}
Last modified 29d ago