Retrieve a stock transfer
How to fetch a specific stock transfer via API
To fetch a single stock transfer, send a GET
request to the /api/stock_transfers/:id
endpoint, where id
is the ID of the resource that you want to retrieve.
Request
GET https://yourdomain.commercelayer.io/api/stock_transfers/:id
Example
The following request fetches the stock transfer identified by the id "xYZkjABcde":
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/stock_transfers/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:
{
"data": {
"id": "xYZkjABcde",
"type": "stock_transfers",
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde"
},
"attributes": {
"cancelled_at": "2018-01-01T12:00:00.000Z",
"completed_at": "2018-01-01T12:00:00.000Z",
"created_at": "2018-01-01T12:00:00.000Z",
"metadata": {
"foo": "bar"
},
"number": "1234",
"quantity": 2,
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"sku_code": "TSHIRTMM000000FFFFFFXLXX",
"status": "draft",
"updated_at": "2018-01-01T12:00:00.000Z"
},
"relationships": {
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/attachments"
}
},
"destination_stock_location": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/relationships/destination_stock_location",
"related": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/destination_stock_location"
}
},
"events": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/relationships/events",
"related": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/events"
}
},
"line_item": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/relationships/line_item",
"related": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/line_item"
}
},
"origin_stock_location": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/relationships/origin_stock_location",
"related": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/origin_stock_location"
}
},
"shipment": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/relationships/shipment",
"related": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/shipment"
}
},
"sku": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/relationships/sku",
"related": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/sku"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/stock_transfers/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
}
}
Last updated