Orders

Change status and tracking

Secret key. Permission orders:write. Send any of status, tracking and comment. Cancelling an order copied in from another platform with a key that is not that order's own connection key gives 409: cancel it on the other platform.

patch/orders/{id}

Request

  • Base URL: https://sitesplaced.com/api/v1
  • URL: https://sitesplaced.com/api/v1/orders/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Request body

status'pending' | 'confirmed' | 'shipped' | 'out_for_delivery' | 'completed' | 'cancelled'

completed means delivered.

commentstring

Response

The updated order.

Example response

{
  "order": {
    "external_status": "processing",
    "currency": "INR",
    "risk": {
      "flags": [
        {
          "code": "bad_phone"
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.