Retrieve a return line item How to fetch a specific return line item via API
To fetch a single return line item, send a GET
request to the /api/return_line_items/:id
endpoint, where id
is the ID of the resource that you want to retrieve.
Request
GET https://yourdomain.commercelayer.io/api/return_line_items/:id
Example
Request Response
The following request fetches the return line item identified by the id "xYZkjABcde":
Copy curl - g - X GET \
'https://yourdomain.commercelayer.io/api/return_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:
Copy {
"data" : {
"id" : "xYZkjABcde" ,
"type" : "return_line_items" ,
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/return_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" ,
"return_reason" : {
"size" : "was wrong"
} ,
"restocked_at" : "2018-01-01T12:00:00.000Z" ,
"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" : {
"return" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/return_line_items/xYZkjABcde/relationships/return" ,
"related" : "https://yourdomain.commercelayer.io/api/return_line_items/xYZkjABcde/return"
}
} ,
"line_item" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/return_line_items/xYZkjABcde/relationships/line_item" ,
"related" : "https://yourdomain.commercelayer.io/api/return_line_items/xYZkjABcde/line_item"
}
}
} ,
"meta" : {
"mode" : "test"
}
}
}
Last updated 9 months ago