Comment on page
Retrieve a parcel line item
How to fetch a specific parcel line item via API
To fetch a single parcel line item, send a
GET request to the /api/parcel_line_items/:id endpoint, where id is the ID of the resource that you want to retrieve.GET https://yourdomain.commercelayer.io/api/parcel_line_items/:id
Request
Response
The following request fetches the parcel line item identified by the id "xYZkjABcde":
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/parcel_line_items/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": "parcel_line_items",
"links": {
"self": "https://yourdomain.commercelayer.io/api/parcel_line_items/xYZkjABcde"
},
"attributes": {
"sku_code": "TSHIRTMM000000FFFFFFXLXX",
"bundle_code": "BUNDLEMM000000FFFFFFXLXX",
"quantity": 4,
"name": "Black Men T-shirt with White Logo (XL)",
"image_url": "https://img.yourdomain.com/skus/xYZkjABcde.png",
"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": {
"parcel": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/parcel_line_items/xYZkjABcde/relationships/parcel",
"related": "https://yourdomain.commercelayer.io/api/parcel_line_items/xYZkjABcde/parcel"
}
},
"stock_line_item": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/parcel_line_items/xYZkjABcde/relationships/stock_line_item",
"related": "https://yourdomain.commercelayer.io/api/parcel_line_items/xYZkjABcde/stock_line_item"
}
},
"shipment_line_item": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/parcel_line_items/xYZkjABcde/relationships/shipment_line_item",
"related": "https://yourdomain.commercelayer.io/api/parcel_line_items/xYZkjABcde/shipment_line_item"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/parcel_line_items/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/parcel_line_items/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
}
}
Last modified 3mo ago