v1

latestOpenAPI 3.0.42026-08-067441330.9 KB

Route

Add new order to route

put/Route/Id/{id}/Order

Path parameters

idstring required

Query parameters

updateAddressGpsboolean

Force update existing Lat/Lon in the Addresses directory from the payload data.

mergeAddressesboolean

Merge orders by address onto one site

Request body

Numberstring nullable

Order/Invoice/Job/Waybill number

Idstring nullable

Unique identifier in user accounting system

Datestring date-time nullable

Order date, yyyy-MM-dd

Typeinteger

Order type: 0 - Delivery order; 1 - Collection order

Shipperstring nullable

Shipper/Supplier name

Depotstring nullable

Depot address

Clientstring nullable

Required (*)

Client/Customer name

Addressstring nullable

Required (*)

Delivery/Pickup address. Address cannot be updated for orders planned into routes

AddressLatnumber double nullable

Address GPS Latitude

AddressLonnumber double nullable

Address GPS Longitude

AddressZonestring nullable

Address zone

TimeSlotFromstring date-time nullable

Desired delivery/pickup time from, yyyy-MM-ddTHH:mm:ss or HH:mm:ss

TimeSlotTostring date-time nullable

Desired delivery/pickup time till, yyyy-MM-ddTHH:mm:ss or HH:mm:ss

ServiceTimenumber double nullable

Service Time, min. If seconds are specified value will be decimal

Notestring nullable

Notes to order

ContactNamestring nullable

Customer’s contact name

Phonestring nullable

Customer’s contact phone number

Emailstring nullable

Customer’s e-mail

Weightnumber double nullable

Total weight

Volumenumber double nullable

Total volume

Palletsnumber double nullable

Pallets count

CODnumber double nullable

Amount of Cash on Delivery

InvoiceIdstring nullable

Invoice identifier in user accounting system

CustomerReferenceIdstring nullable

Customer reference order identifier in user accounting system

Barcodestring nullable

Barcode for scanning in the mobile application

ShipperIdstring nullable

Optional, unique identifier in user accounting system for shipper directory

DepotIdstring nullable

Optional, unique identifier in user accounting system for depot directory

ClientIdstring nullable

Optional, unique identifier in user accounting system for client directory

AddressIdstring nullable

Optional, unique identifier in user accounting system for address directory

Prioritystring nullable

Priority Possible values: low, normal, high

TeamCodestring nullable

Team code

Example request

{
  "Number": "cv30001-2",
  "Id": "10000345",
  "Date": "2019-02-01",
  "Shipper": "Sanitex",
  "Depot": "9 Riverside, Salford M7 1PA ",
  "Client": "Maxima",
  "Address": "2 St Josephs Crescent, Liverpool L3 3JF",
  "AddressLat": 25.290479,
  "AddressLon": 65.294049,
  "AddressZone": "Zone 1",
  "TimeSlotFrom": "2019-02-01T09:00:00",
  "TimeSlotTo": "2019-02-01T18:00:00",
  "ServiceTime": 10,
  "Note": "Only to sign Invoice",
  "ContactName": "John Doe",
  "Phone": "+37061191244",
  "Email": "X-604@maxima.com",
  "Weight": 50.5,
  "Volume": 8.54,
  "Pallets": 3.5,
  "COD": 20.45,
  "InvoiceId": "inv0002 ",
  "CustomerReferenceId": "ord123/1",
  "Barcode": "1234567890123",
  "ShipperId": "357",
  "DepotId": "1",
  "ClientId": "247",
  "AddressId": "13587",
  "GoodsList": [
    {
      "OrderLineId": "22435324",
      "GoodsId": "30495",
      "GoodsName": "Some big mystic box",
      "GoodsUnit": "pcs.",
      "Note": "ID3658AAA",
      "Quantity": 10.5,
      "Cost": 2.99,
      "OrderLineBarcode": "1234567890123",
      "GoodsBarcode": "1234567890123"
    }
  ],
  "CustomFields": [
    {
      "Id": "cf_456"
    }
  ],
  "PickupOrder": {
    "ClientId": "247",
    "Client": "Maxima",
    "AddressId": "13587",
    "Address": "2 St Josephs Crescent, Liverpool L3 3JF",
    "AddressLat": 25.290479,
    "AddressLon": 65.294049,
    "AddressZone": "Zone 1",
    "ContactName": "John Doe",
    "Phone": "+37061191244",
    "Email": "X-604@maxima.com",
    "TimeSlotFrom": "2019-02-01T09:00:00",
    "TimeSlotTo": "2019-02-01T18:00:00",
    "ServiceTime": 10,
    "CustomFields": [
      {
        "Id": "cf_456"
      }
    ],
    "COD": 20.45,
    "Note": "Only to sign Invoice"
  }
}

Response

Order was added to route successfully

Statusinteger nullable

The HTTP status code for the response

Titlestring nullable

A short, human-readable summary of the response

Detailstring nullable

A human-readable explanation specific to this response.