upsertCarriers - Upsert carriers

Request

Description

Use this API to share the channel's allowed list of carriers with Mirakl Connect, and keep it synchronized over time.

Important:

You must provide the complete list of carriers in a single request, any carriers not included will be deleted
If the marketplace allows it, you can add an "Other" carrier to cover unlisted carriers; otherwise, only include formally supported carriers
We recommend sharing the full list of carriers: Mirakl Connect automatically maps carriers with slight naming differences

Call Frequency

Recommended usage: When the channel's allowed list of carriers changes

Maximum usage: 1 / hour

Security

Bearer(Required scopes: )

Path

channel_idstringrequired

Unique identifier of the sales channel

Bodyapplication/jsonrequired

carriersArray of objects, [ 1 .. 5000 ] itemsrequired

List of carriers available on the channel

curl -i -X POST \
  'https://miraklconnect.com/api/channel-platform/v1/orders/channels/{channel_id}/carriers' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "carriers": [
      {
        "channel_carrier_id": "string",
        "name": "string"
      }
    ]
  }'

Responses

No Content

Response

No content