Shipments V1

Create a multiparcel shipment and mark the position items as sent.

This endpoint is designed for creating a shipment of a single article (position item) that, due to its size or nature, must be shipped in multiple physical parcels, each with its own tracking key.

A typical use case is, for example, a large piece of furniture shipped in 2 to 3 parcels.

Please note: If you are shipping different articles, each packed in its own parcel with a separate tracking number, each of these shipments must be reported individually via the standard API endpoint for shipment creation. You cannot use the Multiparcel Shipment endpoint for this purpose.

post/v1/multiparcel-shipments

Request body

shipDatestring date-time required

The date that the shipment is handed over to the carrier. Must be a valid UTC dateTime according to ISO 8601.

Example request

[
  {
    "trackingKey": {
      "carrier": "HERMES",
      "trackingNumber": "H1234567890123456789"
    },
    "shipDate": "2019-10-11T07:49:12.642Z",
    "shipFromAddress": {
      "city": "Dresden",
      "countryCode": "DEU",
      "zipCode": "01067"
    },
    "positionItems": [
      {
        "positionItemId": "b01b8ad2-a49c-47fc-8ade-8629ec000020",
        "salesOrderId": "bf43d748-f13d-49ca-b2e2-1824e9000021",
        "returnTrackingKey": {
          "carrier": "DHL",
          "trackingNumber": "577546565072"
        }
      },
      {
        "positionItemId": "b01b8ad2-a49c-47fc-8ade-8629ec000022",
        "salesOrderId": "bf43d748-f13d-49ca-b2e2-1824e9000021",
        "returnTrackingKey": {
          "carrier": "DHL",
          "trackingNumber": "577546565072"
        }
      }
    ]
  }
]

Response

Resource created

multiParcelShipmentIdstring

Internal multiparcel shipment identifier assigned by OTTO Market.

Example response

{
  "multiParcelShipmentId": "100000294699"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.