Update a stock item How to update an existing stock item via API
To update an existing stock item, send a PATCH
request to the /api/stock_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_items/:id
Arguments
Body Parameter Type Required attributes.reference_origin
relationships.stock_location
Example
Request Response
The following request updates the stock item identified by the ID "xYZkjABcde":
Copy curl - g - X PATCH \
'https://yourdomain.commercelayer.io/api/stock_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_items" ,
"id" : "xYZkjABcde" ,
"attributes" : {
"sku_code" : "TSHIRTMM000000FFFFFFXLXX"
} ,
"relationships" : {
"stock_location" : {
"data" : {
"type" : "stock_locations" ,
"id" : "ABCRtyUpBa"
}
}
}
}
} '
On success, the API responds with a 200 OK
status code, returning the updated resource object:
Copy {
"data" : {
"id" : "xYZkjABcde" ,
"type" : "stock_items" ,
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/stock_items/xYZkjABcde"
} ,
"attributes" : {
"sku_code" : "TSHIRTMM000000FFFFFFXLXX" ,
"quantity" : 100 ,
"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" : {
"stock_location" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/stock_items/xYZkjABcde/relationships/stock_location" ,
"related" : "https://yourdomain.commercelayer.io/api/stock_items/xYZkjABcde/stock_location"
}
} ,
"sku" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/stock_items/xYZkjABcde/relationships/sku" ,
"related" : "https://yourdomain.commercelayer.io/api/stock_items/xYZkjABcde/sku"
}
} ,
"reserved_stock" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/stock_items/xYZkjABcde/relationships/reserved_stock" ,
"related" : "https://yourdomain.commercelayer.io/api/stock_items/xYZkjABcde/reserved_stock"
}
} ,
"stock_reservations" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/stock_items/xYZkjABcde/relationships/stock_reservations" ,
"related" : "https://yourdomain.commercelayer.io/api/stock_items/xYZkjABcde/stock_reservations"
}
} ,
"attachments" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/stock_items/xYZkjABcde/relationships/attachments" ,
"related" : "https://yourdomain.commercelayer.io/api/stock_items/xYZkjABcde/attachments"
}
} ,
"versions" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/stock_items/xYZkjABcde/relationships/versions" ,
"related" : "https://yourdomain.commercelayer.io/api/stock_items/xYZkjABcde/versions"
}
}
} ,
"meta" : {
"mode" : "test"
}
}
}
Last updated 7 months ago