Retrieve an inventory return location How to fetch a specific inventory return location via API
To fetch a single inventory return location, send a GET
request to the /api/inventory_return_locations/:id
endpoint, where id
is the ID of the resource that you want to retrieve.
Request
GET https://yourdomain.commercelayer.io/api/inventory_return_locations/:id
Example
Request Response
The following request fetches the inventory return location identified by the id "xYZkjABcde":
Copy curl -g -X GET \
'https://yourdomain.commercelayer.io/api/inventory_return_locations/xYZkjABcde' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token'
On success, the API responds with a 200 OK
status code, returning a single resource object:
Copy {
"data" : {
"id" : "xYZkjABcde" ,
"type" : "inventory_return_locations" ,
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/inventory_return_locations/xYZkjABcde"
} ,
"attributes" : {
"priority" : 1 ,
"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/inventory_return_locations/xYZkjABcde/relationships/stock_location",
"related" : "https://yourdomain.commercelayer.io/api/inventory_return_locations/xYZkjABcde/stock_location"
}
} ,
"inventory_model" : {
"links" : {
"self": "https://yourdomain.commercelayer.io/api/inventory_return_locations/xYZkjABcde/relationships/inventory_model",
"related" : "https://yourdomain.commercelayer.io/api/inventory_return_locations/xYZkjABcde/inventory_model"
}
} ,
"versions" : {
"links" : {
"self": "https://yourdomain.commercelayer.io/api/inventory_return_locations/xYZkjABcde/relationships/versions",
"related" : "https://yourdomain.commercelayer.io/api/inventory_return_locations/xYZkjABcde/versions"
}
}
} ,
"meta" : {
"mode" : "test"
}
}
}