Skip to main content
POST
/
shop-order-statuses
/
mapping
Create or update custom status mapping for an integration
curl --request POST \
  --url https://panel.sendcloud.sc/api/v3/shop-order-statuses/mapping \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration_id": 23452345,
  "mapping": [
    {
      "status_category": "READY_TO_SEND",
      "external_id": "11"
    },
    {
      "status_category": "IN_TRANSIT",
      "external_id": "11"
    },
    {
      "status_category": "DELIVERED",
      "external_id": "12"
    },
    {
      "status_category": "CANCEL",
      "external_id": null
    }
  ]
}
'
"<unknown>"
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.

Body

application/json

Create or update the mapping of available shop order statuses onto Sendcloud's internal status category.

​
integration_id
integer
required

Sendcloud Integration ID.

Example:

23452345

​
mapping
object[]
required

Array containing available shop order statuses mapped onto Sendcloud's internal status category.

  • Create or update an existing map of available shop order statuses onto Sendcloud's internal status category for the given integration.
  • Make sure the mapping array contains objects of each Sendcloud's internal status categories.
  • Map each of Sendcloud's internal status categories onto either AvailableStatus.external_id or None.
  • Note that two external_ids may map to the same internal status category.
Required array length: 4 elements

Response

OK.