Create a SKU option
How to create a SKU option via API
To create a new SKU option, send a
POST request to the /api/sku_options endpoint, passing the resource arguments in the request body.POST https://yourdomain.commercelayer.io/api/sku_options
Body Parameter | Type | Required |
|---|---|---|
type | string | Required |
attributes.name | string | Required |
attributes.currency_code | string | Required, unless inherited by market |
attributes.description | string | Optional |
attributes.price_amount_cents | integer | Optional, default is '0' |
attributes.delay_hours | integer | Optional, default is '0' |
attributes.sku_code_regex | string | Optional |
attributes.reference | string | Optional |
attributes.reference_origin | string | Optional |
attributes.metadata | object | Optional |
relationships.market | object | Optional |
relationships.tags | array | Optional |
Request
Response
The following request creates a new SKU option:
curl -g -X POST \
'https://yourdomain.commercelayer.io/api/sku_options' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "sku_options",
"attributes": {
"name": "Embossing",
"currency_code": "EUR"
}
}
}'
On success, the API responds with a
201 Created status code, returning the created resource object:{
"data": {
"id": "xYZkjABcde",
"type": "sku_options",
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_options/xYZkjABcde"
},
"attributes": {
"name": "Embossing",
"currency_code": "EUR",
"description": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
"price_amount_cents": 1000,
"price_amount_float": 10.0,
"formatted_price_amount": "€10,00",
"delay_hours": 48,
"delay_days": 2,
"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": {
"market": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_options/xYZkjABcde/relationships/market",
"related": "https://yourdomain.commercelayer.io/api/sku_options/xYZkjABcde/market"
}
},
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_options/xYZkjABcde/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/sku_options/xYZkjABcde/attachments"
}
},
"events": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_options/xYZkjABcde/relationships/events",
"related": "https://yourdomain.commercelayer.io/api/sku_options/xYZkjABcde/events"
}
},
"tags": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_options/xYZkjABcde/relationships/tags",
"related": "https://yourdomain.commercelayer.io/api/sku_options/xYZkjABcde/tags"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/sku_options/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/sku_options/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
}
}
Last modified 2mo ago