Skip to main content
GET
/
shop-order-statuses
/
mapping
Retrieve custom status mapping for an integration
curl --request GET \
  --url https://panel.sendcloud.sc/api/v3/shop-order-statuses/mapping \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": {
    "integration_id": 23452345,
    "mapping": [
      {
        "status_category": "READY_TO_SEND",
        "external_id": "11",
        "is_valid": true
      },
      {
        "status_category": "IN_TRANSIT",
        "external_id": "11",
        "is_valid": true
      },
      {
        "status_category": "DELIVERED",
        "external_id": null,
        "is_valid": true
      },
      {
        "status_category": "CANCEL",
        "external_id": "1",
        "is_valid": false
      }
    ]
  }
}
Only the Prestashop V2 integration is supported.

Authorizations

Authorization
string
header
required

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

Query Parameters

integration_id
integer
required

Filter response on integration_id.

Response

Custom status mapping for an integration.

Retrieve available shop order statuses mapped onto Sendcloud's internal status category for the given integration.

data
object