Skip to content

@terminaldz/zrexpress-sdk / index / ZrExpressClient

Class: ZrExpressClient ​

Defined in: client.ts:44

Constructors ​

Constructor ​

ts
new ZrExpressClient(options): ZrExpressClient;

Defined in: client.ts:72

Parameters ​

ParameterType
optionsZrExpressOptions

Returns ​

ZrExpressClient

Throws ​

ZrExpressConfigError when options are missing or invalid (empty apiKey, non-GUID tenantId, bad URL/numbers).

Properties ​

PropertyModifierTypeDescriptionDefined in
usersreadonlyobject-client.ts:45
users.getProfilepublicPromise<{ id?: string | null; firstName?: string | null; lastName?: string | null; email?: string | null; phoneNumber?: string | null; memberships?: object[] | null; }>-resources/users.ts:26
users.registerpublicPromise<void>-resources/users.ts:31
users.searchpublicPromise<void>-resources/users.ts:36
users.toggleStatuspublicPromise<void>-resources/users.ts:46
users.getRolespublicPromise<string[]>-resources/users.ts:55
users.assignRolespublicPromise<void>-resources/users.ts:63
users.createApiKeypublicPromise<void>-resources/users.ts:72
users.searchApiKeyspublicPromise<void>-resources/users.ts:82
users.deleteApiKeypublicPromise<void>-resources/users.ts:93
territoriesreadonlyobject-client.ts:46
territories.searchpublic(body) => Promise<PagedList<TerritoryResponse>>Search territories (POST /territories/search). Filter with the shared DSL, e.g. advancedFilter: { field: 'level', operator: 'eq', value: 'wilaya' }. Throws ZrExpressApiError subclasses on non-2xx responses.resources/territories.ts:22
territories.searchAllpublicAsyncGenerator<TerritoryResponse, void, undefined>-resources/territories.ts:24
ratesreadonlyobject-client.ts:47
rates.getAllpublicPromise<{ rates?: object[] | null; }>-resources/rates.ts:8
rates.getForTerritorypublicPromise<{ toTerritoryId?: string; toTerritoryName?: string | null; toTerritoryLevel?: string | null; deliveryPrices?: object[] | null; }>-resources/rates.ts:19
rates.getPriceListpublicPromise<{ priceLists?: { id?: string; name?: string | null; type?: string | null; fromTerritory?: { id?: string; code?: number; name?: string | null; postalCode?: string | null; level?: string | null; parentId?: string | null; delivery?: { hasHomeDelivery?: boolean; hasPickupPoint?: boolean; }; }; deliveryPrices?: object[] | null; }; }>-resources/rates.ts:32
rates.getSupplierSpecificPricespublicPromise<void>-resources/rates.ts:46
hubsreadonlyobject-client.ts:48
hubs.getpublicPromise<{ id?: string; name?: string | null; type?: string | null; isPickupPoint?: boolean; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; }; openingHours?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; createdAt?: string; services?: object[] | null; }>-resources/hubs.ts:24
hubs.searchpublic(body) => Promise<PagedList<{ id?: string; name?: string | null; type?: string | null; isPickupPoint?: boolean; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; }; openingHours?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; createdAt?: string; services?: object[] | null; }>>Search hubs with the shared DSL (POST /hubs/search).resources/hubs.ts:32
hubs.searchAllpublicAsyncGenerator<{ id?: string; name?: string | null; type?: string | null; isPickupPoint?: boolean; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; }; openingHours?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; createdAt?: string; services?: object[] | null; }, void, undefined>-resources/hubs.ts:34
workflowsreadonlyobject-client.ts:49
workflows.searchpublic(body) => Promise<PagedList<{ id?: string; name?: string | null; isDefault?: boolean; states?: object[] | null; }>>Search workflows incl. their states and situations (POST /workflows/search).resources/workflows.ts:21
workflows.searchAllpublicAsyncGenerator<{ id?: string; name?: string | null; isDefault?: boolean; states?: object[] | null; }, void, undefined>-resources/workflows.ts:23
parcelsreadonlyobject-client.ts:50
parcels.createpublicPromise<{ id?: string; }>-resources/parcels.ts:82
parcels.createBulkpublicPromise<{ totalRequested?: number; successCount?: number; failureCount?: number; successes?: object[] | null; failures?: object[] | null; }>-resources/parcels.ts:91
parcels.createExchangeBulkpublicPromise<{ totalRequested?: number; successCount?: number; failureCount?: number; successes?: object[] | null; failures?: object[] | null; }>-resources/parcels.ts:104
parcels.createRefundBulkpublicPromise<{ totalRequested?: number; successCount?: number; failureCount?: number; successes?: object[] | null; failures?: object[] | null; }>-resources/parcels.ts:120
parcels.createExchangepublicPromise<{ newParcelId?: string; returnParcelId?: string | null; originalParcelId?: string | null; }>-resources/parcels.ts:134
parcels.createRefundpublicPromise<{ id?: string; }>-resources/parcels.ts:148
parcels.getpublicPromise<{ id?: string; customer?: { customerId?: string; name?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; }; supplier?: { supplierName?: string | null; supplierCityTerritoryId?: string; supplierHubId?: string; supplierHubCityTerritoryId?: string; supplierHubName?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; supportPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; }; deliveryAddress?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; cityTerritoryCode?: number; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; createdAt?: string | null; amount?: number | null; deliveryPrice?: number | null; returnPrice?: number | null; trackingNumber?: string | null; paymentMethod?: string | null; deliveryType?: string | null; weight?: { weight?: number | null; dimensionalWeight?: number | null; effectiveWeight?: number; }; bagId?: string | null; deliveryPersonId?: string | null; deliveryPerson?: { id?: string; firstName?: string | null; lastName?: string | null; assignedPriceListId?: string; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; hub?: { id?: string; name?: string | null; type?: string | null; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: ...; lng?: ...; }; }; services?: object[] | null; }; email?: string | null; status?: string | null; isUnavailable?: boolean; isAccountActivated?: boolean; penalities?: object[] | null; }; state?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean | null; isLocked?: boolean | null; visibleFor?: 0 | 1 | 2 | 4 | 8; editableBy?: 0 | 1 | 2 | 4 | 8; color?: string | null; }; lastStateSituationId?: string | null; situation?: { id?: string; name?: string | null; description?: string | null; slug?: string | null; metadata?: | { [key: string]: unknown; } | null; }; tenantId?: string | null; lastLocationHubId?: string | null; lastStateUpdateAt?: string | null; lastSituationUpdateAt?: string | null; hubStockId?: string | null; description?: string | null; productsDescription?: string | null; productsStockType?: string | null; isReturn?: boolean | null; isControlled?: boolean | null; type?: string | null; isExchanged?: boolean | null; originalParcelId?: string | null; returnParcelId?: string | null; pickupBagId?: string | null; externalId?: string | null; hasActiveModificationRequest?: boolean | null; orderedProducts?: object[] | null; }>-resources/parcels.ts:157
parcels.getByTrackingNumberpublicPromise<{ id?: string; customer?: { customerId?: string; name?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; }; supplier?: { supplierName?: string | null; supplierCityTerritoryId?: string; supplierHubId?: string; supplierHubCityTerritoryId?: string; supplierHubName?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; supportPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; }; deliveryAddress?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; cityTerritoryCode?: number; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; createdAt?: string | null; amount?: number | null; deliveryPrice?: number | null; returnPrice?: number | null; trackingNumber?: string | null; paymentMethod?: string | null; deliveryType?: string | null; weight?: { weight?: number | null; dimensionalWeight?: number | null; effectiveWeight?: number; }; bagId?: string | null; deliveryPersonId?: string | null; deliveryPerson?: { id?: string; firstName?: string | null; lastName?: string | null; assignedPriceListId?: string; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; hub?: { id?: string; name?: string | null; type?: string | null; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: ...; lng?: ...; }; }; services?: object[] | null; }; email?: string | null; status?: string | null; isUnavailable?: boolean; isAccountActivated?: boolean; penalities?: object[] | null; }; state?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean | null; isLocked?: boolean | null; visibleFor?: 0 | 1 | 2 | 4 | 8; editableBy?: 0 | 1 | 2 | 4 | 8; color?: string | null; }; lastStateSituationId?: string | null; situation?: { id?: string; name?: string | null; description?: string | null; slug?: string | null; metadata?: | { [key: string]: unknown; } | null; }; tenantId?: string | null; lastLocationHubId?: string | null; lastStateUpdateAt?: string | null; lastSituationUpdateAt?: string | null; hubStockId?: string | null; description?: string | null; productsDescription?: string | null; productsStockType?: string | null; isReturn?: boolean | null; isControlled?: boolean | null; type?: string | null; isExchanged?: boolean | null; originalParcelId?: string | null; returnParcelId?: string | null; pickupBagId?: string | null; externalId?: string | null; hasActiveModificationRequest?: boolean | null; orderedProducts?: object[] | null; }>-resources/parcels.ts:170
parcels.searchpublic(body) => Promise<PagedList<{ id?: string; customer?: { customerId?: string; name?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; }; supplier?: { supplierName?: string | null; supplierCityTerritoryId?: string; supplierHubId?: string; supplierHubCityTerritoryId?: string; supplierHubName?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; supportPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; }; deliveryAddress?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; cityTerritoryCode?: number; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; createdAt?: string | null; amount?: number | null; returnPrice?: number | null; deliveryPrice?: number | null; trackingNumber?: string | null; paymentMethod?: string | null; deliveryType?: string | null; weight?: { weight?: number | null; dimensionalWeight?: number | null; effectiveWeight?: number; }; bagId?: string | null; deliveryPersonId?: string | null; state?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean | null; isLocked?: boolean | null; visibleFor?: 0 | 1 | 2 | 4 | 8; editableBy?: 0 | 1 | 2 | 4 | 8; color?: string | null; }; lastStateSituationId?: string | null; hubStockId?: string | null; situation?: { id?: string; name?: string | null; description?: string | null; slug?: string | null; metadata?: | { [key: string]: unknown; } | null; }; tenantId?: string | null; lastLocationHubId?: string | null; lastStateUpdateAt?: string | null; lastSituationUpdateAt?: string | null; description?: string | null; productsDescription?: string | null; productsStockType?: string | null; isReturn?: boolean | null; isControlled?: boolean | null; type?: string | null; isExchanged?: boolean | null; originalParcelId?: string | null; returnParcelId?: string | null; pickupBagId?: string | null; externalId?: string | null; orderedProducts?: object[] | null; }>>Search parcels with the shared DSL (POST /parcels/search).resources/parcels.ts:181
parcels.searchAllpublicAsyncGenerator<{ id?: string; customer?: { customerId?: string; name?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; }; supplier?: { supplierName?: string | null; supplierCityTerritoryId?: string; supplierHubId?: string; supplierHubCityTerritoryId?: string; supplierHubName?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; supportPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; }; deliveryAddress?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; cityTerritoryCode?: number; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; createdAt?: string | null; amount?: number | null; returnPrice?: number | null; deliveryPrice?: number | null; trackingNumber?: string | null; paymentMethod?: string | null; deliveryType?: string | null; weight?: { weight?: number | null; dimensionalWeight?: number | null; effectiveWeight?: number; }; bagId?: string | null; deliveryPersonId?: string | null; state?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean | null; isLocked?: boolean | null; visibleFor?: 0 | 1 | 2 | 4 | 8; editableBy?: 0 | 1 | 2 | 4 | 8; color?: string | null; }; lastStateSituationId?: string | null; hubStockId?: string | null; situation?: { id?: string; name?: string | null; description?: string | null; slug?: string | null; metadata?: | { [key: string]: unknown; } | null; }; tenantId?: string | null; lastLocationHubId?: string | null; lastStateUpdateAt?: string | null; lastSituationUpdateAt?: string | null; description?: string | null; productsDescription?: string | null; productsStockType?: string | null; isReturn?: boolean | null; isControlled?: boolean | null; type?: string | null; isExchanged?: boolean | null; originalParcelId?: string | null; returnParcelId?: string | null; pickupBagId?: string | null; externalId?: string | null; orderedProducts?: object[] | null; }, void, undefined>-resources/parcels.ts:183
parcels.deletepublicPromise<{ id?: string | null; }>-resources/parcels.ts:194
parcels.deleteBulkpublicPromise<{ totalRequested?: number; successCount?: number; failureCount?: number; successes?: object[] | null; failures?: object[] | null; }>-resources/parcels.ts:207
parcels.deleteBulkByTrackingNumberpublicPromise<{ totalRequested?: number; successCount?: number; failureCount?: number; successes?: object[] | null; failures?: object[] | null; }>-resources/parcels.ts:221
parcels.updateStatepublicPromise<{ parcelId?: string; newStateId?: string; newStateName?: string | null; trackingNumber?: string | null; }>-resources/parcels.ts:237
parcels.updateRefundStatepublicPromise<{ parcelId?: string; newStateId?: string; newStateName?: string | null; trackingNumber?: string | null; }>-resources/parcels.ts:252
parcels.getStateHistorypublicPromise<object[]>-resources/parcels.ts:268
parcels.createStateSituationHistorypublicPromise<{ id?: string; }>-resources/parcels.ts:281
parcels.updateProductspublicPromise<{ parcelId?: string; }>-resources/parcels.ts:298
parcels.updateAmountpublicPromise<{ id?: string | null; }>-resources/parcels.ts:310
parcels.updateCustomerpublicPromise<{ id?: string | null; }>-resources/parcels.ts:319
parcels.updateDeliveryAddresspublicPromise<{ id?: string | null; }>-resources/parcels.ts:331
parcels.statsByStatepublicPromise<object[]>-resources/parcels.ts:346
parcels.statsBySituationpublicPromise<object[]>-resources/parcels.ts:361
parcels.importpublicPromise<{ succeededs?: object[] | null; faileds?: object[] | null; }>-resources/parcels.ts:377
parcels.downloadImportTemplatepublicPromise<ArrayBuffer>-resources/parcels.ts:386
customersreadonlyobject-client.ts:51
customers.createIndividualpublicPromise<{ id?: string; }>-resources/customers.ts:40
customers.updateIndividualpublicPromise<{ id?: string; }>-resources/customers.ts:51
customers.getpublicPromise<{ id?: string; name?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; dateOfBirth?: string | null; instruction?: string | null; timeSlot?: string | null; deliveryPreference?: string | null; companyId?: string | null; companyContactPerson?: string | null; addresses?: object[] | null; }>-resources/customers.ts:63
customers.searchpublic(body) => Promise<PagedList<{ id?: string; name?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; dateOfBirth?: string | null; instruction?: string | null; timeSlot?: string | null; deliveryPreference?: string | null; companyId?: string | null; companyContactPerson?: string | null; addresses?: object[] | null; }>>Search customers with the shared DSL (POST /customers/search).resources/customers.ts:70
customers.searchAllpublicAsyncGenerator<{ id?: string; name?: string | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; dateOfBirth?: string | null; instruction?: string | null; timeSlot?: string | null; deliveryPreference?: string | null; companyId?: string | null; companyContactPerson?: string | null; addresses?: object[] | null; }, void, undefined>-resources/customers.ts:72
customers.deletepublicPromise<void>-resources/customers.ts:80
customers.addAddresspublicPromise<{ id?: string; }>-resources/customers.ts:88
customers.updateAddresspublicPromise<{ id?: string; }>-resources/customers.ts:100
customers.deleteAddresspublicPromise<{ id?: string; }>-resources/customers.ts:113
customers.importIndividualpublicPromise<{ succeededs?: object[] | null; faileds?: object[] | null; }>-resources/customers.ts:124
customers.downloadImportTemplatepublicPromise<ArrayBuffer>-resources/customers.ts:133
labelsreadonlyobject-client.ts:52
labels.generateMultipleHtmlpublicPromise<{ fileUrl?: string | null; failedTrackingNumbers?: string[] | null; }>-resources/labels.ts:24
labels.generateIndividualHtmlpublicPromise<{ parcelLabelFiles?: object[] | null; failedTrackingNumbers?: string[] | null; }>-resources/labels.ts:35
labels.generateMultiplePdfpublicPromise<{ fileUrl?: string | null; failedTrackingNumbers?: string[] | null; }>-resources/labels.ts:46
labels.generateIndividualPdfpublicPromise<{ parcelLabelFiles?: object[] | null; failedTrackingNumbers?: string[] | null; }>-resources/labels.ts:57
labels.generatePickupBagPdfpublicPromise<{ trackingNumber?: string | null; fileUrl?: string | null; }>-resources/labels.ts:68
pickupBagsreadonlyobject-client.ts:53
pickupBags.createpublicPromise<{ id?: string | null; trackingNumber?: string | null; successes?: object[] | null; failures?: object[] | null; }>-resources/pickup-bags.ts:44
pickupBags.getpublicPromise<{ id?: string; trackingNumber?: string | null; unprocessedParcelsCount?: number | null; state?: string | null; supplier?: { supplierName?: string | null; supplierCityTerritoryId?: string; supplierHubId?: string; }; driverId?: string | null; driver?: { id?: string; firstName?: string | null; lastName?: string | null; }; totalParcels?: number | null; createdAt?: string | null; }>-resources/pickup-bags.ts:49
pickupBags.getByTrackingNumberpublicPromise<{ id?: string; trackingNumber?: string | null; unprocessedParcelsCount?: number | null; state?: string | null; supplier?: { supplierName?: string | null; supplierCityTerritoryId?: string; supplierHubId?: string; }; driverId?: string | null; driver?: { id?: string; firstName?: string | null; lastName?: string | null; }; totalParcels?: number | null; createdAt?: string | null; }>-resources/pickup-bags.ts:57
pickupBags.searchpublic(body) => Promise<PagedList<{ id?: string; trackingNumber?: string | null; unprocessedParcelsCount?: number | null; state?: string | null; supplier?: { supplierName?: string | null; supplierCityTerritoryId?: string; supplierHubId?: string; }; driverId?: string | null; driver?: { id?: string; firstName?: string | null; lastName?: string | null; }; totalParcels?: number | null; createdAt?: string | null; }>>Search pickup bags with the shared DSL (POST /pickup-bags/search).resources/pickup-bags.ts:64
pickupBags.searchAllpublicAsyncGenerator<{ id?: string; trackingNumber?: string | null; unprocessedParcelsCount?: number | null; state?: string | null; supplier?: { supplierName?: string | null; supplierCityTerritoryId?: string; supplierHubId?: string; }; driverId?: string | null; driver?: { id?: string; firstName?: string | null; lastName?: string | null; }; totalParcels?: number | null; createdAt?: string | null; }, void, undefined>-resources/pickup-bags.ts:66
pickupBags.searchParcelspublic(trackingNumber, body) => Promise<PagedList<{ id?: string; trackingNumber?: string | null; pickupBagId?: string | null; description?: string | null; supplier?: { id?: string; name?: string | null; }; }>>Search parcels inside a pickup bag (POST /pickup-bags/{trackingNumber}/parcels/search).resources/pickup-bags.ts:73
pickupBags.searchParcelsAllpublicAsyncGenerator<{ id?: string; trackingNumber?: string | null; pickupBagId?: string | null; description?: string | null; supplier?: { id?: string; name?: string | null; }; }, void, undefined>-resources/pickup-bags.ts:75
pickupBags.addParcelspublicPromise<{ parcelId?: string; successes?: object[] | null; failures?: object[] | null; }>-resources/pickup-bags.ts:84
pickupBags.removeParcelpublicPromise<{ parcelId?: string; }>-resources/pickup-bags.ts:96
pickupBags.deletepublicPromise<{ id?: string; }>-resources/pickup-bags.ts:108
modificationRequestsreadonlyobject-client.ts:54
modificationRequests.createpublicPromise<{ id?: string; }>-resources/modification-requests.ts:44
modificationRequests.updatepublicPromise<{ id?: string; }>-resources/modification-requests.ts:55
modificationRequests.getpublicPromise<{ id?: string; parcelId?: string; parcelTrackingNumber?: string | null; clientName?: string | null; parcelState?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean | null; isLocked?: boolean | null; visibleFor?: 0 | 1 | 2 | 4 | 8; editableBy?: 0 | 1 | 2 | 4 | 8; color?: string | null; }; newPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; newAmount?: number | null; oldAmount?: number | null; newDeliveryType?: string | null; newDeliveryAddress?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; cityTerritoryCode?: number; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; validatedBy?: { id?: string; fullName?: string | null; }; validatedAt?: string | null; isApproved?: boolean | null; comment?: string | null; createdAt?: string | null; }>-resources/modification-requests.ts:67
modificationRequests.deletepublicPromise<{ id?: string; }>-resources/modification-requests.ts:75
modificationRequests.searchpublic(body) => Promise<PagedList<{ id?: string; parcelId?: string; parcelTrackingNumber?: string | null; clientName?: string | null; parcelState?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean | null; isLocked?: boolean | null; visibleFor?: 0 | 1 | 2 | 4 | 8; editableBy?: 0 | 1 | 2 | 4 | 8; color?: string | null; }; newPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; newAmount?: number | null; oldAmount?: number | null; newDeliveryType?: string | null; newDeliveryAddress?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; cityTerritoryCode?: number; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; validatedBy?: { id?: string; fullName?: string | null; }; validatedAt?: string | null; isApproved?: boolean | null; comment?: string | null; createdAt?: string | null; }>>Search this supplier's modification requests (POST /parcel-modification-requests/search).resources/modification-requests.ts:82
modificationRequests.searchAllpublicAsyncGenerator<{ id?: string; parcelId?: string; parcelTrackingNumber?: string | null; clientName?: string | null; parcelState?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean | null; isLocked?: boolean | null; visibleFor?: 0 | 1 | 2 | 4 | 8; editableBy?: 0 | 1 | 2 | 4 | 8; color?: string | null; }; newPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; newAmount?: number | null; oldAmount?: number | null; newDeliveryType?: string | null; newDeliveryAddress?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; cityTerritoryCode?: number; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; validatedBy?: { id?: string; fullName?: string | null; }; validatedAt?: string | null; isApproved?: boolean | null; comment?: string | null; createdAt?: string | null; }, void, undefined>-resources/modification-requests.ts:84
modificationRequests.searchByParcelpublic(parcelId, body) => Promise<PagedList<{ id?: string; parcelId?: string; parcelTrackingNumber?: string | null; clientName?: string | null; parcelState?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean | null; isLocked?: boolean | null; visibleFor?: 0 | 1 | 2 | 4 | 8; editableBy?: 0 | 1 | 2 | 4 | 8; color?: string | null; }; newPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; newAmount?: number | null; oldAmount?: number | null; newDeliveryType?: string | null; newDeliveryAddress?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; cityTerritoryCode?: number; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; validatedBy?: { id?: string; fullName?: string | null; }; validatedAt?: string | null; isApproved?: boolean | null; comment?: string | null; createdAt?: string | null; }>>Search modification requests for one parcel (POST /parcel-modification-requests/{parcelId}).resources/modification-requests.ts:91
modificationRequests.searchByParcelAllpublicAsyncGenerator<{ id?: string; parcelId?: string; parcelTrackingNumber?: string | null; clientName?: string | null; parcelState?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean | null; isLocked?: boolean | null; visibleFor?: 0 | 1 | 2 | 4 | 8; editableBy?: 0 | 1 | 2 | 4 | 8; color?: string | null; }; newPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; newAmount?: number | null; oldAmount?: number | null; newDeliveryType?: string | null; newDeliveryAddress?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; cityTerritoryCode?: number; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; validatedBy?: { id?: string; fullName?: string | null; }; validatedAt?: string | null; isApproved?: boolean | null; comment?: string | null; createdAt?: string | null; }, void, undefined>-resources/modification-requests.ts:93
productsreadonlyobject-client.ts:55
products.createpublicPromise<{ id?: string | null; }>-resources/products.ts:36
products.getpublicPromise<{ id?: string; name?: string | null; sku?: string | null; category?: { id?: string; name?: string | null; subCategories?: object[] | null; }; subCategory?: { id?: string; name?: string | null; }; price?: { base?: number; promotional?: number | null; promotionStart?: string | null; promotionEnd?: string | null; }; purchasePrice?: number | null; dimensions?: { length?: number | null; width?: number | null; height?: number | null; }; localStock?: number; warehouseStocks?: object[] | null; weight?: number | null; variants?: object[] | null; stockMovements?: object[] | null; }>-resources/products.ts:44
products.searchpublic(body) => Promise<PagedList<{ id?: string; tenantId?: string | null; name?: string | null; sku?: string | null; localStock?: number; categoryName?: string | null; subCategoryName?: string | null; price?: { base?: number; promotional?: number | null; promotionStart?: string | null; promotionEnd?: string | null; }; purchasePrice?: number | null; dimensions?: { length?: number | null; width?: number | null; height?: number | null; }; warehouseStock?: { damageQuantity?: number; availableQuantity?: number; pendingReceptionQuantity?: number; withdrawalQuantity?: number; underDeliveryQuantity?: number; deliveredQuantity?: number; hubId?: string | null; hubName?: string | null; }; weight?: number | null; variants?: object[] | null; }>>Search products with the shared DSL (POST /products/search).resources/products.ts:52
products.searchAllpublicAsyncGenerator<{ id?: string; tenantId?: string | null; name?: string | null; sku?: string | null; localStock?: number; categoryName?: string | null; subCategoryName?: string | null; price?: { base?: number; promotional?: number | null; promotionStart?: string | null; promotionEnd?: string | null; }; purchasePrice?: number | null; dimensions?: { length?: number | null; width?: number | null; height?: number | null; }; warehouseStock?: { damageQuantity?: number; availableQuantity?: number; pendingReceptionQuantity?: number; withdrawalQuantity?: number; underDeliveryQuantity?: number; deliveredQuantity?: number; hubId?: string | null; hubName?: string | null; }; weight?: number | null; variants?: object[] | null; }, void, undefined>-resources/products.ts:54
products.updatepublicPromise<{ id?: string | null; }>-resources/products.ts:62
products.deletepublicPromise<void>-resources/products.ts:71
products.updatePricepublicPromise<{ id?: string | null; }>-resources/products.ts:79
products.updateDiscountpublicPromise<{ id?: string | null; }>-resources/products.ts:88
products.updateLocalStockpublicPromise<{ id?: string | null; }>-resources/products.ts:100
products.importpublicPromise<{ succeededs?: object[] | null; faileds?: object[] | null; }>-resources/products.ts:112
products.downloadImportTemplatepublicPromise<ArrayBuffer>-resources/products.ts:121
categoriesreadonlyobject-client.ts:56
categories.searchpublic(body) => Promise<PagedList<{ id?: string; name?: string | null; subCategories?: object[] | null; }>>Search categories with the shared DSL (POST /categories/search).resources/categories.ts:17
categories.searchAllpublicAsyncGenerator<{ id?: string; name?: string | null; subCategories?: object[] | null; }, void, undefined>-resources/categories.ts:19
receiptsreadonlyobject-client.ts:57
receipts.getpublicPromise<{ id?: string; referenceId?: string | null; createdAt?: string; totalProducts?: number; supplier?: { supplierId?: string; name?: string | null; }; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; hubId?: string | null; hubName?: string | null; }; type?: string | null; receivedBy?: string | null; stockMovements?: object[] | null; }>-resources/receipts.ts:18
receipts.searchpublic(body) => Promise<PagedList<{ id?: string; referenceId?: string | null; createdAt?: string; totalProducts?: number; supplier?: { supplierId?: string; name?: string | null; }; type?: string | null; receivedBy?: string | null; }>>Search receipts with the shared DSL (POST /receipts/search).resources/receipts.ts:25
receipts.searchAllpublicAsyncGenerator<{ id?: string; referenceId?: string | null; createdAt?: string; totalProducts?: number; supplier?: { supplierId?: string; name?: string | null; }; type?: string | null; receivedBy?: string | null; }, void, undefined>-resources/receipts.ts:27
stockMovementsreadonlyobject-client.ts:58
stockMovements.createByUserpublicPromise<{ id?: string | null; }>-resources/stock-movements.ts:14
claimsreadonlyobject-client.ts:59
claims.createpublicPromise<{ id?: string; }>-resources/claims.ts:71
claims.getpublicPromise<{ id?: string; title?: string | null; description?: string | null; parcel?: { id?: string; city?: string | null; district?: string | null; trackingNumber?: string | null; stateName?: string | null; customerFullName?: string | null; phone?: string | null; }; state?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean; isLocked?: boolean; color?: string | null; ranking?: number; }; category?: { id?: string; name?: string | null; }; createdAt?: string; lastModifiedAt?: string; comments?: object[] | null; }>-resources/claims.ts:79
claims.updateDetailspublicPromise<{ id?: string | null; }>-resources/claims.ts:88
claims.deletepublicPromise<void>-resources/claims.ts:100
claims.getStateHistoriespublicPromise<object[]>-resources/claims.ts:108
claims.addCommentpublicPromise<{ id?: string | null; }>-resources/claims.ts:116
claims.searchpublic(body) => Promise<PagedList<{ id?: string; title?: string | null; description?: string | null; parcel?: { id?: string; city?: string | null; district?: string | null; trackingNumber?: string | null; stateName?: string | null; customerFullName?: string | null; phone?: string | null; }; state?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean; isLocked?: boolean; color?: string | null; ranking?: number; }; category?: { id?: string; name?: string | null; }; createdAt?: string; lastModifiedAt?: string; comments?: object[] | null; }>>Search this supplier's claims (POST /claims/search).resources/claims.ts:127
claims.searchAllpublicAsyncGenerator<{ id?: string; title?: string | null; description?: string | null; parcel?: { id?: string; city?: string | null; district?: string | null; trackingNumber?: string | null; stateName?: string | null; customerFullName?: string | null; phone?: string | null; }; state?: { id?: string; name?: string | null; description?: string | null; isBlocking?: boolean; isLocked?: boolean; color?: string | null; ranking?: number; }; category?: { id?: string; name?: string | null; }; createdAt?: string; lastModifiedAt?: string; comments?: object[] | null; }, void, undefined>-resources/claims.ts:129
claims.searchCommentspublic(claimId, body) => Promise<PagedList<{ id?: string; claimId?: string; content?: string | null; modifiedBy?: { id?: string; fullName?: string | null; }; createdAt?: string; }>>Search a claim's comments (POST /claim-comments/{claimId}/search).resources/claims.ts:136
claims.searchCommentsAllpublicAsyncGenerator<{ id?: string; claimId?: string; content?: string | null; modifiedBy?: { id?: string; fullName?: string | null; }; createdAt?: string; }, void, undefined>-resources/claims.ts:138
claims.searchCategoriespublic(body) => Promise<PagedList<{ id?: string; name?: string | null; }>>Search claim categories (POST /claim-categories/search).resources/claims.ts:146
claims.searchCategoriesAllpublicAsyncGenerator<{ id?: string; name?: string | null; }, void, undefined>-resources/claims.ts:148
claims.getCategorypublicPromise<{ id?: string; name?: string | null; }>-resources/claims.ts:156
claims.searchWorkflowspublic(body) => Promise<PagedList<{ id?: string; name?: string | null; isDefault?: boolean; states?: object[] | null; }>>Search claim workflows (POST /claim-workflows/search).resources/claims.ts:163
claims.searchWorkflowsAllpublicAsyncGenerator<{ id?: string; name?: string | null; isDefault?: boolean; states?: object[] | null; }, void, undefined>-resources/claims.ts:165
treasuryreadonlyobject-client.ts:60
treasury.getBalancepublicPromise<GetSupplierStatsAmountResponse>-resources/treasury.ts:48
treasury.getTransactionsStatspublicPromise<{ amount?: number; }>-resources/treasury.ts:56
treasury.getPaymentpublicPromise<{ id?: string; supplier?: { id?: string; name?: string | null; tenantId?: string | null; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; }; paymentDays?: string[] | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; owner?: { firstName?: string | null; lastName?: string | null; email?: string | null; }; legalInformation?: { rc?: string | null; nif?: string | null; ai?: string | null; nis?: string | null; }; }; amount?: number; totalParcelsDelivered?: number; totalParcelsCancelled?: number; totalRefundsCredited?: number; totalRefundsDebited?: number; totalItemLabeling?: number; labelingAmount?: number; storage?: number; createdAt?: string; referenceId?: string | null; status?: string | null; }>-resources/treasury.ts:68
treasury.acceptPaymentpublicPromise<{ id?: string | null; }>-resources/treasury.ts:84
treasury.searchPaymentspublic(body) => Promise<PagedList<{ id?: string; supplier?: { id?: string; name?: string | null; tenantId?: string | null; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: ...; lng?: ...; }; }; paymentDays?: string[] | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; owner?: { firstName?: string | null; lastName?: string | null; email?: string | null; }; legalInformation?: { rc?: string | null; nif?: string | null; ai?: string | null; nis?: string | null; }; }; amount?: number; totalParcelsDelivered?: number; totalParcelsCancelled?: number; totalRefundsCredited?: number; totalRefundsDebited?: number; totalItemLabeling?: number; labelingAmount?: number; storage?: number; createdAt?: string; acceptedAt?: string | null; cashDrawer?: { id?: string; cashDrawerUser?: { id?: string; firstName?: string | null; lastName?: string | null; }; amount?: number; isActive?: boolean; hub?: { id?: string; name?: string | null; type?: string | null; address?: { street?: ...; city?: ...; cityTerritoryId?: ...; district?: ...; districtTerritoryId?: ...; postalCode?: ...; country?: ...; coordinates?: ...; }; }; }; referenceId?: string | null; status?: string | null; }>>Search this supplier's payments (POST /supplier-payment/search).resources/treasury.ts:95
treasury.searchPaymentsAllpublicAsyncGenerator<{ id?: string; supplier?: { id?: string; name?: string | null; tenantId?: string | null; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; }; paymentDays?: string[] | null; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; owner?: { firstName?: string | null; lastName?: string | null; email?: string | null; }; legalInformation?: { rc?: string | null; nif?: string | null; ai?: string | null; nis?: string | null; }; }; amount?: number; totalParcelsDelivered?: number; totalParcelsCancelled?: number; totalRefundsCredited?: number; totalRefundsDebited?: number; totalItemLabeling?: number; labelingAmount?: number; storage?: number; createdAt?: string; acceptedAt?: string | null; cashDrawer?: { id?: string; cashDrawerUser?: { id?: string; firstName?: string | null; lastName?: string | null; }; amount?: number; isActive?: boolean; hub?: { id?: string; name?: string | null; type?: string | null; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: ...; lng?: ...; }; }; }; }; referenceId?: string | null; status?: string | null; }, void, undefined>-resources/treasury.ts:97
treasury.exportPaymentspublicPromise<string>-resources/treasury.ts:108
treasury.searchPaymentTransactionspublic(supplierPaymentId, body) => Promise<PagedList<{ id?: string; amount?: number; weightCost?: number; comment?: string | null; type?: string | null; supplier?: { supplierId?: string; name?: string | null; }; parcel?: { parcelId?: string; trackingNumber?: string | null; customerFullName?: string | null; deliveryType?: string | null; description?: string | null; deliveryPrice?: number; returnPrice?: number; type?: string | null; weight?: number; }; createdAt?: string; cashReceiptId?: string | null; supplierPaymentId?: string | null; supplierPaymentReference?: string | null; }>>Search a payment's treasury transactions.resources/treasury.ts:112
treasury.searchPaymentTransactionsAllpublicAsyncGenerator<{ id?: string; amount?: number; weightCost?: number; comment?: string | null; type?: string | null; supplier?: { supplierId?: string; name?: string | null; }; parcel?: { parcelId?: string; trackingNumber?: string | null; customerFullName?: string | null; deliveryType?: string | null; description?: string | null; deliveryPrice?: number; returnPrice?: number; type?: string | null; weight?: number; }; createdAt?: string; cashReceiptId?: string | null; supplierPaymentId?: string | null; supplierPaymentReference?: string | null; }, void, undefined>-resources/treasury.ts:114
reportsreadonlyobject-client.ts:61
reports.searchpublic(body) => Promise<PagedList<{ id?: string; createdAt?: string; tenantId?: string | null; type?: string | null; frequency?: string | null; startDate?: string; endDate?: string; createdBy?: { id?: string; fullName?: string | null; }; status?: string | null; }>>Search reports with the shared DSL (POST /reports/search).resources/reports.ts:21
reports.searchAllpublicAsyncGenerator<{ id?: string; createdAt?: string; tenantId?: string | null; type?: string | null; frequency?: string | null; startDate?: string; endDate?: string; createdBy?: { id?: string; fullName?: string | null; }; status?: string | null; }, void, undefined>-resources/reports.ts:23
reports.downloadpublicPromise<{ sasUrl?: string | null; }>-resources/reports.ts:35
documentsreadonlyobject-client.ts:62
documents.searchpublic(body) => Promise<PagedList<{ id?: string; title?: string | null; description?: string | null; fileId?: string; type?: string | null; category?: string | null; displayOrder?: number; createdAt?: string; sasUrl?: string | null; fileName?: string | null; mimeType?: string | null; }>>Search documents with the shared DSL (POST /documents/search).resources/documents.ts:23
documents.searchAllpublicAsyncGenerator<{ id?: string; title?: string | null; description?: string | null; fileId?: string; type?: string | null; category?: string | null; displayOrder?: number; createdAt?: string; sasUrl?: string | null; fileName?: string | null; mimeType?: string | null; }, void, undefined>-resources/documents.ts:25
documents.getUrlpublicPromise<{ id?: string; title?: string | null; sasUrl?: string | null; fileName?: string | null; fileType?: string | null; mimeType?: string | null; }>-resources/documents.ts:37
rolesreadonlyobject-client.ts:63
roles.listpublicPromise<object[]>-resources/roles.ts:8
notificationsreadonlyobject-client.ts:64
notifications.getTokenpublicPromise<string>-resources/notifications.ts:10
supplierreadonlyobject-client.ts:65
supplier.getpublicPromise<{ id?: string; name?: string | null; codeName?: string | null; type?: string | null; assignedPriceListId?: string | null; hubName?: string | null; address?: { street?: string | null; city?: string | null; cityTerritoryId?: string; district?: string | null; districtTerritoryId?: string; postalCode?: string | null; country?: string | null; coordinates?: { lat?: number | null; lng?: number | null; }; }; phone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; supportPhone?: { number1?: string | null; number2?: string | null; number3?: string | null; }; legalInformation?: { rc?: string | null; nif?: string | null; ai?: string | null; nis?: string | null; }; owner?: { firstName?: string | null; lastName?: string | null; email?: string | null; }; paymentDays?: string[] | null; certificationCode?: string | null; services?: object[] | null; territories?: object[] | null; }>-resources/supplier.ts:11
webhookEndpointsreadonlyobject-client.ts:66
webhookEndpoints.createpublicPromise<{ id?: string | null; url?: string | null; description?: string | null; eventTypes?: string[] | null; createdAt?: string; }>-resources/webhook-endpoints.ts:25
webhookEndpoints.listpublicPromise<{ endpoints?: object[] | null; }>-resources/webhook-endpoints.ts:34
webhookEndpoints.getpublicPromise<{ id?: string | null; url?: string | null; description?: string | null; eventTypes?: string[] | null; headers?: { headers: | { [key: string]: string; } | null; sensitive: string[] | null; }; createdAt?: string; updatedAt?: string; }>-resources/webhook-endpoints.ts:39
webhookEndpoints.updatepublicPromise<{ id?: string | null; url?: string | null; description?: string | null; eventTypes?: string[] | null; updatedAt?: string; }>-resources/webhook-endpoints.ts:47
webhookEndpoints.deletepublicPromise<void>-resources/webhook-endpoints.ts:56
webhookEndpoints.getHeaderspublicPromise<{ headers?: { headers: | { [key: string]: string; } | null; sensitive: string[] | null; }; }>-resources/webhook-endpoints.ts:64
webhookEndpoints.getSecretpublicPromise<{ secret?: string | null; }>-resources/webhook-endpoints.ts:75
webhookEndpoints.getPortalpublicPromise<{ url?: string | null; token?: string | null; }>-resources/webhook-endpoints.ts:86

Released under the MIT License. Not affiliated with ZR Express.