OTotto
Shipments V1

Correct an existing shipment (add sent items) by carrier and tracking number.

Changed on

This endpoint allows to update an existing shipment with new position items.

post/v1/shipments/carriers/{carrier}/trackingnumbers/{trackingNumber}/positionitems

Request

  • Base URL
    https://api.otto.market
  • URL
    https://api.otto.market/v1/shipments/carriers/{carrier}/trackingnumbers/{trackingNumber}/positionitems
  • 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' | 'LOOKWAY' | '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.

Request body

positionItemIdstring uuid required

The ID of a position item of the sales order from the OTTO Market, as defined in the Order API.

salesOrderIdstring uuid required

The ID of the sales order from the OTTO Market, as defined in the Order API.

returnAddressCarrierIdstring uuid

Unique identifier for the return address and the return carrier combination. A returnAddressCarrierId is required when a partner has multiple return addresses/carriers. This identifier can be obtained through the ReturnsWarehouse API or in the Partner-Portal. Note that all position items within the same shipment must have the same returnAddressCarrierId.

Example request

[
  {
    "positionItemId": "e454dff5-a96f-4e96-9399-710cf59645c2",
    "salesOrderId": "a46fb35b-9c77-41c9-af10-2676b756a9af",
    "returnTrackingKey": {
      "carrier": "DHL",
      "trackingNumber": "577546565072"
    },
    "returnAddressCarrierId": "7423afd2-e7ab-4bae-ac30-048b7c0346c1"
  }
]

Response

OK

Changes