Sign in

v1

latestOpenAPI 3.0.02026-07-24189145350.1 KB
Orders

Update order by id

Update order by id

patch/orders/{id}

Path parameters

idinteger required

Request body

poiIdinteger

Poi id

codestring

Order code

datestring date

Order date with the format YYYY-MM-DD

operation'PEDIDO' | 'RETIRO' | 'COBRANZA'

Order type

qtnstring

Quadminds tracking number (Track & Trace)

totalAmountnumber

Order total amount with taxes

totalAmountWithoutTaxesnumber

Order total amount without taxes

labelstring

Order label

prioritynumber

Order priority from 0 to 9

assignedDeviceIdinteger

Order assigned device id. Is used to group orders by device in the optimizer application

statusIdnumber

Status for the order

Example request

{
  "date": "2022-12-31",
  "qtn": "ABC123",
  "timeWindow": [
    {
      "from": "08:00",
      "to": "13:00"
    }
  ],
  "merchants": [
    {
      "_id": 1
    }
  ]
}

Response

Updated order

Example response

{
  "data": {
    "date": "2022-12-31",
    "qtn": "ABC123",
    "timeWindow": [
      {
        "from": "08:00",
        "to": "13:00"
      }
    ],
    "merchants": [
      {
        "_id": 1
      }
    ]
  }
}