Create a price list
How to create a price list via API
To create a new price list, send a
POST request to the /api/price_lists endpoint, passing the resource arguments in the request body.POST https://yourdomain.commercelayer.io/api/price_lists
Body Parameter | Type | Required |
|---|---|---|
type | string | Required |
attributes.name | string | Required |
attributes.currency_code | string | Required |
attributes.tax_included | boolean | Optional, default is 'true' |
attributes.reference | string | Optional |
attributes.reference_origin | string | Optional |
attributes.metadata | object | Optional |
Request
Response
The following request creates a new price list:
curl -g -X POST \
'https://yourdomain.commercelayer.io/api/price_lists' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "price_lists",
"attributes": {
"name": "EU Price list",
"currency_code": "EUR"
}
}
}'
On success, the API responds with a
201 Created status code, returning the created resource object:{
"data": {
"id": "xYZkjABcde",
"type": "price_lists",
"links": {
"self": "https://yourdomain.commercelayer.io/api/price_lists/xYZkjABcde"
},
"attributes": {
"name": "EU Price list",
"currency_code": "EUR",
"tax_included": true,
"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": {
"prices": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/price_lists/xYZkjABcde/relationships/prices",
"related": "https://yourdomain.commercelayer.io/api/price_lists/xYZkjABcde/prices"
}
},
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/price_lists/xYZkjABcde/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/price_lists/xYZkjABcde/attachments"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/price_lists/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/price_lists/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
}
}
Last modified 2mo ago