GET v1/Orders/{orderId}/Shipments

Get a list with all Shipments for a given order.

Request Information

Requires Authorization!

URI Parameters

NameDescriptionTypeAdditional information
orderId

The order identifier.

 integer

Required.

Body Parameters

None.

Response Information

Resource Description

A list of the Shipment objects.


Collection of Shipment
NameDescriptionTypeAdditional information
ChangeTimestamp

The time data was changed.

 date

None.
PreferredShipDate

The preferred date to ship the Shipment.

 date

None.
OrderRows

Gets or sets the order rows included in this Shipment.

 Collection of integer

None.
Params

Gets or sets the parameters.

 Collection of ShipmentParameter

None.
Packages

Gets or sets the parameters.

 Collection of ShipmentPackage

None.
Id

Gets or sets the identifier.

 integer

Required
ShippingCode

Gets or sets the unique code for the shipment.

 string

Max length: 200
CreateTimestamp

Gets or sets the create timestamp.

 date

Required
ShopId

Gets or sets the Shop identifier.

 integer

None.
OrderId

Gets or sets the Order identifier.

 integer

Required
OrderCode

Gets or sets the corresponding Order code.

 string

None.
WarehouseId

Gets or sets the Warehouse identifier.

 integer

None.
ParcelId

The Id of the created parcel.

 integer

None.
PickedTimestamp

The time picked.

 date

None.
PackedTimestamp

The time packed.

 date

None.
ShippedTimestamp

The time shipped.

 date

None.
HandOverTimestamp

The time the Shipment was communicated to 3rd party fulfilment.

 date

None.
ShipmentType

The type of Shipment.

 ShipmentTypeEnum

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "ChangeTimestamp": "2021-12-02T20:19:34.9978627+01:00",
    "PreferredShipDate": "2021-12-02T20:19:34.9978627+01:00",
    "OrderRows": [
      1,
      2
    ],
    "Params": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2",
        "DataType": 0
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2",
        "DataType": 0
      }
    ],
    "Packages": [
      {
        "Weight": 1,
        "Length": 2,
        "Width": 3,
        "Height": 4
      },
      {
        "Weight": 1,
        "Length": 2,
        "Width": 3,
        "Height": 4
      }
    ],
    "Id": 1,
    "ShippingCode": "sample string 2",
    "CreateTimestamp": "2021-12-02T20:19:34.9978627+01:00",
    "ShopId": 4,
    "OrderId": 5,
    "OrderCode": "sample string 6",
    "WarehouseId": 1,
    "ParcelId": 1,
    "PickedTimestamp": "2021-12-02T20:19:34.9978627+01:00",
    "PackedTimestamp": "2021-12-02T20:19:34.9978627+01:00",
    "ShippedTimestamp": "2021-12-02T20:19:34.9978627+01:00",
    "HandOverTimestamp": "2021-12-02T20:19:34.9978627+01:00",
    "ShipmentType": 1
  },
  {
    "ChangeTimestamp": "2021-12-02T20:19:34.9978627+01:00",
    "PreferredShipDate": "2021-12-02T20:19:34.9978627+01:00",
    "OrderRows": [
      1,
      2
    ],
    "Params": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2",
        "DataType": 0
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2",
        "DataType": 0
      }
    ],
    "Packages": [
      {
        "Weight": 1,
        "Length": 2,
        "Width": 3,
        "Height": 4
      },
      {
        "Weight": 1,
        "Length": 2,
        "Width": 3,
        "Height": 4
      }
    ],
    "Id": 1,
    "ShippingCode": "sample string 2",
    "CreateTimestamp": "2021-12-02T20:19:34.9978627+01:00",
    "ShopId": 4,
    "OrderId": 5,
    "OrderCode": "sample string 6",
    "WarehouseId": 1,
    "ParcelId": 1,
    "PickedTimestamp": "2021-12-02T20:19:34.9978627+01:00",
    "PackedTimestamp": "2021-12-02T20:19:34.9978627+01:00",
    "ShippedTimestamp": "2021-12-02T20:19:34.9978627+01:00",
    "HandOverTimestamp": "2021-12-02T20:19:34.9978627+01:00",
    "ShipmentType": 1
  }
]

