Comment on page
Retrieve a shipping method tier
How to fetch a specific shipping method tier via API
To fetch a single shipping method tier, send a
GET request to the /api/shipping_method_tiers/:id endpoint, where id is the ID of the resource that you want to retrieve.GET https://yourdomain.commercelayer.io/api/shipping_method_tiers/:id
Request
Response
The following request fetches the shipping method tier identified by the id "xYZkjABcde":
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/shipping_method_tiers/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": "shipping_method_tiers",
"links": {
"self": "https://yourdomain.commercelayer.io/api/shipping_method_tiers/xYZkjABcde"
},
"attributes": {
"name": "Light shipping under 3kg",
"up_to": 20.5,
"price_amount_cents": 1000,
"price_amount_float": 10.0,
"formatted_price_amount": "€10,00",
"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": {
"shipping_method": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/shipping_method_tiers/xYZkjABcde/relationships/shipping_method",
"related": "https://yourdomain.commercelayer.io/api/shipping_method_tiers/xYZkjABcde/shipping_method"
}
},
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/shipping_method_tiers/xYZkjABcde/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/shipping_method_tiers/xYZkjABcde/attachments"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/shipping_method_tiers/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/shipping_method_tiers/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
}
}
Last modified 3mo ago