omnicado-mall-proxy
PUT /orders/{orderId}/tracking

Set order tracking information. Available only if order status is shipped.

⚠ Attention

Avoid using this endpoint if you are able to provide tracking while changing order status to shipped, to avoid problems with meeting your quality of service metrics.

Headers

  • X-Application-Name string

Path parameters

  • orderId integer(int64) Required

    Order identifier

Query parameters

  • client_id string Required

    Client identifier

Body Required

Tracking information

  • tracking_url string
  • tracking_number string

Responses

  • 200

    OK

    Hide headers attributes Show headers attributes
    • X-RateLimit-Limit string

      All available time windows applicable for request made, with the count of requests from smallest window as first value.

    • X-RateLimit-Remaining integer

      The smallest amount of requests left for the time window.

    • X-RateLimit-Reset integer

      Time in seconds until current window with lowest amount of requests resets

    Hide response attribute Show response attribute object
    • result object
      Hide result attributes Show result attributes object
      • code integer(int)
      • status string
PUT /orders/{orderId}/tracking 
curl \
 -X PUT https://mpapi.proxy.omnicado.com/v1/orders/89591350/tracking?client_id=yourClientId&client_id=api_token_value \
 -H "Content-Type: application/json" \
 -H "X-Application-Name: myApplicationName" \
 -d '{"tracking_url":"https://tracker.tracker/tracking/abc123","tracking_number":"abc123"}'
Request example 
# Headers
X-Application-Name: myApplicationName

# Payload
{
  "tracking_url": "https://tracker.tracker/tracking/abc123",
  "tracking_number": "abc123"
}
Request examples 
# Headers
X-Application-Name: myApplicationName

# Payload
{
  "tracking_url": "https://tracker.tracker/tracking/abc123",
  "tracking_number": "abc123"
}
Response examples (200) 
# Headers
X-RateLimit-Limit: 2875, 5750;w=86400;name="partner:my_client_id|domain:other|unit:d", 2875;w=3600;name="partner:my_client_id|domain:other|unit:h", 17250;w=60;name="partner:my_client_id|domain:other|unit:m"
X-RateLimit-Remaining: 2871
X-RateLimit-Reset: 3527

# Payload
{
  "result": {
    "code": 200,
    "status": "OK"
  }
}
Response examples (200) 
# Headers
X-RateLimit-Limit: 2875, 5750;w=86400;name="partner:my_client_id|domain:other|unit:d", 2875;w=3600;name="partner:my_client_id|domain:other|unit:h", 17250;w=60;name="partner:my_client_id|domain:other|unit:m"
X-RateLimit-Remaining: 2871
X-RateLimit-Reset: 3527

# Payload
{
  "result": {
    "code": 200,
    "status": "OK"
  }
}