Delivery lead times Retrieve a delivery lead time How to fetch a specific delivery lead time via API
To fetch a single delivery lead time, send a GET
request to the /api/delivery_lead_times/:id
endpoint, where id
is the ID of the resource that you want to retrieve.
Request
GET https://yourdomain.commercelayer.io/api/delivery_lead_times/:id
Example
Request Response
The following request fetches the delivery lead time identified by the id "xYZkjABcde":
Copy curl -g -X GET \
'https://yourdomain.commercelayer.io/api/delivery_lead_times/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" : "delivery_lead_times" ,
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/delivery_lead_times/xYZkjABcde"
} ,
"attributes" : {
"min_hours" : 48 ,
"max_hours" : 72 ,
"min_days" : 2 ,
"max_days" : 3 ,
"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/delivery_lead_times/xYZkjABcde/relationships/stock_location" ,
"related" : "https://yourdomain.commercelayer.io/api/delivery_lead_times/xYZkjABcde/stock_location"
}
} ,
"shipping_method" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/delivery_lead_times/xYZkjABcde/relationships/shipping_method" ,
"related" : "https://yourdomain.commercelayer.io/api/delivery_lead_times/xYZkjABcde/shipping_method"
}
} ,
"attachments" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/delivery_lead_times/xYZkjABcde/relationships/attachments" ,
"related" : "https://yourdomain.commercelayer.io/api/delivery_lead_times/xYZkjABcde/attachments"
}
} ,
"versions" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/delivery_lead_times/xYZkjABcde/relationships/versions" ,
"related" : "https://yourdomain.commercelayer.io/api/delivery_lead_times/xYZkjABcde/versions"
}
}
} ,
"meta" : {
"mode" : "test" ,
"organization_id" : "xRRkjDFafe" ,
"trace_id" : "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
}
}
}
Last updated 2 months ago