Update Order

PATCH /orders/{order_uuid}

Update the information of an existing order

application/json

Body

  • external_id string

    The order ID generated from a third-party system such as a CRM, POS, or accounting software

  • proof_of_delivery object
    Hide proof_of_delivery attributes Show proof_of_delivery attributes
    • signature boolean

      Indicate whether to require a signature upon delivery

    • image boolean

      Indicate whether to require a picture to be taken upon delivery

  • pickup_schedule object
    Hide pickup_schedule attributes Show pickup_schedule attributes
    • from string(date-time)

      Should be in UTC timezone

      Format should match the following pattern: YYYY-MM-DD HH:MM.

    • to string(date-time)

      Should be in UTC timezone

      Format should match the following pattern: YYYY-MM-DD HH:MM.

  • delivery_schedule object
    Hide delivery_schedule attributes Show delivery_schedule attributes
    • from string(date-time)

      Should be in UTC timezone

      Format should match the following pattern: YYYY-MM-DD HH:MM.

    • to string(date-time)

      Should be in UTC timezone

      Format should match the following pattern: YYYY-MM-DD HH:MM.

  • notes string
  • source_contact object
    Hide source_contact attributes Show source_contact attributes
    • name string
    • email string(email)
    • phone string(phone)

      Contact's phone number in E.164 international format

  • destination_contact object
    Hide destination_contact attributes Show destination_contact attributes
    • name string
    • email string(email)
    • phone string(phone)

      Contact's phone number in E.164 international format

  • collections array[object]
    Hide collections attributes Show collections attributes
    • type string

      Collection's payment method

      Values are CASH, CHEQUE, or CREDIT_CARD.

    • amount number

      Minimum value is 0.

    • currency string

      Currency in ISO-3 format

  • tags array[string]

    Order Tags (array of strings)

Responses

  • • 200
    Hide response attribute Show response attribute object
PATCH /orders/{order_uuid} 
curl \
 -X PATCH https://{workspace}.fleetrunnr.com/api/v1/orders/{order_uuid} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"external_id":"4433","proof_of_delivery":{"signature":true,"image":true},"pickup_schedule":{"from":"2022-01-20 13:30","to":"2022-01-20 15:00"},"delivery_schedule":{"from":"2022-01-23 09:00","to":"2022-01-23 11:30"},"notes":"some notes here...","source_contact":{"name":"Amanda Murrin","email":"amanda.murrin@example.com","phone":"+12025550159"},"destination_contact":{"name":"Amanda Murrin","email":"amanda.murrin@example.com","phone":"+12025550159"},"collections":[{"type":"CASH","amount":120.75,"currency":"USD"}],"tags":["tag1","tag2"]}'
Request example 
{
  "external_id": "4433",
  "proof_of_delivery": {
    "signature": true,
    "image": true
  },
  "pickup_schedule": {
    "from": "2022-01-20 13:30",
    "to": "2022-01-20 15:00"
  },
  "delivery_schedule": {
    "from": "2022-01-23 09:00",
    "to": "2022-01-23 11:30"
  },
  "notes": "some notes here...",
  "source_contact": {
    "name": "Amanda Murrin",
    "email": "amanda.murrin@example.com",
    "phone": "+12025550159"
  },
  "destination_contact": {
    "name": "Amanda Murrin",
    "email": "amanda.murrin@example.com",
    "phone": "+12025550159"
  },
  "collections": [
    {
      "type": "CASH",
      "amount": 120.75,
      "currency": "USD"
    }
  ],
  "tags": [
    "tag1",
    "tag2"
  ]
}
Response examples (200) 
{
  "message": "success"
}