GET v1/Warehouses/{warehouseId}/Shipments

Get a list with available Shipments, for given Warehouse.

Request Information

Requires Authorization!

URI Parameters

NameDescriptionTypeAdditional information
warehouseId

The id of the warehouse.

 integer

Required.
fromDateChanged

Optionally specify a from date for changed orders.

 date

Is Optional.

Default value is (null).
untilDateChanged

Optionally specify a until date for changed orders.

 date

Is Optional.

Default value is (null).
isPicked

Optionally specify if the Shipment must be picked.

 boolean

Is Optional.

Default value is (null).
isPacked

Optionally specify if the Shipment must be packed.

 boolean

Is Optional.

Default value is (null).
isShipped

Optionally specify if the Shipment must be shipped.

 boolean

Is Optional.

Default value is (null).
isHandedOver

Optionally specify if the Shipment is marked as handed over.

 boolean

Is Optional.

Default value is (null).
pageSize

The max number of items returned. Default this value is 100.

 integer

Is Optional.

Default value is 100.
pageNumber

The page to return. Default page 1 will be returned.

 integer

Is Optional.

Default value is 1.

Body Parameters

None.

Response Information

Resource Description

A list of the ShipmentBasicInfo objects.


Collection of ShipmentBasicInfo
NameDescriptionTypeAdditional information
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: 
[
  {
    "Id": 1,
    "ShippingCode": "sample string 2",
    "CreateTimestamp": "2021-12-02T20:19:38.4978642+01:00",
    "ShopId": 4,
    "OrderId": 5,
    "OrderCode": "sample string 6",
    "WarehouseId": 1,
    "ParcelId": 1,
    "PickedTimestamp": "2021-12-02T20:19:38.4978642+01:00",
    "PackedTimestamp": "2021-12-02T20:19:38.4978642+01:00",
    "ShippedTimestamp": "2021-12-02T20:19:38.4978642+01:00",
    "HandOverTimestamp": "2021-12-02T20:19:38.4978642+01:00",
    "ShipmentType": 1
  },
  {
    "Id": 1,
    "ShippingCode": "sample string 2",
    "CreateTimestamp": "2021-12-02T20:19:38.4978642+01:00",
    "ShopId": 4,
    "OrderId": 5,
    "OrderCode": "sample string 6",
    "WarehouseId": 1,
    "ParcelId": 1,
    "PickedTimestamp": "2021-12-02T20:19:38.4978642+01:00",
    "PackedTimestamp": "2021-12-02T20:19:38.4978642+01:00",
    "ShippedTimestamp": "2021-12-02T20:19:38.4978642+01:00",
    "HandOverTimestamp": "2021-12-02T20:19:38.4978642+01:00",
    "ShipmentType": 1
  }
]

application/xml, text/xml

Sample: 
<ArrayOfShipmentBasicInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ShipmentBasicInfo>
    <Id>1</Id>
    <ShippingCode>sample string 2</ShippingCode>
    <CreateTimestamp>2021-12-02T20:19:38.4978642+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:38.4978642+01:00</PickedTimestamp>
    <PackedTimestamp>2021-12-02T20:19:38.4978642+01:00</PackedTimestamp>
    <ShippedTimestamp>2021-12-02T20:19:38.4978642+01:00</ShippedTimestamp>
    <HandOverTimestamp>2021-12-02T20:19:38.4978642+01:00</HandOverTimestamp>
    <ShipmentType>OwnShipping</ShipmentType>
  </ShipmentBasicInfo>
  <ShipmentBasicInfo>
    <Id>1</Id>
    <ShippingCode>sample string 2</ShippingCode>
    <CreateTimestamp>2021-12-02T20:19:38.4978642+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:38.4978642+01:00</PickedTimestamp>
    <PackedTimestamp>2021-12-02T20:19:38.4978642+01:00</PackedTimestamp>
    <ShippedTimestamp>2021-12-02T20:19:38.4978642+01:00</ShippedTimestamp>
    <HandOverTimestamp>2021-12-02T20:19:38.4978642+01:00</HandOverTimestamp>
    <ShipmentType>OwnShipping</ShipmentType>
  </ShipmentBasicInfo>
</ArrayOfShipmentBasicInfo>