Links

Create a stock line item

How to create a stock line item via API
To create a new stock line item, send a POST request to the /api/stock_line_items endpoint, passing the resource arguments in the request body.

Request

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

Arguments

Body Parameter
Type
Required
type
string
Required
attributes.sku_code
string
Optional
attributes.quantity
integer
Required
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
relationships.shipment
object
Optional
relationships.line_item
object
Optional
relationships.stock_item
object
Optional
relationships.sku
object
Optional, default is stock item one

Example

Request
Response
The following request creates a new stock line item:
curl -g -X POST \
'https://yourdomain.commercelayer.io/api/stock_line_items' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "stock_line_items",
"attributes": {
"quantity": 4
}
}
}'
On success, the API responds with a 201 Created status code, returning the created resource object:
{
"data": {
"id": "xYZkjABcde",
"type": "stock_line_items",
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_line_items/xYZkjABcde"
},
"attributes": {
"sku_code": "TSHIRTMM000000FFFFFFXLXX",
"bundle_code": "BUNDLEMM000000FFFFFFXLXX",
"quantity": 4,
"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": {
"shipment": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_line_items/xYZkjABcde/relationships/shipment",
"related": "https://yourdomain.commercelayer.io/api/stock_line_items/xYZkjABcde/shipment"
}
},
"line_item": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_line_items/xYZkjABcde/relationships/line_item",
"related": "https://yourdomain.commercelayer.io/api/stock_line_items/xYZkjABcde/line_item"
}
},
"stock_item": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_line_items/xYZkjABcde/relationships/stock_item",
"related": "https://yourdomain.commercelayer.io/api/stock_line_items/xYZkjABcde/stock_item"
}
},
"sku": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_line_items/xYZkjABcde/relationships/sku",
"related": "https://yourdomain.commercelayer.io/api/stock_line_items/xYZkjABcde/sku"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_line_items/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/stock_line_items/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
}
}