GET v1/Shops/{shopId}/Shipments

Get a list with all available Shipments, for given shop.

Request Information

Requires Authorization!

URI Parameters

Name	Description	Type	Additional information
shopId	The id of the shop.	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).
shipmentStatusId	Optionally specify a status Id to filter on.	integer	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 OrderBasicInfo objects.

Collection of ShipmentBasicInfo

Name	Description	Type	Additional information
Id	Gets or sets the identifier.	integer	Required
TrackingCode	Gets or sets the tracking code.	string	Max length: 2147483647
CreateTimestamp	Gets or sets the create timestamp.	date	Required
ShopId	Gets or sets the Shop identifier.	integer	Required
OrderId	Gets or sets the Order identifier.	integer	None.
CarrierAccountId	Gets or sets the Carrier account.	integer	Required
ShipmentStatusId	The status Id of the Shipment. Possible values: NotPlanned = 1, Planned = 2, Shipping = 3, Delivered = 4, Cancelled = 5, Exception = 6, Deleted = 7, Partiallydelivered = 8,	integer	None.
ShipmentStatus	The status of the Shipment.	string	None.
IsReturn	Indicates whether the Shipment is a return shipment.	boolean	Required

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "TrackingCode": "sample string 2",
    "CreateTimestamp": "2026-04-03T18:29:55.984735+02:00",
    "ShopId": 4,
    "OrderId": 1,
    "CarrierAccountId": 5,
    "ShipmentStatusId": 6,
    "ShipmentStatus": "Exception",
    "IsReturn": true
  },
  {
    "Id": 1,
    "TrackingCode": "sample string 2",
    "CreateTimestamp": "2026-04-03T18:29:55.984735+02:00",
    "ShopId": 4,
    "OrderId": 1,
    "CarrierAccountId": 5,
    "ShipmentStatusId": 6,
    "ShipmentStatus": "Exception",
    "IsReturn": true
  }
]

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>
    <TrackingCode>sample string 2</TrackingCode>
    <CreateTimestamp>2026-04-03T18:29:55.984735+02:00</CreateTimestamp>
    <ShopId>4</ShopId>
    <OrderId>1</OrderId>
    <CarrierAccountId>5</CarrierAccountId>
    <ShipmentStatusId>6</ShipmentStatusId>
    <IsReturn>true</IsReturn>
  </ShipmentBasicInfo>
  <ShipmentBasicInfo>
    <Id>1</Id>
    <TrackingCode>sample string 2</TrackingCode>
    <CreateTimestamp>2026-04-03T18:29:55.984735+02:00</CreateTimestamp>
    <ShopId>4</ShopId>
    <OrderId>1</OrderId>
    <CarrierAccountId>5</CarrierAccountId>
    <ShipmentStatusId>6</ShipmentStatusId>
    <IsReturn>true</IsReturn>
  </ShipmentBasicInfo>
</ArrayOfShipmentBasicInfo>