orders

get parcel item by trackingNumber

gets parcel item by id. Permissions requises : SupplierAdminRole, SupplierParcelsManagerRole.

get/api/v{version}/parcels/{trackingNumber}

Request

Base URL
https://api.zrexpress.app
Auth
HTTP bearer and API key in header X-Api-Key
TypeScript
https://skmtc.dev/zrexpress/apis/zrexpress-api/docs/api/v:version/parcels/:trackingNumber/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

versionstring required

The requested API version

trackingNumberstring required

Query parameters

scanboolean

Headers

X-Tenantstring required

Input your tenant Id to access this API

Response

idstring uuid

createdAtstring date-time nullable

amountnumber double nullable

deliveryPricenumber double nullable

returnPricenumber double nullable

trackingNumberstring nullable

paymentMethodstring nullable

deliveryTypestring nullable

bagIdstring uuid nullable

deliveryPersonIdstring uuid nullable

lastStateSituationIdstring uuid nullable

tenantIdstring nullable

lastLocationHubIdstring uuid nullable

lastStateUpdateAtstring date-time nullable

lastSituationUpdateAtstring date-time nullable

hubStockIdstring uuid nullable

descriptionstring nullable

productsDescriptionstring nullable

productsStockTypestring nullable

isReturnboolean nullable

isControlledboolean nullable

typestring nullable

isExchangedboolean nullable

originalParcelIdstring uuid nullable

returnParcelIdstring uuid nullable

pickupBagIdstring uuid nullable

externalIdstring nullable

hasActiveModificationRequestboolean nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.