GET v1/Shops/{shopId}/Parcels

Get a list with available Parcels, 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).
parcelStatusId	Optionally specify a status id (or ids separated by commas) to filter on.	string	Is Optional. Default value is (null).
carrierAccountId	Optionally specify a carrier account 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 ParcelBasicInfo objects.

Collection of ParcelBasicInfo

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
ChangedTimestamp	Gets the changed timestamp.	date	Required
CarrierName	The name of the Carrier used.	string	None.
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
ParcelStatus	The Parcel Status.	ParcelStatusEnum	None.
IsReturn	Indicates whether the Parcel is a return shipment.	boolean	Required

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "TrackingCode": "sample string 2",
    "CreateTimestamp": "2021-12-02T20:19:35.7791129+01:00",
    "ChangedTimestamp": "2021-12-02T20:19:35.7791129+01:00",
    "CarrierName": "sample string 5",
    "ShopId": 6,
    "OrderId": 1,
    "CarrierAccountId": 7,
    "ParcelStatus": 1,
    "IsReturn": true
  },
  {
    "Id": 1,
    "TrackingCode": "sample string 2",
    "CreateTimestamp": "2021-12-02T20:19:35.7791129+01:00",
    "ChangedTimestamp": "2021-12-02T20:19:35.7791129+01:00",
    "CarrierName": "sample string 5",
    "ShopId": 6,
    "OrderId": 1,
    "CarrierAccountId": 7,
    "ParcelStatus": 1,
    "IsReturn": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfParcelBasicInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ParcelBasicInfo>
    <Id>1</Id>
    <TrackingCode>sample string 2</TrackingCode>
    <CreateTimestamp>2021-12-02T20:19:35.7791129+01:00</CreateTimestamp>
    <ChangedTimestamp>2021-12-02T20:19:35.7791129+01:00</ChangedTimestamp>
    <CarrierName>sample string 5</CarrierName>
    <ShopId>6</ShopId>
    <OrderId>1</OrderId>
    <CarrierAccountId>7</CarrierAccountId>
    <ParcelStatus>NotPlanned</ParcelStatus>
    <IsReturn>true</IsReturn>
  </ParcelBasicInfo>
  <ParcelBasicInfo>
    <Id>1</Id>
    <TrackingCode>sample string 2</TrackingCode>
    <CreateTimestamp>2021-12-02T20:19:35.7791129+01:00</CreateTimestamp>
    <ChangedTimestamp>2021-12-02T20:19:35.7791129+01:00</ChangedTimestamp>
    <CarrierName>sample string 5</CarrierName>
    <ShopId>6</ShopId>
    <OrderId>1</OrderId>
    <CarrierAccountId>7</CarrierAccountId>
    <ParcelStatus>NotPlanned</ParcelStatus>
    <IsReturn>true</IsReturn>
  </ParcelBasicInfo>
</ArrayOfParcelBasicInfo>