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

Set order status or confirm order.

When changing order status from shipping to shipped, you also must add the package tracking number and tracking url. Tracking number can contain following characters 0-9a-zA-Z-_.

When changing order status to delivered, you must add parameters delivered_at (actual date the order was delivered to the customer) and first_delivery_attempt (first attempt to deliver the order to the customer).

First delivery attempt is an optional field and it equals to delivery to the branch (order being able to be picked up by customer) when delivering to pick-up points.

ℹ NOTE

When delivering to pick-up points please mind parameter branch_id which is identifying delivery point of your carrier. In this case, address parameters (street, city, zip, country, company) equals to customer address not to delivery address.

⚠ Attention

Required fields change with status the order is being set to. Please see schemas for all combinations. To only confirm the order, do not send any status.

Body Required

  • confirmed boolean

    Information if the order is confirmed by partner or not

  • status string

    Order status (shipping, shipped, delivered, returned)

    Values are shipping, shipped, delivered, or returned.

  • first_delivery_attempt string

    Date when first attempt at delivery to the customer has been made

  • delivered_at string

    Date when order has been delivered to customer

  • tracking_number string Required

    Package tracking number. Partners can send it when changing the order status to shipped.

  • tracking_url string Required

    url for package tracking

Responses

  • 200

    OK

    Hide response attribute Show response attribute object
    • result object
      Hide result attributes Show result attributes object
      • code integer(int)
      • status string
PUT /orders/{orderId} 
curl \
 -X PUT https://mpapi.proxy.omnicado.com/v1/orders/{orderId}?client_id=api_token_value \
 -H "Content-Type: application/json" \
 -d '{"confirmed":true,"status":"shipping","first_delivery_attempt":"2018-01-13 08:13:00","delivered_at":"2018-01-14 08:13:00","tracking_number":"abc123","tracking_url":"https://www.exampletracker.com/track/abc123"}'
Request example 
{
  "confirmed": true,
  "status": "shipping",
  "first_delivery_attempt": "2018-01-13 08:13:00",
  "delivered_at": "2018-01-14 08:13:00",
  "tracking_number": "abc123",
  "tracking_url": "https://www.exampletracker.com/track/abc123"
}
Request examples 
{
  "confirmed": true,
  "status": "shipping",
  "first_delivery_attempt": "2018-01-13 08:13:00",
  "delivered_at": "2018-01-14 08:13:00",
  "tracking_number": "abc123",
  "tracking_url": "https://www.exampletracker.com/track/abc123"
}
Response examples (200) 
{
  "result": {
    "code": 200,
    "status": "OK"
  }
}
Response examples (200) 
{
  "result": {
    "code": 200,
    "status": "OK"
  }
}