application/xml, text/xml

Sample: 
<ArrayOfShipment xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Shipment>
    <Id>1</Id>
    <ShippingCode>sample string 2</ShippingCode>
    <CreateTimestamp>2021-12-02T20:19:34.9978627+01:00</CreateTimestamp>
    <ShopId>4</ShopId>
    <OrderId>5</OrderId>
    <OrderCode>sample string 6</OrderCode>
    <WarehouseId>1</WarehouseId>
    <ParcelId>1</ParcelId>
    <PickedTimestamp>2021-12-02T20:19:34.9978627+01:00</PickedTimestamp>
    <PackedTimestamp>2021-12-02T20:19:34.9978627+01:00</PackedTimestamp>
    <ShippedTimestamp>2021-12-02T20:19:34.9978627+01:00</ShippedTimestamp>
    <HandOverTimestamp>2021-12-02T20:19:34.9978627+01:00</HandOverTimestamp>
    <ShipmentType>OwnShipping</ShipmentType>
    <ChangeTimestamp>2021-12-02T20:19:34.9978627+01:00</ChangeTimestamp>
    <PreferredShipDate>2021-12-02T20:19:34.9978627+01:00</PreferredShipDate>
    <OrderRows>
      <OrderRows>1</OrderRows>
      <OrderRows>2</OrderRows>
    </OrderRows>
    <Params>
      <Params>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
        <DataType>String</DataType>
      </Params>
      <Params>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
        <DataType>String</DataType>
      </Params>
    </Params>
    <Packages>
      <Packages>
        <Weight>1</Weight>
        <Length>2</Length>
        <Width>3</Width>
        <Height>4</Height>
      </Packages>
      <Packages>
        <Weight>1</Weight>
        <Length>2</Length>
        <Width>3</Width>
        <Height>4</Height>
      </Packages>
    </Packages>
  </Shipment>
  <Shipment>
    <Id>1</Id>
    <ShippingCode>sample string 2</ShippingCode>
    <CreateTimestamp>2021-12-02T20:19:34.9978627+01:00</CreateTimestamp>
    <ShopId>4</ShopId>
    <OrderId>5</OrderId>
    <OrderCode>sample string 6</OrderCode>
    <WarehouseId>1</WarehouseId>
    <ParcelId>1</ParcelId>
    <PickedTimestamp>2021-12-02T20:19:34.9978627+01:00</PickedTimestamp>
    <PackedTimestamp>2021-12-02T20:19:34.9978627+01:00</PackedTimestamp>
    <ShippedTimestamp>2021-12-02T20:19:34.9978627+01:00</ShippedTimestamp>
    <HandOverTimestamp>2021-12-02T20:19:34.9978627+01:00</HandOverTimestamp>
    <ShipmentType>OwnShipping</ShipmentType>
    <ChangeTimestamp>2021-12-02T20:19:34.9978627+01:00</ChangeTimestamp>
    <PreferredShipDate>2021-12-02T20:19:34.9978627+01:00</PreferredShipDate>
    <OrderRows>
      <OrderRows>1</OrderRows>
      <OrderRows>2</OrderRows>
    </OrderRows>
    <Params>
      <Params>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
        <DataType>String</DataType>
      </Params>
      <Params>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
        <DataType>String</DataType>
      </Params>
    </Params>
    <Packages>
      <Packages>
        <Weight>1</Weight>
        <Length>2</Length>
        <Width>3</Width>
        <Height>4</Height>
      </Packages>
      <Packages>
        <Weight>1</Weight>
        <Length>2</Length>
        <Width>3</Width>
        <Height>4</Height>
      </Packages>
    </Packages>
  </Shipment>
</ArrayOfShipment>