ReturnShipments V1

Retrieve returnShipments.

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

get/v1/return-shipments

Query parameters

datefromstring date-time required

ReturnShipments which are announced after this date or had an status update after this date will be returned for the partner which is determined from the authorization token. The date is considered as UTC.

limitinteger

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

nextstring

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

Response

Example response

{
  "links": [
    {
      "href": "/v1/return-shipments?next=12345678&limit=25&datefrom=2019-05-02T07:49:12.642Z",
      "rel": "next"
    }
  ],
  "resources": [
    {
      "returnShipmentId": "602392a2e5c50d0cbfb18a6b",
      "createdAt": "2022-05-01T07:49:12.642Z",
      "trackingKey": {
        "carrier": "HERMES",
        "trackingNumber": "H1234567890123456789"
      },
      "returnPositionItems": [
        {
          "salesOrderId": "a46fb35b-9c77-41c9-af10-2676b756a9af",
          "salesOrderPositionItemId": "e454dff5-a96f-4e96-9399-710cf59645c2"
        }
      ],
      "states": [
        {
          "occurredOn": "2022-05-01T07:49:12.642Z",
          "statusText": "Retoure am PaketShop abgegeben"
        }
      ]
    }
  ]
}

Changes

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