Retrieve a shipping method
How to fetch a specific shipping method via API
To fetch a single shipping method, send a GET
request to the /api/shipping_methods/:id
endpoint, where id
is the ID of the resource that you want to retrieve.
Request
GET https://yourdomain.commercelayer.io/api/shipping_methods/:id
Example
The following request fetches the shipping method identified by the id "xYZkjABcde":
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/shipping_methods/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_methods",
"links": {
"self": "https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde"
},
"attributes": {
"name": "Standard shipping",
"scheme": "flat",
"currency_code": "EUR",
"external_prices_url": "https://external_prices.yourbrand.com",
"price_amount_cents": 1000,
"price_amount_float": 10.0,
"formatted_price_amount": "€10,00",
"free_over_amount_cents": 9900,
"free_over_amount_float": 99.0,
"formatted_free_over_amount": "€99,00",
"use_subtotal": true,
"min_weight": 3.0,
"max_weight": 300.0,
"unit_of_weight": "gr",
"disabled_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": {
"market": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde/relationships/market",
"related": "https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde/market"
}
},
"shipping_zone": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde/relationships/shipping_zone",
"related": "https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde/shipping_zone"
}
},
"shipping_category": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde/relationships/shipping_category",
"related": "https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde/shipping_category"
}
},
"stock_location": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde/relationships/stock_location",
"related": "https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde/stock_location"
}
},
"delivery_lead_time_for_shipment": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde/relationships/delivery_lead_time_for_shipment",
"related": "https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde/delivery_lead_time_for_shipment"
}
},
"shipping_method_tiers": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde/relationships/shipping_method_tiers",
"related": "https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde/shipping_method_tiers"
}
},
"shipping_weight_tiers": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde/relationships/shipping_weight_tiers",
"related": "https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde/shipping_weight_tiers"
}
},
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde/attachments"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
}
}
Last updated