OTotto
Shipments V1

Correct an existing shipment (add sent items) by shipment ID.

This endpoint allows to update an existing shipment with new position items. Note that this is just a correction process for shipments where position items are missing. A separate purchase receipt will be generated for the newly added position items.

post/v1/shipments/{shipmentId}/positionitems

Request

  • Base URL
    https://api.otto.market
  • URL
    https://api.otto.market/v1/shipments/{shipmentId}/positionitems
  • Auth
    HTTP bearer

Path parameters

shipmentIdstring required

Internal shipment identifier assigned by OTTO Market.

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

No recorded changes to this operation across all 10 revisions of this API.