GET v1/Shops/{shopId}/Parcels?fromDateChanged={fromDateChanged}&untilDateChanged={untilDateChanged}&parcelStatusId={parcelStatusId}&carrierAccountId={carrierAccountId}&pageSize={pageSize}&pageNumber={pageNumber}
Get a list with available Parcels, for given shop.
Request Information
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 |
| TrackingUrl |
Optionally specify the full tracking url. When not specified the Carrier implementation will have to compose the url from the TrackinCode. |
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 |
| OrderShipmentId |
Identifier of related shipment |
integer |
None. |
| ParcelStatus |
The Parcel Status. |
ParcelStatusEnum |
None. |
| IsReturn |
Indicates whether the Parcel is a return shipment. |
boolean |
Required |
| ErrorMessage |
When set, the last status update experienced an technical error |
string |
Max length: 2147483647 |
Response Formats
application/json, text/json
[
{
"Id": 1,
"TrackingCode": "sample string 2",
"TrackingUrl": "sample string 3",
"CreateTimestamp": "2026-01-11T16:17:15.2473778+01:00",
"ChangedTimestamp": "2026-01-11T16:17:15.2473778+01:00",
"CarrierName": "sample string 6",
"ShopId": 7,
"OrderId": 1,
"CarrierAccountId": 8,
"OrderShipmentId": 1,
"ParcelStatus": 1,
"IsReturn": true,
"ErrorMessage": "sample string 10"
},
{
"Id": 1,
"TrackingCode": "sample string 2",
"TrackingUrl": "sample string 3",
"CreateTimestamp": "2026-01-11T16:17:15.2473778+01:00",
"ChangedTimestamp": "2026-01-11T16:17:15.2473778+01:00",
"CarrierName": "sample string 6",
"ShopId": 7,
"OrderId": 1,
"CarrierAccountId": 8,
"OrderShipmentId": 1,
"ParcelStatus": 1,
"IsReturn": true,
"ErrorMessage": "sample string 10"
}
]