OR23 - Update carrier tracking information for a specific order

Request

Description

If the carrier is not registered, the complete tracking url can be provided.

Call Frequency

Recommended usage: At each order tracking information update (as soon as the seller gets the tracking number from the carrier)

Maximum usage: At each order tracking information update (as soon as the seller gets the tracking number from the carrier)

Path

order_idstringrequired

Order identifier

Bodyapplication/json

carrier_codestring

The code of a carrier. This information is mandatory for a registered carrier.

carrier_namestring

The name of a carrier. This information is mandatory for an unregistered carrier.

carrier_standard_codestring

Carrier standard code

carrier_urlstring

The tracking url of a carrier. This information is unused for registered carriers (because computed automatically). This information is optional for unregistered carriers.

tracking_numberstring

The carrier tracking number. This information is mandatory for a registered carrier with a URL requiring a tracking number.

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/orders/{order_id}/tracking' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "carrier_code": "UPS",
    "carrier_name": "UPS",
    "carrier_standard_code": "UPS",
    "carrier_url": "https://ups.com",
    "tracking_number": "5555"
  }'

Responses

No Content