Links

Update a stock line item

How to update an existing stock line item via API
To update an existing stock line item, send a PATCH request to the /api/stock_line_items/:id endpoint, where id is the ID of the resource that you want to update.
Here below the list of all the possible arguments that you can pass with the request body.

Request

PATCH https://yourdomain.commercelayer.io/api/stock_line_items/:id

Arguments

Body Parameter
Type
Required
type
string
Required
id
string
Required
attributes.sku_code
string
Optional
attributes.quantity
integer
Optional
attributes._reserve_stock
boolean
Optional
attributes._release_stock
boolean
Optional
attributes._decrement_stock
boolean
Optional
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

Example

Request
Response
The following request updates the stock line item identified by the ID "xYZkjABcde":
curl -g -X PATCH \
'https://yourdomain.commercelayer.io/api/stock_line_items/xYZkjABcde' \
-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",
"id": "xYZkjABcde",
"attributes": {
"sku_code": "TSHIRTMM000000FFFFFFXLXX"
},
"relationships": {
"shipment": {
"data": {
"type": "shipments",
"id": "ABCRtyUpBa"
}
}
}
}
}'
On success, the API responds with a 200 OK status code, returning the updated 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"
}
}
}