---
title: "Add new order to route"
method: PUT
path: "/Route/Id/{id}/Order"
tags: ["Route"]
---

# Add new order to route

`PUT /Route/Id/{id}/Order`

## Path parameters

- `id` string, required

## Query parameters

- `updateAddressGps` boolean
- `mergeAddresses` boolean

## Request body

- NewOrder — "*" - required fields
  - `Number` string, nullable — Order/Invoice/Job/Waybill number
  - `Id` string, nullable — Unique identifier in user accounting system
  - `Date` string, date-time, nullable — Order date, yyyy-MM-dd
  - `Type` integer — Order type: 0 - Delivery order; 1 - Collection order
  - `Shipper` string, nullable — Shipper/Supplier name
  - `Depot` string, nullable — Depot address
  - `Client` string, nullable — Required (*) Client/Customer name
  - `Address` string, nullable — Required (*) Delivery/Pickup address. Address cannot be updated for orders planned into routes
  - `AddressLat` number, double, nullable — Address GPS Latitude
  - `AddressLon` number, double, nullable — Address GPS Longitude
  - `AddressZone` string, nullable — Address zone
  - `TimeSlotFrom` string, date-time, nullable — Desired delivery/pickup time from, yyyy-MM-ddTHH:mm:ss or HH:mm:ss
  - `TimeSlotTo` string, date-time, nullable — Desired delivery/pickup time till, yyyy-MM-ddTHH:mm:ss or HH:mm:ss
  - `ServiceTime` number, double, nullable — Service Time, min. If seconds are specified value will be decimal
  - `Note` string, nullable — Notes to order
  - `ContactName` string, nullable — Customer’s contact name
  - `Phone` string, nullable — Customer’s contact phone number
  - `Email` string, nullable — Customer’s e-mail
  - `Weight` number, double, nullable — Total weight
  - `Volume` number, double, nullable — Total volume
  - `Pallets` number, double, nullable — Pallets count
  - `COD` number, double, nullable — Amount of Cash on Delivery
  - `InvoiceId` string, nullable — Invoice identifier in user accounting system
  - `CustomerReferenceId` string, nullable — Customer reference order identifier in user accounting system
  - `Barcode` string, nullable — Barcode for scanning in the mobile application
  - `ShipperId` string, nullable — Optional, unique identifier in user accounting system for shipper directory
  - `DepotId` string, nullable — Optional, unique identifier in user accounting system for depot directory
  - `ClientId` string, nullable — Optional, unique identifier in user accounting system for client directory
  - `AddressId` string, nullable — Optional, unique identifier in user accounting system for address directory
  - `GoodsList` NewOrderGoods[], nullable — Goods List in Order
    - `OrderLineId` string, nullable — Order line (goods line in the order) unique identifier in user accounting system
    - `GoodsId` string, nullable — Goods (directory) unique identifier in user accounting system
    - `GoodsName` string, nullable — Item Description - Goods, load, packaging
    - `GoodsUnit` string, nullable — Unit of measure: pcs, pkg, kg, lbs
    - `Note` string, nullable — Notes for delivery/pickup
    - `Quantity` number, double, nullable — Quantity or weight
    - `Cost` number, double, nullable — Unit price
    - `OrderLineBarcode` string, nullable — Order line (goods line in the order) barcode
    - `GoodsBarcode` string, nullable — Goods (directory) barcode
  - `CustomFields` NewCustomField[], nullable — Custom Fields
    - `Id` string, nullable — Custom Field Id
    - `Value` string, nullable — Custom Field Value in format: CheckBox - true Number - 123.45 Date - 2019-09-18 Time - 13:00 DateTime - 2019-09-18T13:45:00 Text - Text Value
  - `PickupOrder` NewPickupOrder
    - `ClientId` string, nullable — Unique identifier in user accounting system
    - `Client` string, nullable — Client/Customer name
    - `AddressId` string, nullable — Unique identifier in user accounting system
    - `Address` string, nullable — Pickup address
    - `AddressLat` number, double, nullable — Address GPS Latitude
    - `AddressLon` number, double, nullable — Address GPS Longitude
    - `AddressZone` string, nullable — Address zone
    - `ContactName` string, nullable — Customer’s contact name
    - `Phone` string, nullable — Customer’s contact phone number
    - `Email` string, nullable — Customer’s e-mail
    - `TimeSlotFrom` string, date-time, nullable — Desired pickup time from, yyyy-MM-ddTHH:mm:ss or HH:mm:ss
    - `TimeSlotTo` string, date-time, nullable — Desired pickup time till, yyyy-MM-ddTHH:mm:ss or HH:mm:ss
    - `ServiceTime` number, double, nullable — Service Time, min. If seconds are specified value will be decimal
    - `CustomFields` NewCustomField[], nullable — Custom Fields
      - `Id` string, nullable — Custom Field Id
      - `Value` string, nullable — Custom Field Value in format: CheckBox - true Number - 123.45 Date - 2019-09-18 Time - 13:00 DateTime - 2019-09-18T13:45:00 Text - Text Value
    - `COD` number, double, nullable — Amount of Cash
    - `Note` string, nullable — Notes to order
  - `Priority` string, nullable — Priority Possible values: low, normal, high
  - `TeamCode` string, nullable — Team code
  - `NotificationsPolicy` NotificationsPolicy
    - `PriorToRouteNotificationEnabled` boolean, nullable — Overrides default behavior for prior to route notifications
    - `AtRouteStartNotificationEnabled` boolean, nullable — Overrides default behavior for at route start notifications
    - `EnRouteNotificationEnabled` boolean, nullable — Overrides default behavior for en route notifications
    - `AtDepartureNotificationEnabled` boolean, nullable — Overrides default behavior for at departure notifications

## Response `202`

Order was added to route successfully

- ApiResponse — Object for all API responses, except GET (status code: 200)
  - `Status` integer, nullable — The HTTP status code for the response
  - `Title` string, nullable — A short, human-readable summary of the response
  - `Detail` string, nullable — A human-readable explanation specific to this response.

## Other responses

- `400` — One or more validation errors
- `401` — Unauthorized. Invalid X-API-KEY in the request header
- `405` — Not Allowed. Unable to add order to route. Route has been closed
- `415` — Unsupported Media Type. Invalid Content-Type in the request header. Must be application/json or application/xml
- `429` — Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min
- `500` — Internal Server Error

---

[API](https://skmtc.net/track-pod/apis/track-pod-api.md) · [All operations](https://skmtc.net/track-pod/apis/track-pod-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/track-pod/track-pod-api/versions/833e05afe46e/schema)