OTotto
Shipments V1

Retrieve shipments.

Changed on

This endpoint can be used to retrieve the shipments for a given authorized partner.

get/v1/shipments

Request

  • Base URL
    https://api.otto.market
  • URL
    https://api.otto.market/v1/shipments
  • Auth
    HTTP bearer

Query parameters

datefromstring YYYY-MM-DD['T'HH:mm:ss.SSSXXX] required

Shipments created from this date onwards for the given authorized partner will be returned. Can be specified as either an ISO date (YYYY-MM-DD), which will be inferred to be in UTC time, or an ISO date time (YYYY-MM-DD'T'HH:mm:ss.SSSXXX).

For example, 2024-01-10 would be interpreted the same as 2024-01-10T00:00:00Z.

limitinteger

The maximum number of shipments to be returned in each response.

nextstring

The cursor which points to the next shipment that should be queried. It is used to paginate the results.

Response

OK

Example response

{
  "links": [
    {
      "href": "/v1/shipments?next=12345678&limit=25&datefrom=2019-05-02T00:00:00Z",
      "rel": "next"
    }
  ],
  "resources": [
    {
      "creationDate": "2019-10-11T07:49:12.642Z",
      "shipmentId": "101068626890",
      "trackingKey": {
        "carrier": "HERMES",
        "trackingNumber": "H1234567890123456789"
      },
      "states": [
        {
          "occurredOn": "2022-05-01T07:49:12.642Z"
        }
      ]
    }
  ]
}

Changes

  • 29ca75cdb016Revision changes
    • warning

      added the new LOOKWAY enum value to the /// response property for the response status

  • 3d020f15ab4dRevision changes
    • warning

      added the new DHL_2_MANN_HANDLING enum value to the /// response property for the response status