Retrieve a stock location

How to fetch a specific stock location via API

To fetch a single stock location, send a GET request to the /api/stock_locations/:id endpoint, where id is the ID of the resource that you want to retrieve.

Request

GET https://yourdomain.commercelayer.io/api/stock_locations/:id

Example

Request
Response
Request

The following request fetches the stock location identified by the id "xYZkjABcde":

curl -X GET \
https://yourdomain.commercelayer.io/api/stock_locations/xYZkjABcde \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token'
Response

On success, the API responds with a 200 OK status code, returning a single resource object:

{
"data": {
"id": "xYZkjABcde",
"type": "stock_locations",
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_locations/xYZkjABcde"
},
"attributes": {
"number": 1234,
"name": "Primary warehouse",
"label_format": "PDF",
"suppress_etd": false,
"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": {
"address": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_locations/xYZkjABcde/relationships/address",
"related": "https://yourdomain.commercelayer.io/api/stock_locations/xYZkjABcde/address"
}
},
"inventory_stock_locations": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_locations/xYZkjABcde/relationships/inventory_stock_locations",
"related": "https://yourdomain.commercelayer.io/api/stock_locations/xYZkjABcde/inventory_stock_locations"
}
},
"inventory_return_locations": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_locations/xYZkjABcde/relationships/inventory_return_locations",
"related": "https://yourdomain.commercelayer.io/api/stock_locations/xYZkjABcde/inventory_return_locations"
}
},
"stock_items": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_locations/xYZkjABcde/relationships/stock_items",
"related": "https://yourdomain.commercelayer.io/api/stock_locations/xYZkjABcde/stock_items"
}
},
"stock_transfers": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_locations/xYZkjABcde/relationships/stock_transfers",
"related": "https://yourdomain.commercelayer.io/api/stock_locations/xYZkjABcde/stock_transfers"
}
},
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_locations/xYZkjABcde/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/stock_locations/xYZkjABcde/attachments"
}
}
},
"meta": {
"mode": "test"
}
}
}