Skip to main content
POST
/
compat
/
shipping-options
Retrieve a list of shipping options
curl --request POST \
  --url https://panel.sendcloud.sc/api/v3/compat/shipping-options \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shipping_method_ids": [
    1,
    2,
    3
  ]
}
'
{
  "data": {
    "1": "shipping_option:1",
    "2": "shipping_option:2",
    "3": "null"
  }
}
This endpoint is intended to smooth the transition from shipping methods to shipping options. It accepts a list of shipping method IDs and returns their corresponding shipping option identifiers. Ordering of the shipping options is not guaranteed, and the response may contain null values for shipping methods that do not have a corresponding shipping option. Shipping methods that do not exist will not be returned in the response.
This API is deprecated and intended for compatibility purposes only. It may be removed in the future, so it is recommended to transition to use the Shipping options API as soon as possible.

Authorizations

​
Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Body

application/json
​
shipping_method_ids
integer[]
required

List of shipping methods to translate to shipping options.

Maximum array length: 100
Example:
[1, 2, 3]

Response

200 - application/json

List of shipping options.

The Compat Shipping Options response schema

​
data
object
Example:
{ "1": "postnl:standard", "2": null }