Track-POD
Track-POD API

Track-POD API 2.0 is a JSON/XML REST API for delivery management. It covers eight resource families — Address, Driver, Order, RejectReason, Route, Test, Vehicle, and VehicleCheck — across 58 operations. Authentication uses an X-API-KEY header issued from Settings > Integrations > Web API. The same surface is offered against a sandbox tenant at api.sandbox.track-pod.com. Rate limits are 20 requests per second / 400 requests per minute. Restricted API keys can be scoped by IP address, HTTP method, and domain.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.4
info:
  title: Track-POD 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<br><br><b>Endpoint:</b><br>https://api.track-pod.com/<br><br><b>Request headers:</b><br><b>X-API-KEY</b> - API Key. Please find the API key in the Track-POD settings <br><b>Content-Type</b> - (POST/PUT) Request input type: <b>application/json</b> - JSON, <b>application/xml</b> - XML<br><b>Accept</b> - Response output type: <b>application/json</b> - JSON, <b>application/xml</b> - XML <br><b>Accept-Encoding</b> - Response compression: <b>gzip, deflate, br</b><br><br><b>Webhooks:</b><br>Create/Update/Delete route, Create/Update/Delete order, and more <a target=''_blank'' href=''https://track-pod.freshdesk.com/support/solutions/articles/103000049842''>How to use Webhooks?</a>'
  version: '2.0'
