OTotto
Shipments V1

Retrieve shipment by carrier and tracking number.

Changed on

This endpoint can be used to retrieve a shipment by carrier and tracking number.

get/v1/shipments/carriers/{carrier}/trackingnumbers/{trackingNumber}

Request

  • Base URL
    https://api.otto.market
  • URL
    https://api.otto.market/v1/shipments/carriers/{carrier}/trackingnumbers/{trackingNumber}
  • Auth
    HTTP bearer

Path parameters

carrier'DHL' | 'DHL_EXPRESS' | 'DPD' | 'GLS' | 'HERMES' | 'UPS' | 'ABIKS' | 'AJ' | 'AJE' | 'BTW' | 'BURSPED' | 'CARGOLINE' | 'CARGOBOARD' | 'CTL' | 'DACHSER' | 'DB_SCHENKER' | 'DHL_FREIGHT' | 'DHL_HOME_DELIVERY' | 'DHL_2_MANN_HANDLING' | 'DSV' | 'ECE' | 'EMONS' | 'EPH_DIREKT' | 'FEDEX' | 'FROEDE' | 'GEIS' | 'GEL' | 'GRASSL' | 'GUETTLER' | 'HASENAUER' | 'HEPPNER' | 'HELLMANN' | 'HES' | 'HEUEL' | 'IDS' | 'ISG' | 'KIESSLING' | 'KOCH' | 'KUEHNE_NAGEL' | 'LOGWIN' | 'LOOWAY' | 'MEYER_JUMBO' | 'MIRJAN' | 'ORCARGO' | 'PALLETWAYS' | 'PEISKER' | 'RABEN_LOGISTIK' | 'REIMER' | 'REITHMEIER' | 'RHENUS' | 'RIECK' | 'SCHMIDT_GEVELSBERG' | 'SCHOCKEMOEHLE' | 'SIEVERS' | 'SIMPLE_LOGISTIK' | 'SPEEDTRANS' | 'SPT' | 'VERHOEK' | 'WEISS' | 'ZUFALL' | 'OTHER_FORWARDER' required

The carrier of the shipment.

trackingNumberstring required

The tracking number of the shipment assigned by the carrier.

Response

OK

shipmentIdstring

Internal shipment identifier assigned by OTTO Market.

creationDatestring
shipDatestring

Example response

{
  "shipmentId": "101068391469",
  "creationDate": "2019-10-11T07:49:12.642Z",
  "trackingKey": {
    "carrier": "HERMES",
    "trackingNumber": "H1234567890123456789"
  },
  "shipDate": "2019-09-19T13:00:00.000Z",
  "shipFromAddress": {
    "city": "Dresden",
    "countryCode": "DEU",
    "zipCode": "01067"
  },
  "positionItems": [
    {
      "positionItemId": "e454dff5-a96f-4e96-9399-710cf59645c2",
      "salesOrderId": "a46fb35b-9c77-41c9-af10-2676b756a9af",
      "returnTrackingKey": {
        "carrier": "DHL",
        "trackingNumber": "577546565072"
      },
      "returnAddressCarrierId": "7423afd2-e7ab-4bae-ac30-048b7c0346c1"
    }
  ],
  "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

    • info

      added the new enum value LOOWAY to the path request parameter carrier

  • 3d020f15ab4dRevision changes
    • warning

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

    • info

      added the new enum value DHL_2_MANN_HANDLING to the path request parameter carrier