openapi: 3.0.4 info: title: Track-POD Address Route API description: 'Track-POD API enables ERP or any other system integration with Track-POD without need for any manual data input. Our API provides an easy HTTP interface to Track-POD functionality through JSON or XML

Endpoint:
https://api.track-pod.com/

Request headers:
X-API-KEY - API Key. Please find the API key in the Track-POD settings
Content-Type - (POST/PUT) Request input type: application/json - JSON, application/xml - XML
Accept - Response output type: application/json - JSON, application/xml - XML
Accept-Encoding - Response compression: gzip, deflate, br

Webhooks:
Create/Update/Delete route, Create/Update/Delete order, and more How to use Webhooks?' version: '2.0' security: - ApiKey: [] tags: - name: Route paths: /Route: post: tags: - Route summary: Add route operationId: AddRoute parameters: - name: update in: query description: Add or remove orders from the route if route already exists on this date. schema: type: boolean default: false - name: updateAddressGps in: query description: Force update existing Lat/Lon in the Addresses directory from the payload data. schema: type: boolean default: false - name: mergeAddresses in: query description: Merge orders by address onto one site schema: type: boolean default: true - name: updateGoodsPrice in: query description: Force update existing Price in the Goods directory from the payload data. schema: type: boolean default: false requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/NewRoute' application/xml: schema: $ref: '#/components/schemas/NewRoute' responses: '201': description: Route was created successfully content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '202': description: Route was updated successfully '400': description: One or more validation errors '401': description: Unauthorized. Invalid X-API-KEY in the request header '405': description: Not Allowed. Subscription plan limitation. '415': description: Unsupported Media Type. Invalid Content-Type in the request header. Must be application/json or application/xml '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min '500': description: Internal Server Error /Route/Code/{code}: put: tags: - Route summary: Update route by code operationId: UpdateRouteByCode parameters: - name: code in: path description: '' required: true schema: type: string - name: updateAddressGps in: query description: Force update existing Lat/Lon in the Addresses directory from the payload data. schema: type: boolean default: false - name: mergeAddresses in: query description: Merge orders by address onto one site schema: type: boolean default: true requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/NewRoute' application/json: schema: $ref: '#/components/schemas/NewRoute' text/json: schema: $ref: '#/components/schemas/NewRoute' application/*+json: schema: $ref: '#/components/schemas/NewRoute' application/xml: schema: $ref: '#/components/schemas/NewRoute' text/xml: schema: $ref: '#/components/schemas/NewRoute' application/*+xml: schema: $ref: '#/components/schemas/NewRoute' responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '202': description: Route was updated successfully '400': description: One or more validation errors '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not Found. Route not found '405': description: Not Allowed. Subscription plan limitation. '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min get: tags: - Route summary: Get route by code operationId: GetRouteByCode parameters: - name: code in: path required: true schema: type: string responses: '200': description: A route content: text/plain: schema: $ref: '#/components/schemas/Route' application/json: schema: $ref: '#/components/schemas/Route' text/json: schema: $ref: '#/components/schemas/Route' application/xml: schema: $ref: '#/components/schemas/Route' text/xml: schema: $ref: '#/components/schemas/Route' '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not found. Route not found '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min '500': description: Internal Server Error delete: tags: - Route summary: Delete route by code. operationId: DeleteRouteByCode parameters: - name: code in: path required: true schema: type: string - name: deleteOrders in: query schema: type: boolean default: true responses: '200': description: Route has been deleted content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '400': description: Bad Request. Route already has delivery status content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not found. Route not found '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min '500': description: Internal Server Error /Route/Id/{id}: put: tags: - Route summary: Update route by id operationId: UpdateRouteById parameters: - name: id in: path description: '' required: true schema: type: string - name: updateAddressGps in: query description: Force update existing Lat/Lon in the Addresses directory from the payload data. schema: type: boolean default: false - name: mergeAddresses in: query description: Merge orders by address onto one site schema: type: boolean default: true requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/NewRoute' application/json: schema: $ref: '#/components/schemas/NewRoute' text/json: schema: $ref: '#/components/schemas/NewRoute' application/*+json: schema: $ref: '#/components/schemas/NewRoute' application/xml: schema: $ref: '#/components/schemas/NewRoute' text/xml: schema: $ref: '#/components/schemas/NewRoute' application/*+xml: schema: $ref: '#/components/schemas/NewRoute' responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '202': description: Route was updated successfully '400': description: One or more validation errors '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not Found. Route not found '405': description: Not Allowed. Subscription plan limitation. '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min get: tags: - Route summary: Get route by id operationId: GetRouteById parameters: - name: id in: path required: true schema: type: string responses: '200': description: A route content: text/plain: schema: $ref: '#/components/schemas/Route' application/json: schema: $ref: '#/components/schemas/Route' text/json: schema: $ref: '#/components/schemas/Route' application/xml: schema: $ref: '#/components/schemas/Route' text/xml: schema: $ref: '#/components/schemas/Route' '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not found. Route not found '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min '500': description: Internal Server Error delete: tags: - Route summary: Delete route by id. operationId: DeleteRouteById parameters: - name: id in: path required: true schema: type: string - name: deleteOrders in: query schema: type: boolean default: true responses: '200': description: Route has been deleted content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '400': description: Bad Request. Route already has delivery status content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not found. Route not found '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min '500': description: Internal Server Error /Route/Code/{code}/CustomFields: patch: tags: - Route summary: Update routes custom fields by route code operationId: UpdateRouteCustomValuesByCode parameters: - name: code in: path description: Route code required: true schema: type: string requestBody: description: List of custom values for update content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/NewCustomField' xml: name: List`1 application/json: schema: type: array items: $ref: '#/components/schemas/NewCustomField' xml: name: List`1 text/json: schema: type: array items: $ref: '#/components/schemas/NewCustomField' xml: name: List`1 application/*+json: schema: type: array items: $ref: '#/components/schemas/NewCustomField' xml: name: List`1 application/xml: schema: type: array items: $ref: '#/components/schemas/NewCustomField' xml: name: List`1 text/xml: schema: type: array items: $ref: '#/components/schemas/NewCustomField' xml: name: List`1 application/*+xml: schema: type: array items: $ref: '#/components/schemas/NewCustomField' xml: name: List`1 responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '202': description: Route was updated successfully '400': description: One or more validation errors '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not Found. Route not found '405': description: Not Allowed. Subscription plan limitation. '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min /Route/Id/{id}/CustomFields: patch: tags: - Route summary: Update routes custom fields by route id operationId: UpdateRouteCustomValuesById parameters: - name: id in: path description: Route id required: true schema: type: string requestBody: description: List of custom values for update content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/NewCustomField' xml: name: List`1 application/json: schema: type: array items: $ref: '#/components/schemas/NewCustomField' xml: name: List`1 text/json: schema: type: array items: $ref: '#/components/schemas/NewCustomField' xml: name: List`1 application/*+json: schema: type: array items: $ref: '#/components/schemas/NewCustomField' xml: name: List`1 application/xml: schema: type: array items: $ref: '#/components/schemas/NewCustomField' xml: name: List`1 text/xml: schema: type: array items: $ref: '#/components/schemas/NewCustomField' xml: name: List`1 application/*+xml: schema: type: array items: $ref: '#/components/schemas/NewCustomField' xml: name: List`1 responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '202': description: Route was updated successfully '400': description: One or more validation errors '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not Found. Route wasn't found '405': description: Not Allowed. Subscription plan limitation. '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min /Route/Date/{date}: get: tags: - Route summary: Get routes by date operationId: GetRouteByDate parameters: - name: date in: path required: true schema: type: string format: date-time responses: '200': description: List of routes content: text/plain: schema: type: array items: $ref: '#/components/schemas/Route' xml: name: ArrayOfRoute wrapped: true application/json: schema: type: array items: $ref: '#/components/schemas/Route' xml: name: ArrayOfRoute wrapped: true text/json: schema: type: array items: $ref: '#/components/schemas/Route' xml: name: ArrayOfRoute wrapped: true application/xml: schema: type: array items: $ref: '#/components/schemas/Route' xml: name: ArrayOfRoute wrapped: true text/xml: schema: type: array items: $ref: '#/components/schemas/Route' xml: name: ArrayOfRoute wrapped: true '400': description: One or more validation errors '401': description: Unauthorized. Invalid X-API-KEY in the request header '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min '500': description: Internal Server Error /Route/Export/Code: get: tags: - Route summary: Get route codes for export (exported is False) operationId: GetRouteExportCode parameters: - name: status in: query description: 'Routes status: 0 - Ready; 5 - Closed' schema: type: integer format: int32 default: 5 responses: '200': description: List of codes content: text/plain: schema: type: array items: type: string xml: name: List`1 application/json: schema: type: array items: type: string xml: name: List`1 text/json: schema: type: array items: type: string xml: name: List`1 application/xml: schema: type: array items: type: string xml: name: List`1 text/xml: schema: type: array items: type: string xml: name: List`1 '400': description: One or more validation errors '401': description: Unauthorized. Invalid X-API-KEY in the request header '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min '500': description: Internal Server Error /Route/Export/Id: get: tags: - Route summary: Get route ids for export (exported is False) operationId: GetRouteExportId parameters: - name: status in: query description: 'Routes status: 0 - Ready; 5 - Closed' schema: type: integer format: int32 default: 5 responses: '200': description: List of ids content: text/plain: schema: type: array items: type: string xml: name: List`1 application/json: schema: type: array items: type: string xml: name: List`1 text/json: schema: type: array items: type: string xml: name: List`1 application/xml: schema: type: array items: type: string xml: name: List`1 text/xml: schema: type: array items: type: string xml: name: List`1 '400': description: One or more validation errors '401': description: Unauthorized. Invalid X-API-KEY in the request header '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min '500': description: Internal Server Error /Route/Export/Code/{code}: put: tags: - Route summary: Confirm route export (set exported to True) by code operationId: SetRouteExportCode parameters: - name: code in: path required: true schema: type: string responses: '202': description: Accepted content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '401': description: Unauthorized. Invalid X-API-KEY in the request header '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min '500': description: Internal Server Error /Route/Export/Id/{id}: put: tags: - Route summary: Confirm route export (set exported to True) by id operationId: SetRouteExportId parameters: - name: id in: path required: true schema: type: string responses: '202': description: Accepted content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '401': description: Unauthorized. Invalid X-API-KEY in the request header '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min '500': description: Internal Server Error /Route/Code/{code}/Order: put: tags: - Route summary: Add new order to route operationId: AddOrderToRouteByCode parameters: - name: code in: path description: '' required: true schema: type: string - name: updateAddressGps in: query description: Force update existing Lat/Lon in the Addresses directory from the payload data. schema: type: boolean default: false - name: mergeAddresses in: query description: Merge orders by address onto one site schema: type: boolean default: true requestBody: description: '' content: application/json-patch+json: schema: $ref: '#/components/schemas/NewOrder' example: Number: cv30001-2 Id: '10000345' Date: '2019-02-01T00:00:00' Type: 0 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.0 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 Barcode: '1234567890123' 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 Value: value application/json: schema: $ref: '#/components/schemas/NewOrder' example: Number: cv30001-2 Id: '10000345' Date: '2019-02-01T00:00:00' Type: 0 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.0 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 Barcode: '1234567890123' 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 Value: value text/json: schema: $ref: '#/components/schemas/NewOrder' example: Number: cv30001-2 Id: '10000345' Date: '2019-02-01T00:00:00' Type: 0 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.0 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 Barcode: '1234567890123' 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 Value: value application/*+json: schema: $ref: '#/components/schemas/NewOrder' example: Number: cv30001-2 Id: '10000345' Date: '2019-02-01T00:00:00' Type: 0 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.0 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 Barcode: '1234567890123' 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 Value: value application/xml: schema: $ref: '#/components/schemas/NewOrder' example: "\n cv30001-2\n 10000345\n 2019-02-01T00:00:00\n 0\n Sanitex\n 9 Riverside, Salford M7 1PA\n Maxima\n

2 St Josephs Crescent, Liverpool L3 3JF

\n 25.290479\n 65.294049\n Zone 1\n 2019-02-01T09:00:00\n 2019-02-01T18:00:00\n 10\n Only to sign Invoice\n John Doe\n +37061191244\n X-604@maxima.com\n 50.5\n 8.54\n 3.5\n 20.45\n 1234567890123\n \n \n 22435324\n 30495\n Some big mystic box\n pcs.\n ID3658AAA\n 10.5\n 2.99\n 1234567890123\n 1234567890123\n \n \n \n \n cf_456\n value\n \n \n" responses: '202': description: Order was added to route successfully content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '400': description: One or more validation errors '401': description: Unauthorized. Invalid X-API-KEY in the request header '405': description: Not Allowed. Unable to add order to route. Route has been closed '415': description: Unsupported Media Type. Invalid Content-Type in the request header. Must be application/json or application/xml '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min '500': description: Internal Server Error /Route/Code/{code}/Order/Number/{number}: put: tags: - Route summary: Add existing order to route operationId: MoveOrderToRouteByCodeByNumber parameters: - name: code in: path description: Route code required: true schema: type: string - name: number in: path description: Order number required: true schema: type: string - name: allowTransfer in: query description: If true allows transferring order (without delivery status) from another route schema: type: boolean default: false - name: allowReschedule in: query description: If true allows rescheduling, transferring order (with failed delivery status) from another route and clears old status schema: type: boolean default: false responses: '202': description: Order was added to route successfully content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '400': description: One or more validation errors '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not found. Route or Order not found '405': description: 'Not Allowed. Unable to add order to route. Example: order has successful delivery' '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min '500': description: Internal Server Error /Route/Code/{code}/Order/Id/{orderId}: put: tags: - Route summary: Add existing order to route operationId: MoveOrderToRouteByCodeById parameters: - name: code in: path description: Route code required: true schema: type: string - name: orderId in: path description: Order Id required: true schema: type: string - name: allowTransfer in: query description: If true allows transferring order (without delivery status) from another route schema: type: boolean default: false - name: allowReschedule in: query description: If true allows rescheduling, transferring order (with failed delivery status) from another route and clears old status schema: type: boolean default: false responses: '202': description: Order was added to route successfully content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '400': description: One or more validation errors '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not found. Route or Order not found '405': description: 'Not Allowed. Unable to add order to route. Example: order has successful delivery' '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min '500': description: Internal Server Error /Route/Id/{id}/Order/Number/{number}: put: tags: - Route summary: Add existing order to route operationId: MoveOrderToRouteByIdByNumber parameters: - name: id in: path description: Route Id required: true schema: type: string - name: number in: path description: Order number required: true schema: type: string - name: allowTransfer in: query description: If true allows transferring order (without delivery status) from another route schema: type: boolean default: false - name: allowReschedule in: query description: If true allows rescheduling, transferring order (with failed delivery status) from another route and clears old status schema: type: boolean default: false responses: '202': description: Order was added to route successfully content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '400': description: One or more validation errors '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not found. Route or Order not found '405': description: 'Not Allowed. Unable to add order to route. Example: order has successful delivery' '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min '500': description: Internal Server Error /Route/Id/{id}/Order/Id/{orderId}: put: tags: - Route summary: Add existing order to route operationId: MoveOrderToRouteByIdById parameters: - name: id in: path description: Route Id required: true schema: type: string - name: orderId in: path description: Order Id required: true schema: type: string - name: allowTransfer in: query description: If true allows transferring order (without delivery status) from another route schema: type: boolean default: false - name: allowReschedule in: query description: If true allows rescheduling, transferring order (with failed delivery status) from another route and clears old status schema: type: boolean default: false responses: '202': description: Order was added to route successfully content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '400': description: One or more validation errors '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not found. Route or Order not found '405': description: 'Not Allowed. Unable to add order to route. Example: order has successful delivery' '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min '500': description: Internal Server Error /Route/Track/Code/{code}: get: tags: - Route summary: Get route track by code operationId: GetRouteTrackByCode parameters: - name: code in: path required: true schema: type: string responses: '200': description: A route track content: text/plain: schema: $ref: '#/components/schemas/RouteTrack' application/json: schema: $ref: '#/components/schemas/RouteTrack' text/json: schema: $ref: '#/components/schemas/RouteTrack' application/xml: schema: $ref: '#/components/schemas/RouteTrack' text/xml: schema: $ref: '#/components/schemas/RouteTrack' '400': description: One or more validation errors '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not found. Route track not found '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min '500': description: Internal Server Error /Route/Track/Id/{id}: get: tags: - Route summary: Get route track by id operationId: GetRouteTrackById parameters: - name: id in: path required: true schema: type: string responses: '200': description: A route track content: text/plain: schema: $ref: '#/components/schemas/RouteTrack' application/json: schema: $ref: '#/components/schemas/RouteTrack' text/json: schema: $ref: '#/components/schemas/RouteTrack' application/xml: schema: $ref: '#/components/schemas/RouteTrack' text/xml: schema: $ref: '#/components/schemas/RouteTrack' '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not found. Route track not found '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min '500': description: Internal Server Error /Route/Start/Code/{code}: put: tags: - Route summary: Start route by code operationId: StartRouteByCode parameters: - name: code in: path description: Route code required: true schema: type: string - name: statusDate in: query description: Status date (client's local date and time) schema: type: string format: date-time responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '202': description: Route was updated successfully '400': description: One or more validation errors '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not Found. Route not found '405': description: Not Allowed. Subscription plan limitation. '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min /Route/Start/Id/{id}: put: tags: - Route summary: Start route by id. operationId: StartRouteById parameters: - name: id in: path required: true schema: type: string - name: statusDate in: query schema: type: string format: date-time responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '400': description: One or more validation errors content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '202': description: Route was updated successfully '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not Found. Route not found '405': description: Not Allowed. Subscription plan limitation. '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min /Route/Close/Code/{code}: put: tags: - Route summary: Close route by code operationId: CloseRouteByCode parameters: - name: code in: path description: Route code required: true schema: type: string - name: statusDate in: query description: Status date (client's local date and time) schema: type: string format: date-time responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '202': description: Route was updated successfully '400': description: One or more validation errors '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not Found. Route not found '405': description: Not Allowed. Subscription plan limitation. '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min /Route/Close/Id/{id}: put: tags: - Route summary: Close route by id. operationId: CloseRouteById parameters: - name: id in: path required: true schema: type: string - name: statusDate in: query schema: type: string format: date-time responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '400': description: One or more validation errors content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '202': description: Route was updated successfully '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not Found. Route not found '405': description: Not Allowed. Subscription plan limitation. '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min /Route/Ready/Code/{code}: put: tags: - Route summary: Set route ready by code. operationId: SetRouteReadyByCode parameters: - name: code in: path description: Route code required: true schema: type: string - name: statusDate in: query description: Status date (client's local date and time) schema: type: string format: date-time responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '202': description: Route was updated successfully '400': description: One or more validation errors '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not Found. Route not found '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min /Route/Ready/Id/{id}: put: tags: - Route summary: Set route ready by id. operationId: SetRouteReadyById parameters: - name: id in: path required: true schema: type: string - name: statusDate in: query schema: type: string format: date-time responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '400': description: One or more validation errors content: text/plain: schema: $ref: '#/components/schemas/ApiResponse' application/json: schema: $ref: '#/components/schemas/ApiResponse' text/json: schema: $ref: '#/components/schemas/ApiResponse' application/xml: schema: $ref: '#/components/schemas/ApiResponse' text/xml: schema: $ref: '#/components/schemas/ApiResponse' '202': description: Route was updated successfully '401': description: Unauthorized. Invalid X-API-KEY in the request header '404': description: Not Found. Route not found '405': description: Not Allowed. Subscription plan limitation. '429': description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min components: schemas: Vehicle: type: object properties: Number: maxLength: 30 minLength: 0 type: string description: Number nullable: true example: XXX777 CarrierCode: maxLength: 255 minLength: 0 type: string description: Carrier Code nullable: true example: 31 Carrier: maxLength: 255 minLength: 0 type: string description: Carrier nullable: true example: Big Logistics Weight: type: number description: Capacity Weight format: double nullable: true example: 10000 Volume: type: number description: Capacity Volume format: double nullable: true example: 14.5 Pallets: type: number description: Capacity Pallets format: double nullable: true example: 16 additionalProperties: false xml: name: Vehicle NotificationsPolicy: type: object properties: PriorToRouteNotificationEnabled: type: boolean description: Overrides default behavior for prior to route notifications nullable: true AtRouteStartNotificationEnabled: type: boolean description: Overrides default behavior for at route start notifications nullable: true EnRouteNotificationEnabled: type: boolean description: Overrides default behavior for en route notifications nullable: true AtDepartureNotificationEnabled: type: boolean description: Overrides default behavior for at departure notifications nullable: true additionalProperties: false xml: name: NotificationsPolicy Source: enum: - Web - File - DupRoute - DupOrder - WebApi - ShopifyIntegration - WooCommerceIntegration - MagentoIntegration - ZapierIntegration - QuickBooksIntegration - XeroIntegration - EbayIntegration - Driver - UnleashedIntegration - MyobIntegration - LiveTracking - Routing type: string NewPickupOrder: type: object properties: ClientId: maxLength: 50 minLength: 0 type: string description: Unique identifier in user accounting system nullable: true example: 247 Client: maxLength: 255 minLength: 0 type: string description: Client/Customer name nullable: true example: Maxima AddressId: maxLength: 50 minLength: 0 type: string description: Unique identifier in user accounting system nullable: true example: 13587 Address: maxLength: 255 minLength: 0 type: string description: Pickup address nullable: true example: 2 St Josephs Crescent, Liverpool L3 3JF AddressLat: type: number description: Address GPS Latitude format: double nullable: true example: 25.290479 AddressLon: type: number description: Address GPS Longitude format: double nullable: true example: 65.294049 AddressZone: maxLength: 100 minLength: 0 type: string description: Address zone nullable: true example: Zone 1 ContactName: maxLength: 255 minLength: 0 type: string description: Customer’s contact name nullable: true example: John Doe Phone: maxLength: 50 minLength: 0 type: string description: Customer’s contact phone number nullable: true example: '+37061191244' Email: maxLength: 255 minLength: 0 type: string description: Customer’s e-mail nullable: true example: X-604@maxima.com TimeSlotFrom: type: string description: Desired pickup time from, yyyy-MM-ddTHH:mm:ss or HH:mm:ss format: date-time nullable: true example: '2019-02-01T09:00:00' TimeSlotTo: type: string description: Desired pickup time till, yyyy-MM-ddTHH:mm:ss or HH:mm:ss format: date-time nullable: true example: '2019-02-01T18:00:00' ServiceTime: type: number description: 'Service Time, min. If seconds are specified value will be decimal' format: double nullable: true example: 10 CustomFields: type: array items: $ref: '#/components/schemas/NewCustomField' description: Custom Fields nullable: true xml: name: CustomFields wrapped: true COD: type: number description: Amount of Cash format: double nullable: true example: 20.45 Note: maxLength: 500 minLength: 0 type: string description: Notes to order nullable: true example: Only to sign Invoice additionalProperties: false xml: name: NewPickupOrder RouteTrack: type: object properties: TrackPoints: type: array items: $ref: '#/components/schemas/RouteTrackPoint' description: List of track points nullable: true xml: name: TrackPoints wrapped: true additionalProperties: false xml: name: RouteTrack NewRoute: type: object properties: Code: maxLength: 50 minLength: 0 type: string description: Route code/number nullable: true example: R0001234 Id: maxLength: 50 minLength: 0 type: string description: Unique identifier in user accounting system nullable: true example: 1234 Date: type: string description: Route date, yyyy-MM-dd format: date-time nullable: true example: '2019-02-01' StartTimePlan: type: string description: Planned Start Time, yyyy-MM-ddTHH:mm:ss or HH:mm format: date-time nullable: true example: '13:00' DepotId: maxLength: 50 minLength: 0 type: string description: Unique identifier in user accounting system nullable: true example: 1 Depot: maxLength: 255 minLength: 0 type: string description: Depot address nullable: true example: 9 Riverside, Salford M7 1PA StartFromDepot: type: boolean description: Start route from depot nullable: true example: true ReturnToDepot: type: boolean description: Return to depot nullable: true example: true DriverLogin: maxLength: 50 minLength: 0 type: string description: Driver's login nullable: true example: 'RT567 ' DriverPassword: maxLength: 50 minLength: 0 type: string description: Driver’s password nullable: true example: 1 DriverName: maxLength: 100 minLength: 0 type: string description: Driver’s First Name and Last Name nullable: true example: Peter G. DriverVehicle: maxLength: 100 minLength: 0 type: string description: Driver’s vehicle license plate number nullable: true example: FCU 819 Vehicle: $ref: '#/components/schemas/Vehicle' Orders: type: array items: $ref: '#/components/schemas/NewOrder' nullable: true xml: name: Orders wrapped: true CustomFields: type: array items: $ref: '#/components/schemas/NewCustomField' description: Custom Fields nullable: true xml: name: CustomFields wrapped: true RouteDate: type: string format: date-time readOnly: true additionalProperties: false xml: name: NewRoute LoadStatus: enum: - NotLoaded - Loaded - Scanned type: string Goods: type: object properties: OrderLineId: type: string description: Order line (goods line in the order) unique identifier in user accounting system nullable: true example: 22435324 GoodsId: type: string description: Goods (directory) unique identifier in user accounting system nullable: true example: 30495 GoodsName: type: string description: Item Description - Goods, load, packaging nullable: true example: Some big mystic box GoodsUnit: type: string description: 'Unit of measure: pcs, pkg, kg, lbs' nullable: true example: pcs. Note: type: string description: Notes for delivery/pickup nullable: true example: ID3658AAA Quantity: type: number description: Quantity or weight format: double nullable: true example: 10.5 QuantityFact: type: number description: Quantity or weight at fact(accepted quantity/actual quantity) format: double nullable: true example: 9.5 Cost: type: number description: Unit price format: double nullable: true example: 2.99 RejectReason: type: string description: Reject reason for goods nullable: true example: Out Of Time HasPhoto: type: boolean description: Photo attached nullable: true example: true Photos: type: array items: type: string description: Array of links for download jpg file (each link is available for 24h from API call) nullable: true xml: name: Photos example: - https://image.track-pod.com/... OrderLineBarcode: type: string description: Order line (goods line in the order) barcode nullable: true example: 1234567890123 GoodsBarcode: type: string description: Goods (directory) barcode nullable: true example: 1234567890123 Scanned: type: boolean description: Goods is scanned in the mobile application nullable: true example: false LoadStatus: type: string description: 'Status code: none; loaded; not-loaded;' nullable: true example: loaded LoadCheckScanRejectReason: type: string description: Reject reason for goods' scanning when order is loaded nullable: true example: Barcode is Damaged ScanRejectReason: type: string description: Reject reason for goods' scanning nullable: true example: Barcode is Damaged additionalProperties: false xml: name: Goods PickupOrder: type: object properties: Id_DocShipment: type: integer format: int32 Type: type: integer description: 'Order type: 0 - Delivery order; 1 - Collection order' format: int32 example: 0 ClientId: type: string description: Unique identifier in user accounting system nullable: true example: 247 Client: type: string description: Client/Customer name nullable: true example: Maxima AddressId: type: string description: Unique identifier in user accounting system nullable: true example: 13587 Address: type: string description: Delivery/Pickup address nullable: true example: 2 St Josephs Crescent, Liverpool L3 3JF AddressLat: type: number description: Address GPS Latitude format: double nullable: true example: 25.290479 AddressLon: type: number description: Address GPS Longitude format: double nullable: true example: 65.294049 AddressZone: type: string description: Address zone nullable: true example: Zone 1 ContactName: type: string description: Customer’s contact name nullable: true example: John Doe Phone: type: string description: Customer’s contact phone number nullable: true example: '+37061191244' Email: type: string description: Customer’s e-mail nullable: true example: X-604@maxima.com TimeSlotFrom: type: string description: Desired delivery/pickup time from, yyyy-MM-ddTHH:mm:ss or HH:mm:ss format: date-time nullable: true example: '2019-02-01T09:00:00' TimeSlotTo: type: string description: Desired delivery/pickup time till, yyyy-MM-ddTHH:mm:ss or HH:mm:ss format: date-time nullable: true example: '2019-02-01T18:00:00' ServiceTime: type: number description: 'Desired service time, min. If seconds are specified value will be decimal' format: double nullable: true example: 10 CustomFields: type: array items: $ref: '#/components/schemas/CustomField' description: List of custom fields nullable: true xml: name: CustomFields wrapped: true Note: type: string description: Notes to order nullable: true example: Only to sign Invoice COD: type: number description: Amount of Cash on Delivery format: double example: 20.45 CODActual: type: string description: Collected Paid Amount from a Client nullable: true example: 20.5 StatusId: type: integer description: 'Status code: 1 - In Progress; 2 - Not delivered/Not collected (site issues); 3 - Delivered/Collected; 4 - Partially; 5 - Not delivered/Not collected (order issues)' format: int32 nullable: true example: 3 Status: type: string description: Status description nullable: true example: Delivered StatusLat: type: number description: Status GPS Latitude format: double nullable: true example: 25.290479 StatusLon: type: number description: Status GPS Longitude format: double nullable: true example: 65.294049. DriverComment: type: string description: Drivers comment from mobile application nullable: true example: The customer was angry for being late RejectReasonId: type: integer format: int32 nullable: true RejectReason: type: string description: Reject reason for order nullable: true example: Out Of Time ScanReasonId: type: integer format: int32 nullable: true ScanRejectReason: type: string description: Reject reason for order's scanning nullable: true example: Barcode is Damaged LoadCheckScanReasonId: type: integer format: int32 nullable: true LoadCheckScanRejectReason: type: string description: Reject reason for order's scanning when the order is loaded nullable: true example: Barcode is Damaged SignatureName: type: string description: Name of the person who signed nullable: true example: Andrew Bart HasSignaturePhoto: type: boolean description: Signature attached nullable: true example: true SignaturePhotos: type: array items: type: string description: Array of links for download jpg file (each link is available for 24h from API call) nullable: true xml: name: SignaturePhotos example: - https://image.track-pod.com/... HasPhoto: type: boolean description: Photo attached nullable: true example: false Photos: type: array items: type: string description: Array of links for download jpg file (each link is available for 24h from API call) nullable: true xml: name: Photos example: - https://image.track-pod.com/... HasRoutePointPhoto: type: boolean nullable: true StatusDate: type: string description: Status date format: date-time nullable: true example: '2019-02-01T15:31:00' PlanTime: type: integer format: int32 nullable: true PlanTimeDep: type: integer format: int32 nullable: true PlanServiceTime: type: integer format: int32 nullable: true ETA: type: string description: Estimated time of arrival format: date-time nullable: true example: '2019-02-01T15:27:00' UpdatedETA: type: string description: Updated estimated time of arrival format: date-time nullable: true example: '2019-02-01T15:35:00' RouteDate: type: string description: Route date format: date-time nullable: true example: '2019-02-01T00:00:00' ArrivedDate: type: string description: Date of arrival format: date-time nullable: true example: '2019-02-01T15:25:00' DepartedDate: type: string description: Date of Departure format: date-time nullable: true example: '2019-02-01T15:31:00' ReportUrl: type: string description: Link to the PDF order delivery note (available within 1 hour from the API call) nullable: true example: Paid feature, please contact support for details Barcode: type: string description: Barcode nullable: true example: 1234567890123 Scanned: type: boolean description: Order is scanned in the mobile application nullable: true example: false FeedbackRating: type: number description: Feedback Rating from mobile application format: double nullable: true example: 5 TrackKey: type: string description: Key for tracking order format: uuid readOnly: true example: 3F2504E0-4F89-11D3-9A0C-0305E82C3301 deprecated: true TrackId: type: string description: Id for tracking order format: uuid example: 3F2504E0-4F89-11D3-9A0C-0305E82C3301 TrackLink: type: string description: Link for tracking order nullable: true example: https://web.track-pod.com/track?id=d8662b19-ece7-4cda-baa3-c711ade5ad15 LoadStatusId: $ref: '#/components/schemas/LoadStatus' HasLoadSignature: type: boolean nullable: true LoadStatus: type: string description: 'Status code: none; loaded; not-loaded;' nullable: true example: loaded LoadDate: type: string description: Date of Loading format: date-time nullable: true example: '2019-02-01T15:31:00' LoadSignaturePhotos: type: array items: type: string description: Array of links for download jpg file (each link is available for 24h from API call) nullable: true xml: name: LoadSignaturePhotos wrapped: true ChangeDate: type: string format: date-time AddressNote: type: string description: Address note nullable: true example: Beware of the dog ClientNote: type: string description: Client note nullable: true example: Very nice person CustomFieldsStr: type: string nullable: true CancelledStatus: type: integer format: int32 RescheduledTimes: type: integer description: Order rescheduled times format: int32 nullable: true example: 1 additionalProperties: false xml: name: PickupOrder Route: type: object properties: Code: type: string description: Route code/number nullable: true example: R0001234 Id: type: string description: Unique identifier in user accounting system nullable: true example: 1234 Date: type: string description: Route date, yyyy-MM-dd format: date-time example: '2019-02-01' DepotId: type: string description: Unique identifier in user accounting system nullable: true example: 1 Depot: type: string description: Depot address nullable: true example: '9 Riverside, Salford M7 1PA ' StartFromDepot: type: boolean description: Start route from depot nullable: true example: true ReturnToDepot: type: boolean description: Return to depot nullable: true example: true DriverLogin: type: string description: Driver's login nullable: true example: 'RT567 ' DriverName: type: string description: Driver’s First Name and Last Name nullable: true example: Peter G. DriverNumber: type: integer description: Driver Number format: int32 example: 2 DriverVehicle: type: string description: Vehicle license plate number nullable: true example: FCU 819 StartDate: type: string description: Route start time format: date-time nullable: true example: '2019-02-01T8:01:23' CloseDate: type: string description: Route finish time format: date-time nullable: true example: '2019-02-01T18:32:47' Track: type: number description: Track distance, m format: double nullable: true example: 123158.1 Priority: type: integer description: Route priority format: int32 nullable: true example: 99 LocationLat: type: number description: Current GPS Latitude format: double nullable: true example: 25.290479 LocationLon: type: number description: Current GPS Longitude format: double nullable: true example: 65.294049 StartTimePlan: type: string description: Planned Start Time format: date-time nullable: true example: '2019-02-01T18:32:47' FinishTimePlan: type: string description: Planned Finish Time format: date-time nullable: true example: '2019-02-01T20:32:47' DistancePlan: type: number description: Planned distance, m format: double nullable: true example: 12340 CostPlan: type: number description: Plan route cost format: double nullable: true example: 155.2 CostActual: type: number description: Actual route cost format: double nullable: true example: 165.32 CreateDateUtc: type: string description: Route creation date (UTC) format: date-time example: '2019-02-01T13:32:47' Orders: type: array items: $ref: '#/components/schemas/Order' nullable: true xml: name: Orders wrapped: true Status: $ref: '#/components/schemas/RouteStatus' Xd: type: boolean description: Cross-Docking route example: false Vehicle: $ref: '#/components/schemas/Vehicle' CustomFields: type: array items: $ref: '#/components/schemas/CustomField' description: List of custom fields nullable: true xml: name: CustomFields wrapped: true additionalProperties: false xml: name: Route NewCustomField: type: object properties: Id: pattern: cf_\d+ type: string description: Custom Field Id nullable: true example: cf_456 Value: type: string description: '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' nullable: true additionalProperties: false xml: name: NewCustomField RouteStatus: enum: - Draft - Ready - Loaded - InProgress - Closed type: string NewOrderGoods: type: object properties: OrderLineId: maxLength: 50 minLength: 0 type: string description: Order line (goods line in the order) unique identifier in user accounting system nullable: true example: 22435324 GoodsId: maxLength: 50 minLength: 0 type: string description: Goods (directory) unique identifier in user accounting system nullable: true example: 30495 GoodsName: maxLength: 255 minLength: 0 type: string description: Item Description - Goods, load, packaging nullable: true example: Some big mystic box GoodsUnit: maxLength: 50 minLength: 0 type: string description: 'Unit of measure: pcs, pkg, kg, lbs' nullable: true example: pcs. Note: maxLength: 255 minLength: 0 type: string description: Notes for delivery/pickup nullable: true example: ID3658AAA Quantity: type: number description: Quantity or weight format: double nullable: true example: 10.5 Cost: type: number description: Unit price format: double nullable: true example: 2.99 OrderLineBarcode: maxLength: 128 minLength: 0 type: string description: Order line (goods line in the order) barcode nullable: true example: 1234567890123 GoodsBarcode: maxLength: 128 minLength: 0 type: string description: Goods (directory) barcode nullable: true example: 1234567890123 additionalProperties: false description: '"*" - required fields' xml: name: NewOrderGoods NewOrder: type: object properties: Number: maxLength: 50 minLength: 0 type: string description: Order/Invoice/Job/Waybill number nullable: true example: cv30001-2 Id: maxLength: 50 minLength: 0 type: string description: Unique identifier in user accounting system nullable: true example: 10000345 Date: type: string description: Order date, yyyy-MM-dd format: date-time nullable: true example: '2019-02-01' Type: maximum: 1 minimum: 0 type: integer description: 'Order type: 0 - Delivery order; 1 - Collection order' format: int32 example: 0 Shipper: maxLength: 255 minLength: 0 type: string description: Shipper/Supplier name nullable: true example: Sanitex Depot: maxLength: 255 minLength: 0 type: string description: Depot address nullable: true example: '9 Riverside, Salford M7 1PA ' Client: maxLength: 255 minLength: 0 type: string description: "Required (*) \n\nClient/Customer name" nullable: true example: Maxima Address: maxLength: 255 minLength: 0 type: string description: "Required (*) \n\nDelivery/Pickup address. Address cannot be updated for orders planned into routes" nullable: true example: 2 St Josephs Crescent, Liverpool L3 3JF AddressLat: type: number description: Address GPS Latitude format: double nullable: true example: 25.290479 AddressLon: type: number description: Address GPS Longitude format: double nullable: true example: 65.294049 AddressZone: maxLength: 100 minLength: 0 type: string description: Address zone nullable: true example: Zone 1 TimeSlotFrom: type: string description: Desired delivery/pickup time from, yyyy-MM-ddTHH:mm:ss or HH:mm:ss format: date-time nullable: true example: '2019-02-01T09:00:00' TimeSlotTo: type: string description: Desired delivery/pickup time till, yyyy-MM-ddTHH:mm:ss or HH:mm:ss format: date-time nullable: true example: '2019-02-01T18:00:00' ServiceTime: type: number description: 'Service Time, min. If seconds are specified value will be decimal' format: double nullable: true example: 10 Note: maxLength: 500 minLength: 0 type: string description: Notes to order nullable: true example: Only to sign Invoice ContactName: maxLength: 255 minLength: 0 type: string description: Customer’s contact name nullable: true example: John Doe Phone: maxLength: 50 minLength: 0 type: string description: Customer’s contact phone number nullable: true example: '+37061191244' Email: maxLength: 255 minLength: 0 type: string description: Customer’s e-mail nullable: true example: X-604@maxima.com Weight: type: number description: Total weight format: double nullable: true example: 50.5 Volume: type: number description: Total volume format: double nullable: true example: 8.54 Pallets: type: number description: Pallets count format: double nullable: true example: 3.5 COD: type: number description: Amount of Cash on Delivery format: double nullable: true example: 20.45 InvoiceId: maxLength: 50 minLength: 0 type: string description: Invoice identifier in user accounting system nullable: true example: 'inv0002 ' CustomerReferenceId: maxLength: 50 minLength: 0 type: string description: Customer reference order identifier in user accounting system nullable: true example: ord123/1 Barcode: maxLength: 128 minLength: 0 type: string description: Barcode for scanning in the mobile application nullable: true example: 1234567890123 ShipperId: maxLength: 50 minLength: 0 type: string description: Optional, unique identifier in user accounting system for shipper directory nullable: true example: 357 DepotId: maxLength: 50 minLength: 0 type: string description: Optional, unique identifier in user accounting system for depot directory nullable: true example: 1 ClientId: maxLength: 50 minLength: 0 type: string description: Optional, unique identifier in user accounting system for client directory nullable: true example: 247 AddressId: maxLength: 50 minLength: 0 type: string description: Optional, unique identifier in user accounting system for address directory nullable: true example: 13587 GoodsList: type: array items: $ref: '#/components/schemas/NewOrderGoods' description: Goods List in Order nullable: true xml: name: GoodsList wrapped: true CustomFields: type: array items: $ref: '#/components/schemas/NewCustomField' description: Custom Fields nullable: true xml: name: CustomFields wrapped: true PickupOrder: $ref: '#/components/schemas/NewPickupOrder' Priority: type: string description: 'Priority Possible values: low, normal, high' nullable: true TeamCode: type: string description: Team code nullable: true NotificationsPolicy: $ref: '#/components/schemas/NotificationsPolicy' additionalProperties: false description: '"*" - required fields' xml: name: NewOrder CustomField: type: object properties: Id: type: string description: Custom Field Id nullable: true example: cf_123 Label: type: string description: Custom Field Label nullable: true Value: description: Custom Field Value. Format depends on Custom field type. nullable: true xml: name: Value example: Text Value additionalProperties: false xml: name: CustomField RouteTrackPoint: type: object properties: Lat: type: number description: Latitude format: double example: 22 Lng: type: number description: Longitude format: double example: 33 Speed: type: number description: Speed, m/s format: double example: 50 Date: type: string description: Date format: date-time example: '2019-02-01T18:32:47' additionalProperties: false xml: name: RouteTrackPoint Order: type: object properties: Number: type: string description: Order/Invoice/Job/Waybill number nullable: true example: cv30001-2 Id: type: string description: Unique identifier in user accounting system nullable: true example: 10000345 Date: type: string description: Order date, yyyy-MM-dd format: date-time example: '2019-02-01T00:00:00' SeqNumber: type: integer description: Scheduled sequence in the route format: int32 nullable: true example: 2 RouteNumber: type: string description: Route number nullable: true example: R000123 RoutePriority: type: integer description: Route priority format: int32 nullable: true example: 10 RouteStatus: $ref: '#/components/schemas/RouteStatus' DriverLogin: type: string description: Login of Driver nullable: true example: ds45 DriverName: type: string description: Name of Driver nullable: true example: Dilan DriverNumber: type: integer description: Driver Number format: int32 nullable: true example: 2 DriverVehicle: type: string description: Vehicle license plate number nullable: true example: FCU 819 ShipperId: type: string description: Unique identifier in user accounting system nullable: true example: 357 Shipper: type: string description: Shipper/Supplier name nullable: true example: Sanitex DepotId: type: string description: Unique identifier in user accounting system nullable: true example: 1 Depot: type: string description: Depot address nullable: true example: 9 Riverside, Salford M7 1PA Weight: type: number description: Total weight format: double example: 50.5 Volume: type: number description: Total volume format: double example: 8.54 Pallets: type: number description: Pallets count format: double example: 3.5 InvoiceId: type: string description: Invoice identifier in user accounting system nullable: true example: 'inv0002 ' CustomerReferenceId: type: string description: Customer reference order identifier in user accounting system nullable: true example: ord123/1 GoodsList: type: array items: $ref: '#/components/schemas/Goods' description: Goods List in Order nullable: true xml: name: GoodsList wrapped: true PickupOrder: $ref: '#/components/schemas/PickupOrder' CreateSource: $ref: '#/components/schemas/Source' DistanceFromDepotPlan: type: number description: Planned distance from depot, m format: double nullable: true example: 12340 SeqNumberDriver: type: integer description: Updated sequence by driver in the route format: int32 nullable: true example: 2 DeliveryInstructions: type: string description: Delivery Instructions from live-tracking page nullable: true example: Door code is 1234 Pin: type: string description: Confirmation pin code nullable: true readOnly: true example: 1234 AddressNote: type: string description: Address note nullable: true example: Beware of the dog ClientNote: type: string description: Client note nullable: true example: Very nice person CreateDateUtc: type: string description: Order creation date (UTC) format: date-time example: '2019-02-01T13:32:47' Priority: type: string description: 'Priority values: low, normal, high' nullable: true readOnly: true TeamCode: type: string description: Team code nullable: true Feedback: type: string description: Feedback nullable: true example: Great service! NotificationsPolicy: $ref: '#/components/schemas/NotificationsPolicy' RouteDate: type: string description: Route date format: date-time nullable: true example: '2019-02-01T00:00:00' Type: type: integer description: 'Order type: 0 - Delivery order; 1 - Collection order' format: int32 example: 0 ClientId: type: string description: Unique identifier in user accounting system nullable: true example: 247 Client: type: string description: Client/Customer name nullable: true example: Maxima AddressId: type: string description: Unique identifier in user accounting system nullable: true example: 13587 Address: type: string description: Delivery/Pickup address nullable: true example: 2 St Josephs Crescent, Liverpool L3 3JF AddressLat: type: number description: Address GPS Latitude format: double nullable: true example: 25.290479 AddressLon: type: number description: Address GPS Longitude format: double nullable: true example: 65.294049 AddressZone: type: string description: Address zone nullable: true example: Zone 1 TimeSlotFrom: type: string description: Desired delivery/pickup time from, yyyy-MM-ddTHH:mm:ss or HH:mm:ss format: date-time nullable: true example: '2019-02-01T09:00:00' TimeSlotTo: type: string description: Desired delivery/pickup time till, yyyy-MM-ddTHH:mm:ss or HH:mm:ss format: date-time nullable: true example: '2019-02-01T18:00:00' ServiceTime: type: number description: 'Desired service time, min. If seconds are specified value will be decimal' format: double nullable: true example: 10 Note: type: string description: Notes to order nullable: true example: Only to sign Invoice ContactName: type: string description: Customer’s contact name nullable: true example: John Doe Phone: type: string description: Customer’s contact phone number nullable: true example: '+37061191244' Email: type: string description: Customer’s e-mail nullable: true example: X-604@maxima.com COD: type: number description: Amount of Cash on Delivery format: double example: 20.45 CODActual: type: string description: Collected Paid Amount from a Client nullable: true example: 20.5 StatusId: type: integer description: 'Status code: 1 - In Progress; 2 - Not delivered/Not collected (site issues); 3 - Delivered/Collected; 4 - Partially; 5 - Not delivered/Not collected (order issues)' format: int32 nullable: true example: 3 Status: type: string description: Status description nullable: true example: Delivered StatusLat: type: number description: Status GPS Latitude format: double nullable: true example: 25.290479 StatusLon: type: number description: Status GPS Longitude format: double nullable: true example: 65.294049. DriverComment: type: string description: Drivers comment from mobile application nullable: true example: The customer was angry for being late RejectReason: type: string description: Reject reason for order nullable: true example: Out Of Time LoadCheckScanRejectReason: type: string description: Reject reason for order's scanning when the order is loaded nullable: true example: Barcode is Damaged ScanRejectReason: type: string description: Reject reason for order's scanning nullable: true example: Barcode is Damaged SignatureName: type: string description: Name of the person who signed nullable: true example: Andrew Bart HasSignaturePhoto: type: boolean description: Signature attached nullable: true example: true SignaturePhotos: type: array items: type: string description: Array of links for download jpg file (each link is available for 24h from API call) nullable: true xml: name: SignaturePhotos example: - https://image.track-pod.com/... HasPhoto: type: boolean description: Photo attached nullable: true example: false Photos: type: array items: type: string description: Array of links for download jpg file (each link is available for 24h from API call) nullable: true xml: name: Photos example: - https://image.track-pod.com/... StatusDate: type: string description: Status date format: date-time nullable: true example: '2019-02-01T15:31:00' ETA: type: string description: Estimated time of arrival format: date-time nullable: true example: '2019-02-01T15:27:00' UpdatedETA: type: string description: Updated estimated time of arrival format: date-time nullable: true example: '2019-02-01T15:35:00' ArrivedDate: type: string description: Date of arrival format: date-time nullable: true example: '2019-02-01T15:25:00' DepartedDate: type: string description: Date of Departure format: date-time nullable: true example: '2019-02-01T15:31:00' ReportUrl: type: string description: Link to the PDF order delivery note (available within 1 hour from the API call) nullable: true example: Paid feature, please contact support for details CustomFields: type: array items: $ref: '#/components/schemas/CustomField' description: List of custom fields nullable: true xml: name: CustomFields wrapped: true Barcode: type: string description: Barcode nullable: true example: 1234567890123 Scanned: type: boolean description: Order is scanned in the mobile application nullable: true example: false FeedbackRating: type: number description: Feedback Rating from mobile application format: double nullable: true example: 5 TrackKey: type: string description: Key for tracking order format: uuid readOnly: true example: 3F2504E0-4F89-11D3-9A0C-0305E82C3301 deprecated: true TrackId: type: string description: Id for tracking order format: uuid example: 3F2504E0-4F89-11D3-9A0C-0305E82C3301 TrackLink: type: string description: Link for tracking order nullable: true example: https://web.track-pod.com/track?id=d8662b19-ece7-4cda-baa3-c711ade5ad15 LoadStatus: type: string description: 'Status code: none; loaded; not-loaded;' nullable: true example: loaded LoadDate: type: string description: Date of Loading format: date-time nullable: true example: '2019-02-01T15:31:00' LoadSignaturePhotos: type: array items: type: string description: Array of links for download jpg file (each link is available for 24h from API call) nullable: true xml: name: LoadSignaturePhotos wrapped: true ChangeDate: type: string format: date-time RescheduledTimes: type: integer description: Order rescheduled times format: int32 nullable: true example: 1 additionalProperties: false xml: name: Order ApiResponse: type: object properties: Status: type: integer description: The HTTP status code for the response format: int32 nullable: true Title: type: string description: A short, human-readable summary of the response nullable: true Detail: type: string description: A human-readable explanation specific to this response. nullable: true additionalProperties: false description: 'Object for all API responses, except GET (status code: 200)' xml: name: ApiResponse securitySchemes: ApiKey: type: apiKey description: Please enter API key into field name: X-API-KEY in: header