paths:
  /Address:
    post:
      tags:
      - Address
      summary: Add or update address
      operationId: AddAddress
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Address'
          application/xml:
            schema:
              $ref: '#/components/schemas/Address'
      responses:
        '201':
          description: Address 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: Address was updated successfully
        '400':
          description: One or more validation errors
        '401':
          description: Unauthorized. Invalid X-API-KEY in the request header
        '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
  /Driver/Id/{id}:
    get:
      tags:
      - Driver
      summary: Get driver by Track-POD unique identifier
      operationId: GetDriverById
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: A driver
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Driver'
            application/json:
              schema:
                $ref: '#/components/schemas/Driver'
            text/json:
              schema:
                $ref: '#/components/schemas/Driver'
            application/xml:
              schema:
                $ref: '#/components/schemas/Driver'
            text/xml:
              schema:
                $ref: '#/components/schemas/Driver'
        '401':
          description: Unauthorized. Invalid X-API-KEY in the request header
        '404':
          description: Not found. Driver not found
        '429':
          description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min
        '500':
          description: Internal Server Error
    delete:
      tags:
      - Driver
      summary: Delete driver by Track-POD unique identifier
      operationId: DeleteDriverById
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Driver was 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. Driver already has delivery status
        '401':
          description: Unauthorized. Invalid X-API-KEY in the request header
        '404':
          description: Not found. Driver not found
        '429':
          description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min
        '500':
          description: Internal Server Error
  /Driver/Username/{username}:
    get:
      tags:
      - Driver
      summary: Get driver by Username
      operationId: GetDriverByUsername
      parameters:
      - name: username
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A driver
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Driver'
            application/json:
              schema:
                $ref: '#/components/schemas/Driver'
            text/json:
              schema:
                $ref: '#/components/schemas/Driver'
            application/xml:
              schema:
                $ref: '#/components/schemas/Driver'
            text/xml:
              schema:
                $ref: '#/components/schemas/Driver'
        '401':
          description: Unauthorized. Invalid X-API-KEY in the request header
        '404':
          description: Not found. Driver not found
        '429':
          description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min
        '500':
          description: Internal Server Error
    delete:
      tags:
      - Driver
      summary: Delete Driver by id.
      operationId: DeleteDriverByUsername
      parameters:
      - name: username
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Driver was 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. Driver 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. Driver not found
        '429':
          description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min
        '500':
          description: Internal Server Error
  /Driver:
    get:
      tags:
      - Driver
      summary: Get drivers
      operationId: GetDrivers
      responses:
        '200':
          description: Drivers
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Driver'
                xml:
                  name: ArrayOfDriver
                  wrapped: true
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Driver'
                xml:
                  name: ArrayOfDriver
                  wrapped: true
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Driver'
                xml:
                  name: ArrayOfDriver
                  wrapped: true
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Driver'
                xml:
                  name: ArrayOfDriver
                  wrapped: true
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Driver'
                xml:
                  name: ArrayOfDriver
                  wrapped: true
        '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
    post:
      tags:
      - Driver
      summary: Add driver
      operationId: AddDriver
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewDriver'
          application/xml:
            schema:
              $ref: '#/components/schemas/NewDriver'
      responses:
        '201':
          description: Driver 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'
        '400':
          description: One or more validation errors
        '401':
          description: Unauthorized. Invalid X-API-KEY in the request header
        '405':
          description: Not Allowed. Driver already exists, Invalid home address, etc
        '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
    put:
      tags:
      - Driver
      summary: Update driver
      operationId: UpdateDriver
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDriver'
          application/xml:
            schema:
              $ref: '#/components/schemas/UpdateDriver'
      responses:
        '202':
          description: Driver was updated 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. Driver not found
        '405':
          description: Not Allowed. Invalid home address
        '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
  /Order:
    post:
      tags:
      - Order
      summary: Add unscheduled order
      operationId: AddOrder
      parameters:
      - name: updateAddressGps
        in: query
        description: Force update existing Lat/Lon in the Addresses directory from the payload data.
        schema:
          type: boolean
          default: false
      - 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/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: "<NewOrder xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">\n  <Number>cv30001-2</Number>\n  <Id>10000345</Id>\n  <Date>2019-02-01T00:00:00</Date>\n  <Type>0</Type>\n  <Shipper>Sanitex</Shipper>\n  <Depot>9 Riverside, Salford M7 1PA</Depot>\n  <Client>Maxima</Client>\n  <Address>2 St Josephs Crescent, Liverpool L3 3JF</Address>\n  <AddressLat>25.290479</AddressLat>\n  <AddressLon>65.294049</AddressLon>\n  <AddressZone>Zone 1</AddressZone>\n  <TimeSlotFrom>2019-02-01T09:00:00</TimeSlotFrom>\n  <TimeSlotTo>2019-02-01T18:00:00</TimeSlotTo>\n  <ServiceTime>10</ServiceTime>\n  <Note>Only to sign Invoice</Note>\n  <ContactName>John Doe</ContactName>\n  <Phone>+37061191244</Phone>\n  <Email>X-604@maxima.com</Email>\n  <Weight>50.5</Weight>\n  <Volume>8.54</Volume>\n  <Pallets>3.5</Pallets>\n  <COD>20.45</COD>\n  <Barcode>1234567890123</Barcode>\n  <GoodsList>\n    <NewOrderGoods>\n      <OrderLineId>22435324</OrderLineId>\n\
              \      <GoodsId>30495</GoodsId>\n      <GoodsName>Some big mystic box</GoodsName>\n      <GoodsUnit>pcs.</GoodsUnit>\n      <Note>ID3658AAA</Note>\n      <Quantity>10.5</Quantity>\n      <Cost>2.99</Cost>\n      <OrderLineBarcode>1234567890123</OrderLineBarcode>\n      <GoodsBarcode>1234567890123</GoodsBarcode>\n    </NewOrderGoods>\n  </GoodsList>\n  <CustomFields>\n    <NewCustomField>\n      <Id>cf_456</Id>\n      <Value>value</Value>\n    </NewCustomField>\n  </CustomFields>\n</NewOrder>"
      responses:
        '201':
          description: Order 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'
        '400':
          description: One or more validation errors
        '401':
          description: Unauthorized. Invalid X-API-KEY in the request header
        '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
    put:
      tags:
      - Order
      summary: Update order
      operationId: UpdateOrder
      parameters:
      - name: updateAddressGps
        in: query
        description: Force update existing Lat/Lon in the Addresses directory from the payload data.
        schema:
          type: boolean
          default: false
      - name: forceUpdate
        in: query
        description: Allows updating completed orders.
        schema:
          type: boolean
          default: false
      requestBody:
        description: ''
        content:
          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: "<NewOrder xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">\n  <Number>cv30001-2</Number>\n  <Id>10000345</Id>\n  <Date>2019-02-01T00:00:00</Date>\n  <Type>0</Type>\n  <Shipper>Sanitex</Shipper>\n  <Depot>9 Riverside, Salford M7 1PA</Depot>\n  <Client>Maxima</Client>\n  <Address>2 St Josephs Crescent, Liverpool L3 3JF</Address>\n  <AddressLat>25.290479</AddressLat>\n  <AddressLon>65.294049</AddressLon>\n  <AddressZone>Zone 1</AddressZone>\n  <TimeSlotFrom>2019-02-01T09:00:00</TimeSlotFrom>\n  <TimeSlotTo>2019-02-01T18:00:00</TimeSlotTo>\n  <ServiceTime>10</ServiceTime>\n  <Note>Only to sign Invoice</Note>\n  <ContactName>John Doe</ContactName>\n  <Phone>+37061191244</Phone>\n  <Email>X-604@maxima.com</Email>\n  <Weight>50.5</Weight>\n  <Volume>8.54</Volume>\n  <Pallets>3.5</Pallets>\n  <COD>20.45</COD>\n  <Barcode>1234567890123</Barcode>\n  <GoodsList>\n    <NewOrderGoods>\n      <OrderLineId>22435324</OrderLineId>\n\
              \      <GoodsId>30495</GoodsId>\n      <GoodsName>Some big mystic box</GoodsName>\n      <GoodsUnit>pcs.</GoodsUnit>\n      <Note>ID3658AAA</Note>\n      <Quantity>10.5</Quantity>\n      <Cost>2.99</Cost>\n      <OrderLineBarcode>1234567890123</OrderLineBarcode>\n      <GoodsBarcode>1234567890123</GoodsBarcode>\n    </NewOrderGoods>\n  </GoodsList>\n  <CustomFields>\n    <NewCustomField>\n      <Id>cf_456</Id>\n      <Value>value</Value>\n    </NewCustomField>\n  </CustomFields>\n</NewOrder>"
      responses:
        '202':
          description: Order was updated 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'
        '410':
          description: Gone. Order was permanently removed
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ApiRemovedOrderResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiRemovedOrderResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ApiRemovedOrderResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ApiRemovedOrderResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/ApiRemovedOrderResponse'
        '400':
          description: One or more validation errors
        '401':
          description: Unauthorized. Invalid X-API-KEY in the request header
        '404':
          description: Not found. Order not found
        '405':
          description: Not Allowed. The order has been processed on the mobile application
        '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
  /Order/Bulk:
    post:
      tags:
      - Order
      summary: Add unscheduled orders (the maximum is 500)
      operationId: AddOrderBulk
      parameters:
      - name: updateAddressGps
        in: query
        description: Force update existing Lat/Lon in the Addresses directory from the payload data.
        schema:
          type: boolean
          default: false
      - 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:
              type: array
              items:
                $ref: '#/components/schemas/NewOrder'
              xml:
                name: List`1
            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:
              type: array
              items:
                $ref: '#/components/schemas/NewOrder'
              xml:
                name: List`1
            example: "<ArrayOfNewOrder xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">\n  <NewOrder>\n    <Number>cv30001-2</Number>\n    <Id>10000345</Id>\n    <Date>2019-02-01T00:00:00</Date>\n    <Type>0</Type>\n    <Shipper>Sanitex</Shipper>\n    <Depot>9 Riverside, Salford M7 1PA</Depot>\n    <Client>Maxima</Client>\n    <Address>2 St Josephs Crescent, Liverpool L3 3JF</Address>\n    <AddressLat>25.290479</AddressLat>\n    <AddressLon>65.294049</AddressLon>\n    <AddressZone>Zone 1</AddressZone>\n    <TimeSlotFrom>2019-02-01T09:00:00</TimeSlotFrom>\n    <TimeSlotTo>2019-02-01T18:00:00</TimeSlotTo>\n    <ServiceTime>10</ServiceTime>\n    <Note>Only to sign Invoice</Note>\n    <ContactName>John Doe</ContactName>\n    <Phone>+37061191244</Phone>\n    <Email>X-604@maxima.com</Email>\n    <Weight>50.5</Weight>\n    <Volume>8.54</Volume>\n    <Pallets>3.5</Pallets>\n    <COD>20.45</COD>\n    <Barcode>1234567890123</Barcode>\n    <GoodsList>\n\
              \      <NewOrderGoods>\n        <OrderLineId>22435324</OrderLineId>\n        <GoodsId>30495</GoodsId>\n        <GoodsName>Some big mystic box</GoodsName>\n        <GoodsUnit>pcs.</GoodsUnit>\n        <Note>ID3658AAA</Note>\n        <Quantity>10.5</Quantity>\n        <Cost>2.99</Cost>\n        <OrderLineBarcode>1234567890123</OrderLineBarcode>\n        <GoodsBarcode>1234567890123</GoodsBarcode>\n      </NewOrderGoods>\n    </GoodsList>\n    <CustomFields>\n      <NewCustomField>\n        <Id>cf_456</Id>\n        <Value>value</Value>\n      </NewCustomField>\n    </CustomFields>\n  </NewOrder>\n</ArrayOfNewOrder>"
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrderResult'
                xml:
                  name: List`1
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrderResult'
                xml:
                  name: List`1
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrderResult'
                xml:
                  name: List`1
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrderResult'
                xml:
                  name: List`1
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrderResult'
                xml:
                  name: List`1
        '201':
          description: Orders were created successfully.
        '400':
          description: One or more validation errors
        '401':
          description: Unauthorized. Invalid X-API-KEY in the request header
        '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
  /Order/Number/{number}:
    get:
      tags:
      - Order
      summary: Get order by number
      operationId: GetOrderByNumber
      parameters:
      - name: number
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: An order
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Order'
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
            text/json:
              schema:
                $ref: '#/components/schemas/Order'
            application/xml:
              schema:
                $ref: '#/components/schemas/Order'
            text/xml:
              schema:
                $ref: '#/components/schemas/Order'
        '410':
          description: Gone. Order was permanently removed
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ApiRemovedOrderResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiRemovedOrderResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ApiRemovedOrderResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ApiRemovedOrderResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/ApiRemovedOrderResponse'
        '401':
          description: Unauthorized. Invalid X-API-KEY in the request header
        '404':
          description: Not found. Order not found
        '429':
          description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min
        '500':
          description: Internal Server Error
    delete:
      tags:
      - Order
      summary: Delete order by number
      description: Orders, that haven't arrived yet, could be deleted. Order will be deleted permanently from the system.
      operationId: DeleteOrderByNumber
      parameters:
      - name: number
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Order was 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. Order already has delivery status
        '401':
          description: Unauthorized. Invalid X-API-KEY in the request header
        '404':
          description: Not found. Order not found
        '429':
          description: Too Many Requests. Rate limit is 20 requests/sec and 400 requests/min
        '500':
          description: Internal Server Error
  /Order/Id/{id}:
    get:
      tags:
      - Order
      summary: Get order by Id
      operationId: GetOrderById
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: An order
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Order'
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
            text/json:
              schema:
                $ref: '#/components/schemas/Order'
            application/xml:
              schema:
                $ref: '#/components/schemas/Order'
            text/xml:
              schema:
                $ref: '#/components/schemas/Order'
        '410':
          description: Gone. Order

# --- truncated at 32 KB (237 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/track-pod/refs/heads/main/openapi/track-pod-openapi.yml
Track-POD API

Documentation

Specifications

Examples

Schemas & Data

Other Resources

OpenAPI Specification
