GROperator

جارٍ التحميل…

English

النماذج (Schemas)

كل أنواع البيانات المستخدمة في الطلبات والاستجابات. كل اسم هو هدف رابط، فالنقر على نوع حقل في صفحات العمليات ينقلك إلى هنا.

PublicAddressDtoكائن#

A resolved address.

الحقلالنوعالوصف
countryPublicNamedRef

A catalog entry shown in both languages.

cityPublicNamedRef

A catalog entry shown in both languages.

districtPublicNamedRef

A catalog entry shown in both languages.

addressLinestringيقبل null

Street, building and landmark.

shortAddressstringيقبل null

Saudi national short address.

latitudenumber (double)يقبل null

Latitude.

longitudenumber (double)يقبل null

Longitude.

PublicApiErrorكائن#

Error envelope returned for every non-2xx response of the public API (/api/public/v1).

الحقلالنوعالوصف
codestringيقبل null

Stable machine-readable code, e.g. shipment.not_found or validation_failed.

messagestringيقبل null

Human readable message. Arabic by default; English when Accept-Language prefers English.

statusinteger (int32)

HTTP status code, repeated in the body.

detailsobjectيقبل null

Extra data: errors (field to messages) for validation_failed; level, input and candidates for geo errors; messageAr when the message is English.

traceIdstringيقبل null

Correlation id of the request, quote it when contacting support.

PublicApiKeyDtoكائن#

The API key behind a key-authenticated call.

الحقلالنوعالوصف
idstring (uuid)

API key id.

namestringيقبل null

Label given to the key.

PublicBranchDtoكائن#

Public-safe view of a branch (no manager, capacity, counters or other internal fields).

الحقلالنوعالوصف
idstring (uuid)

Branch id.

namestringيقبل null

Branch name.

codestringيقبل null

Branch code.

citystringيقبل null

City name as entered on the branch.

phonestringيقبل null

Branch phone, when set.

latitudenumber (double)يقبل null

Latitude, when set.

longitudenumber (double)يقبل null

Longitude, when set.

isActiveboolean

Whether the branch is active.

PublicBranchDtoPublicPageكائن#

Standard paged response of every public list endpoint.

الحقلالنوعالوصف
itemsarray<PublicBranchDto>يقبل null

Items of the requested page.

pageinteger (int32)

Current page number, starting at 1.

pageSizeinteger (int32)

Requested page size (1 to 100, default 25).

totalCountinteger (int32)

Total number of items across all pages.

totalPagesinteger (int32)

Total number of pages.

PublicBranchRefكائن#

A branch reference.

الحقلالنوعالوصف
idstring (uuid)

Branch id.

namestringيقبل null

Branch name.

PublicCancelShipmentRequestكائن#

Body of POST /shipments/{trackingNumber}/cancel.

الحقلالنوعالوصف
reasonstringيقبل null

Why the shipment is cancelled (kept in the shipment history). Up to 500 characters.

مثال: Customer cancelled the order

PublicCityCoverageDtoكائن#

Whether the company delivers to / picks up from a city.

الحقلالنوعالوصف
cityPublicGeoNodeDto

A resolved geography node (id and both names).

deliveryboolean

True when the company delivers to the city.

pickupboolean

True when the company picks up from the city.

PublicCityDtoكائن#

City item of the public geography endpoints.

الحقلالنوعالوصف
idstring (uuid)

City id.

nameArstringيقبل null

Arabic name.

nameEnstringيقبل null

English name.

codestringيقبل null

City code (unique within its country), when defined.

countryIdstring (uuid)

Id of the country the city belongs to.

pendingboolean

True for a city created by your company that the platform has not approved yet.

PublicCityDtoPublicPageكائن#

Standard paged response of every public list endpoint.

الحقلالنوعالوصف
itemsarray<PublicCityDto>يقبل null

Items of the requested page.

pageinteger (int32)

Current page number, starting at 1.

pageSizeinteger (int32)

Requested page size (1 to 100, default 25).

totalCountinteger (int32)

Total number of items across all pages.

totalPagesinteger (int32)

Total number of pages.

PublicColdChainRangeقائمة قيم#

Temperature range of cold-chain goods.

القيم: frozenchilledambient

PublicCompanyDtoكائن#

Company identity shown by the public auth/me endpoint.

الحقلالنوعالوصف
idstring (uuid)

Company id.

namestringيقبل null

Company name.

slugstringيقبل null

Company slug.

PublicCountryDtoكائن#

Country item of the public geography endpoints.

الحقلالنوعالوصف
idstring (uuid)

Country id.

nameArstringيقبل null

Arabic name.

nameEnstringيقبل null

English name.

codestringيقبل null

ISO 3166-1 alpha-2 code.

PublicCountryDtoPublicPageكائن#

Standard paged response of every public list endpoint.

الحقلالنوعالوصف
itemsarray<PublicCountryDto>يقبل null

Items of the requested page.

pageinteger (int32)

Current page number, starting at 1.

pageSizeinteger (int32)

Requested page size (1 to 100, default 25).

totalCountinteger (int32)

Total number of items across all pages.

totalPagesinteger (int32)

Total number of pages.

PublicCoveredCityDtoكائن#

A city the company covers.

الحقلالنوعالوصف
idstring (uuid)

City id.

nameArstringيقبل null

Arabic name.

nameEnstringيقبل null

English name.

codestringيقبل null

City code, when defined.

countryIdstring (uuid)

Country id.

deliveryboolean

True when the company delivers to the city.

pickupboolean

True when the company picks up from the city.

PublicCoveredCityDtoPublicPageكائن#

Standard paged response of every public list endpoint.

الحقلالنوعالوصف
itemsarray<PublicCoveredCityDto>يقبل null

Items of the requested page.

pageinteger (int32)

Current page number, starting at 1.

pageSizeinteger (int32)

Requested page size (1 to 100, default 25).

totalCountinteger (int32)

Total number of items across all pages.

totalPagesinteger (int32)

Total number of pages.

PublicCreateMerchantAddressRequestكائن#

Body of POST /merchants/{id}/addresses.

الحقلالنوعالوصف
label
مطلوب
stringيقبل null

Short label of the address, for example "Main warehouse". Required, up to 100 characters.

مثال: Main warehouse

contactNamestringيقبل null

Person to contact at this address (defaults to the merchant name).

مثال: Omar Hassan

contactPhone
مطلوب
stringيقبل null

Phone at this address. Required.

مثال: 0501234567

countrystringيقبل null

Country id, ISO code or name. Optional when the city name is unambiguous.

مثال: SA

city
مطلوب
stringيقبل null

City id, code or name. Required.

مثال: Riyadh

district
مطلوب
stringيقبل null

District id, code or name. Required. Unknown districts are never created: you get geo_district_not_found.

مثال: Al Olaya

addressLine
مطلوب
stringيقبل null

Street, building and landmark. Required, up to 500 characters.

مثال: King Fahd Road, Warehouse 4

shortAddress
مشروط
stringيقبل null

Saudi national short address (4 letters and 4 digits). Required for addresses in Saudi Arabia.

مثال: RNBA6769

latitudenumber (double)يقبل null

Latitude (optional).

مثال: 24.7136

longitudenumber (double)يقبل null

Longitude (optional).

مثال: 46.6753

makePrimaryboolean

Make this the primary address (the first address of a merchant is always primary).

مثال: false

PublicCreateMerchantRequestكائن#

Body of POST /merchants.

الحقلالنوعالوصف
name
مطلوب
stringيقبل null

Account (store) name. Not unique, but a name that matches another merchant on the platform needs confirmPossibleDuplicate. Required, up to 200 characters.

مثال: Noor Electronics

contactNamestringيقبل null

Contact person.

مثال: Omar Hassan

contactPhonestringيقبل null

Contact phone.

مثال: 0501234567

contactEmail
مطلوب
stringيقبل null

Contact email. Required; unique across the platform.

مثال: orders@noor-electronics.example

commercialRegNo
مطلوب
stringيقبل null

Commercial registration number (or freelance licence number). Required.

مثال: 1010123456

taxId
مشروط
stringيقبل null

VAT number. Required unless notVatRegistered is true.

مثال: 300123456700003

notVatRegisteredboolean

True when the merchant is not registered for VAT.

مثال: false

addressPublicMerchantAddressInput

A saved pickup address of a merchant, given by names. Country, city and district each accept an id, a code or a name in Arabic or English.

confirmPossibleDuplicateboolean

Confirm that this is a different store even though its registration number, VAT number or name matches another merchant on the platform. Without it such a request is refused with 409 merchant.possible_duplicate.

مثال: false

PublicCreateShipmentRequestكائن#

Body of POST /shipments. Prices are computed from the company's rate card; never send a fee.

الحقلالنوعالوصف
referencestringيقبل null

Your own order reference (shown on the label and searchable). Up to 100 characters.

مثال: ORD-1001

serviceTypeenum

Kind of service requested for a shipment.

القيم: deliveryexchangereturn

serviceTierenum

Speed of the service; it drives the estimated delivery date.

القيم: standardexpresssameDay

senderPublicSenderInput

The sender of a shipment.

pickupPublicPickupInput

The pickup address.

recipientPublicRecipientInput

The recipient and the delivery address.

parcelPublicParcelInput

The parcel. Weight and dimensions describe the whole shipment.

paymentPublicPaymentInput

Cash on delivery and freight payment.

deliveryPublicDeliveryOptionsInput

Handover rules at the recipient's door. Omitted values use the system defaults shown.

PublicCreateWebhookRequestكائن#

Body of POST /merchants/{merchantId}/webhooks.

الحقلالنوعالوصف
urlstringيقبل null

HTTPS URL that receives the events. Private and local addresses are refused.

مثال: https://shop.example.com/hooks/lastmile

eventsarray<string>يقبل null

Event types to receive, from GET /webhooks/events. Wildcards: shipment.* (all shipment events) or * (everything). At least one.

مثال: ["shipment.created","shipment.delivered"]

descriptionstringيقبل null

Free text to recognise the subscription (optional, up to 200 characters).

مثال: Order system

PublicDeliveryOptionsDtoكائن#

Handover rules.

الحقلالنوعالوصف
allowOpenPackageboolean

The recipient may open the package.

requireSignatureboolean

Signature required.

requireIdVerificationboolean

ID check required.

allowNeighborDeliveryboolean

Neighbour delivery allowed.

PublicDeliveryOptionsInputكائن#

Handover rules at the recipient's door. Omitted values use the system defaults shown.

الحقلالنوعالوصف
allowOpenPackagebooleanيقبل null

The recipient may open the package before accepting. Default false.

مثال: false

requireSignature
مشروط
booleanيقبل null

A signature is required on delivery. Default true.

مثال: true

requireIdVerificationbooleanيقبل null

The courier must verify the recipient's ID. Default false.

مثال: false

allowNeighborDeliverybooleanيقبل null

A neighbour may accept the parcel. Default true.

مثال: true

PublicDistrictDtoكائن#

District item of the public geography endpoints.

الحقلالنوعالوصف
idstring (uuid)

District id.

nameArstringيقبل null

Arabic name.

nameEnstringيقبل null

English name.

codestringيقبل null

District code, when defined.

cityIdstring (uuid)

Id of the city the district belongs to.

pendingboolean

True for a district created by your company that the platform has not approved yet.

PublicDistrictDtoPublicPageكائن#

Standard paged response of every public list endpoint.

الحقلالنوعالوصف
itemsarray<PublicDistrictDto>يقبل null

Items of the requested page.

pageinteger (int32)

Current page number, starting at 1.

pageSizeinteger (int32)

Requested page size (1 to 100, default 25).

totalCountinteger (int32)

Total number of items across all pages.

totalPagesinteger (int32)

Total number of pages.

PublicGeoNodeDtoكائن#

A resolved geography node (id and both names).

الحقلالنوعالوصف
idstring (uuid)

Resolved id.

nameArstringيقبل null

Arabic name.

nameEnstringيقبل null

English name.

PublicLoginRequestكائن#

Credentials of a user of the shipping company.

الحقلالنوعالوصف
usernamestringيقبل null

Username or e-mail address.

passwordstringيقبل null

Password.

PublicMerchantAddressDtoكائن#

A saved pickup address of a merchant.

الحقلالنوعالوصف
idstring (uuid)

Address id.

labelstringيقبل null

Short label.

contactNamestringيقبل null

Contact person at the address.

contactPhonestringيقبل null

Phone at the address.

countryPublicNamedRef

A catalog entry shown in both languages.

cityPublicNamedRef

A catalog entry shown in both languages.

districtPublicNamedRef

A catalog entry shown in both languages.

addressLinestringيقبل null

Street, building and landmark.

shortAddressstringيقبل null

Saudi national short address.

latitudenumber (double)يقبل null

Latitude.

longitudenumber (double)يقبل null

Longitude.

isPrimaryboolean

True for the primary address (used by default as the pickup of the merchant's shipments).

PublicMerchantAddressInputكائن#

A saved pickup address of a merchant, given by names. Country, city and district each accept an id, a code or a name in Arabic or English.

الحقلالنوعالوصف
label
مطلوب
stringيقبل null

Short label of the address, for example "Main warehouse". Required, up to 100 characters.

مثال: Main warehouse

contactNamestringيقبل null

Person to contact at this address (defaults to the merchant name).

مثال: Omar Hassan

contactPhone
مطلوب
stringيقبل null

Phone at this address. Required.

مثال: 0501234567

countrystringيقبل null

Country id, ISO code or name. Optional when the city name is unambiguous.

مثال: SA

city
مطلوب
stringيقبل null

City id, code or name. Required.

مثال: Riyadh

district
مطلوب
stringيقبل null

District id, code or name. Required. Unknown districts are never created: you get geo_district_not_found.

مثال: Al Olaya

addressLine
مطلوب
stringيقبل null

Street, building and landmark. Required, up to 500 characters.

مثال: King Fahd Road, Warehouse 4

shortAddress
مشروط
stringيقبل null

Saudi national short address (4 letters and 4 digits). Required for addresses in Saudi Arabia.

مثال: RNBA6769

latitudenumber (double)يقبل null

Latitude (optional).

مثال: 24.7136

longitudenumber (double)يقبل null

Longitude (optional).

مثال: 46.6753

PublicMerchantDtoكائن#

A merchant of the company (no banking, commission, API keys or pricing details).

الحقلالنوعالوصف
idstring (uuid)

Merchant id.

namestringيقبل null

Account name.

contactNamestringيقبل null

Contact person.

contactPhonestringيقبل null

Contact phone.

contactEmailstringيقبل null

Contact email.

isActiveboolean

Whether the merchant can book shipments.

createdAtstring (date-time)

Creation time (UTC).

primaryAddressPublicMerchantAddressDto

A saved pickup address of a merchant.

PublicMerchantDtoPublicPageكائن#

Standard paged response of every public list endpoint.

الحقلالنوعالوصف
itemsarray<PublicMerchantDto>يقبل null

Items of the requested page.

pageinteger (int32)

Current page number, starting at 1.

pageSizeinteger (int32)

Requested page size (1 to 100, default 25).

totalCountinteger (int32)

Total number of items across all pages.

totalPagesinteger (int32)

Total number of pages.

PublicMerchantRefكائن#

A merchant reference.

الحقلالنوعالوصف
idstring (uuid)

Merchant id.

namestringيقبل null

Merchant account name.

PublicMeResponseكائن#

Identity and permissions of the current caller.

الحقلالنوعالوصف
authMethodstringيقبل null

password or api_key.

companyPublicCompanyDto

Company identity shown by the public auth/me endpoint.

userPublicUserDto

The user behind a password-authenticated call.

apiKeyPublicApiKeyDto

The API key behind a key-authenticated call.

scopesarray<string>يقبل null

API scopes granted (for password callers: the scopes the user's permissions cover).

permissionsarray<string>يقبل null

Permission codes held by the caller.

PublicNamedRefكائن#

A catalog entry shown in both languages.

الحقلالنوعالوصف
idstring (uuid)يقبل null

Catalog id, or null for legacy shipments that only stored a name.

nameArstringيقبل null

Arabic name.

nameEnstringيقبل null

English name.

PublicOrderSourceقائمة قيم#

How the order reached the system.

القيم: dashboardexcelImportmerchantPortalapiintegrationinviteLinkpublicWebsitephonewhatsAppsocialMediawalkInother

PublicParcelDtoكائن#

Parcel data of a shipment.

الحقلالنوعالوصف
weightKgnumber (double)

Actual weight.

lengthCmnumber (double)

Length.

widthCmnumber (double)

Width.

heightCmnumber (double)

Height.

chargeableWeightKgnumber (double)

Weight used for pricing: the larger of actual and volumetric weight.

piecesinteger (int32)

Number of pieces.

descriptionstringيقبل null

What is inside.

declaredValuenumber (double)

Declared value.

fragileboolean

Fragile.

requiresColdChainboolean

Needs cold chain.

coldChainRangeenum

Temperature range of cold-chain goods.

القيم: frozenchilledambient

flammableboolean

Flammable.

hazardousboolean

Hazardous.

containsAlcoholboolean

Contains alcohol.

liquidboolean

Liquid.

highValueboolean

High value.

PublicParcelInputكائن#

The parcel. Weight and dimensions describe the whole shipment.

الحقلالنوعالوصف
weightKg
مطلوب
number (double)

Actual weight in kilograms, greater than 0.

مثال: 1.5

lengthCm
مطلوب
number (double)

Length in centimetres, greater than 0.

مثال: 20

widthCm
مطلوب
number (double)

Width in centimetres, greater than 0.

مثال: 15

heightCm
مطلوب
number (double)

Height in centimetres, greater than 0.

مثال: 10

piecesinteger (int32)يقبل null

Number of pieces (default 1).

مثال: 1

descriptionstringيقبل null

What is inside (optional, shown on the label).

مثال: Mobile phone case

declaredValuenumber (double)يقبل null

Declared value of the goods (default 0).

مثال: 250

fragileboolean

Fragile goods.

مثال: false

requiresColdChain
مشروط
boolean

Needs cold chain; then coldChainRange is required.

مثال: false

coldChainRangeenum

Temperature range of cold-chain goods.

القيم: frozenchilledambient

flammableboolean

Flammable goods.

مثال: false

hazardousboolean

Hazardous goods.

مثال: false

containsAlcoholboolean

Contains alcohol.

مثال: false

liquidboolean

Liquid goods.

مثال: false

highValueboolean

High-value goods.

مثال: false

PublicPaymentDtoكائن#

Payment data of a shipment.

الحقلالنوعالوصف
codAmountnumber (double)

Cash to collect from the recipient.

shippingFeenumber (double)

Shipping fee computed from the rate card.

freightOnDeliveryboolean

True when the recipient pays the fee.

PublicPaymentInputكائن#

Cash on delivery and freight payment.

الحقلالنوعالوصف
codAmountnumber (double)يقبل null

Amount the courier collects from the recipient (cash on delivery). Default 0. Must be 0 for return.

مثال: 199.5

freightOnDeliverybooleanيقبل null

True when the recipient pays the shipping fee on delivery.

مثال: false

PublicPickupInputكائن#

The pickup address.

الحقلالنوعالوصف
countrystringيقبل null

Country id, ISO code or name. Optional when the city name is unambiguous.

مثال: SA

city
مطلوب
stringيقبل null

City id, code or name. Required.

مثال: Riyadh

district
مطلوب
stringيقبل null

District id, code or name. Required. Unknown districts are never created: you get geo_district_not_found.

مثال: Al Olaya

addressLine
مطلوب
stringيقبل null

Street, building and landmark. Required, up to 500 characters.

مثال: King Fahd Road, Building 12, Floor 3

shortAddress
مشروط
stringيقبل null

Saudi national short address: 4 letters and 4 digits. Required when the city is in Saudi Arabia.

مثال: RNBA6769

latitudenumber (double)يقبل null

Latitude, -90 to 90 (optional).

مثال: 24.7136

longitudenumber (double)يقبل null

Longitude, -180 to 180 (optional).

مثال: 46.6753

branchstringيقبل null

Branch that handles the pickup: branch id, code or name. Optional; by default the branch covering the pickup district is chosen automatically (branch_coverage.no_coverage_for_city when none covers it).

مثال: RUH-01

PublicPieceDtoكائن#

One piece of a shipment.

الحقلالنوعالوصف
barcodestringيقبل null

Piece barcode (the tracking number followed by -P1, -P2...).

PublicQuoteDtoكائن#

A price quote. Nothing is created or consumed: no tracking number, no quota.

الحقلالنوعالوصف
deliverableboolean

False when the company does not cover the pickup or the destination (see reason).

reasonstringيقبل null

destination_not_covered, pickup_not_covered or rate_card_not_found when not deliverable.

shippingFeenumber (double)يقبل null

Shipping fee without the COD fee (weight price plus handling surcharges).

codFeenumber (double)يقبل null

Fee charged for collecting cash on delivery.

totalnumber (double)يقبل null

What the shipment will be charged: shippingFee + codFee. Equals payment.shippingFee of the created shipment.

chargeableWeightKgnumber (double)يقبل null

The larger of actual and volumetric weight.

zonePublicZoneRef

A pricing zone.

breakdownarray<PublicQuoteLineDto>يقبل null

Price lines; they add up to total.

PublicQuoteLineDtoكائن#

One line of a price.

الحقلالنوعالوصف
codestringيقبل null

baseShipping, handling, codFee or reverseAdjustment.

labelstringيقبل null

Readable label (the handling flag name for handling lines).

amountnumber (double)

Amount of the line.

PublicQuoteLocationInputكائن#

A place given by names for a quote. Each level accepts an id, a code or a name in Arabic or English.

الحقلالنوعالوصف
countrystringيقبل null

Country id, ISO code or name. Optional when the city name is unambiguous.

مثال: SA

city
مطلوب
stringيقبل null

City id, code or name. Required.

مثال: Jeddah

districtstringيقبل null

District id, code or name. Optional for a quote; when sent it must exist.

مثال: Al Rawdah

PublicQuoteRequestكائن#

Body of POST /pricing/quote.

الحقلالنوعالوصف
merchant
مشروط
stringيقبل null

Merchant id or exact account name; the merchant's own rate card applies. Optional: without it the company's default pricing is used. A merchant login always quotes for itself. Required for return quotes.

مثال: Noor Electronics

pickupPublicQuoteLocationInput

A place given by names for a quote. Each level accepts an id, a code or a name in Arabic or English.

recipientPublicQuoteLocationInput

A place given by names for a quote. Each level accepts an id, a code or a name in Arabic or English.

parcelPublicParcelInput

The parcel. Weight and dimensions describe the whole shipment.

paymentPublicPaymentInput

Cash on delivery and freight payment.

serviceTypeenum

Kind of service requested for a shipment.

القيم: deliveryexchangereturn

serviceTierenum

Speed of the service; it drives the estimated delivery date.

القيم: standardexpresssameDay

PublicRecipientDtoكائن#

The recipient.

الحقلالنوعالوصف
namestringيقبل null

Recipient name.

phonestringيقبل null

Recipient phone.

secondaryPhonestringيقبل null

Second phone.

countryPublicNamedRef

A catalog entry shown in both languages.

cityPublicNamedRef

A catalog entry shown in both languages.

districtPublicNamedRef

A catalog entry shown in both languages.

addressLinestringيقبل null

Street, building and landmark.

shortAddressstringيقبل null

Saudi national short address.

latitudenumber (double)يقبل null

Latitude.

longitudenumber (double)يقبل null

Longitude.

PublicRecipientInputكائن#

The recipient and the delivery address.

الحقلالنوعالوصف
countrystringيقبل null

Country id, ISO code or name. Optional when the city name is unambiguous.

مثال: SA

city
مطلوب
stringيقبل null

City id, code or name. Required.

مثال: Riyadh

district
مطلوب
stringيقبل null

District id, code or name. Required. Unknown districts are never created: you get geo_district_not_found.

مثال: Al Olaya

addressLine
مطلوب
stringيقبل null

Street, building and landmark. Required, up to 500 characters.

مثال: King Fahd Road, Building 12, Floor 3

shortAddress
مشروط
stringيقبل null

Saudi national short address: 4 letters and 4 digits. Required when the city is in Saudi Arabia.

مثال: RNBA6769

latitudenumber (double)يقبل null

Latitude, -90 to 90 (optional).

مثال: 24.7136

longitudenumber (double)يقبل null

Longitude, -180 to 180 (optional).

مثال: 46.6753

name
مطلوب
stringيقبل null

Recipient name. Required, up to 200 characters.

مثال: Khaled Alotaibi

phone
مطلوب
stringيقبل null

Recipient phone. Required; digits, spaces, +, - and brackets.

مثال: 0555123456

secondaryPhonestringيقبل null

Second phone (optional).

مثال: 0555987654

PublicRefreshRequestكائن#

Request to exchange a refresh token for a new token pair.

الحقلالنوعالوصف
refreshTokenstringيقبل null

The refresh token returned by login or by a previous refresh (single use).

PublicResolvedLocationDtoكائن#

Result of validating a location by names.

الحقلالنوعالوصف
countryPublicGeoNodeDto

A resolved geography node (id and both names).

cityPublicGeoNodeDto

A resolved geography node (id and both names).

districtPublicGeoNodeDto

A resolved geography node (id and both names).

PublicSenderDtoكائن#

The sender of a shipment.

الحقلالنوعالوصف
typeenum

Who sends the shipment.

القيم: merchantcustom

namestringيقبل null

Sender name.

phonestringيقبل null

Sender phone.

emailstringيقبل null

Sender email.

merchantPublicMerchantRef

A merchant reference.

PublicSenderInputكائن#

The sender of a shipment.

الحقلالنوعالوصف
typeenum

Who sends the shipment.

القيم: merchantcustom

merchantstringيقبل null

For merchant: the merchant id, or the exact account name (compared ignoring case and Arabic letter variants).

مثال: 3fa85f64-5717-4562-b3fc-2c963f66afa6

namestringيقبل null

For custom: sender name (required).

مثال: Sara Ahmed

phonestringيقبل null

For custom: sender phone (required).

مثال: 0501234567

emailstringيقبل null

For custom: sender email (optional).

مثال: sara@example.com

PublicSenderTypeقائمة قيم#

Who sends the shipment.

القيم: merchantcustom

PublicServiceTierقائمة قيم#

Speed of the service; it drives the estimated delivery date.

القيم: standardexpresssameDay

PublicServiceTypeقائمة قيم#

Kind of service requested for a shipment.

القيم: deliveryexchangereturn

PublicShipmentDtoكائن#

A shipment as returned by the public API.

الحقلالنوعالوصف
trackingNumberstringيقبل null

Tracking number; identifies the shipment in every route.

referencestringيقبل null

Your order reference.

statusstringيقبل null

Status key, e.g. created, outForDelivery, delivered. See GET /shipments/statuses.

statusCodeinteger (int32)

Numeric status code.

statusLabelArstringيقبل null

Arabic status label.

statusLabelEnstringيقبل null

English status label.

isFinalboolean

True when the shipment reached a final status.

serviceTypeenum

Kind of service requested for a shipment.

القيم: deliveryexchangereturn

serviceTierenum

Speed of the service; it drives the estimated delivery date.

القيم: standardexpresssameDay

sourceenum

How the order reached the system.

القيم: dashboardexcelImportmerchantPortalapiintegrationinviteLinkpublicWebsitephonewhatsAppsocialMediawalkInother

createdAtstring (date-time)

Creation time (UTC).

estimatedDeliveryDatestring (date)يقبل null

Estimated delivery date (yyyy-MM-dd), when known.

senderPublicSenderDto

The sender of a shipment.

pickupPublicAddressDto

A resolved address.

recipientPublicRecipientDto

The recipient.

parcelPublicParcelDto

Parcel data of a shipment.

deliveryPublicDeliveryOptionsDto

Handover rules.

paymentPublicPaymentDto

Payment data of a shipment.

piecesarray<PublicPieceDto>يقبل null

The pieces.

branchPublicBranchRef

A branch reference.

canCancelboolean

True while the shipment can still be cancelled.

isEditableboolean

True while the shipment can still be edited.

PublicShipmentSummaryDtoكائن#

A shipment row of the list endpoint.

الحقلالنوعالوصف
trackingNumberstringيقبل null

Tracking number.

referencestringيقبل null

Your order reference.

statusstringيقبل null

Status key.

statusLabelArstringيقبل null

Arabic status label.

statusLabelEnstringيقبل null

English status label.

merchantPublicMerchantRef

A merchant reference.

senderNamestringيقبل null

Sender name.

recipientNamestringيقبل null

Recipient name.

recipientPhonestringيقبل null

Recipient phone.

cityPublicNamedRef

A catalog entry shown in both languages.

districtPublicNamedRef

A catalog entry shown in both languages.

codAmountnumber (double)

Cash on delivery amount.

shippingFeenumber (double)

Shipping fee.

createdAtstring (date-time)

Creation time (UTC).

estimatedDeliveryDatestring (date)يقبل null

Estimated delivery date.

PublicShipmentSummaryDtoPublicPageكائن#

Standard paged response of every public list endpoint.

الحقلالنوعالوصف
itemsarray<PublicShipmentSummaryDto>يقبل null

Items of the requested page.

pageinteger (int32)

Current page number, starting at 1.

pageSizeinteger (int32)

Requested page size (1 to 100, default 25).

totalCountinteger (int32)

Total number of items across all pages.

totalPagesinteger (int32)

Total number of pages.

PublicStatusDtoكائن#

A shipment status of the catalog.

الحقلالنوعالوصف
codeinteger (int32)

Numeric status code.

keystringيقبل null

Status key used in the API.

nameArstringيقبل null

Arabic name.

nameEnstringيقبل null

English name.

isFinalboolean

True when no further status follows (delivered, returned to sender, cancelled, lost, disposed).

PublicTokenResponseكائن#

Token pair returned by login and refresh.

الحقلالنوعالوصف
accessTokenstringيقبل null

JWT to send as Authorization: Bearer ....

refreshTokenstringيقبل null

Single-use refresh token.

tokenTypestringيقبل null

Always Bearer.

expiresIninteger (int32)

Lifetime of the access token in seconds.

PublicTrackingDtoكائن#

Tracking of one shipment.

الحقلالنوعالوصف
trackingNumberstringيقبل null

Tracking number.

statusstringيقبل null

Current status key.

statusLabelArstringيقبل null

Arabic label of the current status.

statusLabelEnstringيقبل null

English label of the current status.

estimatedDeliveryDatestring (date)يقبل null

Estimated delivery date.

eventsarray<PublicTrackingEventDto>يقبل null

Timeline, oldest first.

PublicTrackingEventDtoكائن#

One step of the status timeline.

الحقلالنوعالوصف
statusstringيقبل null

Status key.

statusLabelArstringيقبل null

Arabic label.

statusLabelEnstringيقبل null

English label.

atstring (date-time)

When the status was set (UTC).

notestringيقبل null

Reason, only for failed attempts, postponements, cancellation, returns, loss and damage.

locationstringيقبل null

Reserved; not populated yet.

PublicUpdateMerchantRequestكائن#

Body of PUT /merchants/{id}. Only the fields you send change.

الحقلالنوعالوصف
namestringيقبل null

New account name.

مثال: Noor Electronics

contactNamestringيقبل null

New contact person.

مثال: Omar Hassan

contactPhonestringيقبل null

New contact phone.

مثال: 0501234567

contactEmailstringيقبل null

New contact email.

مثال: orders@noor-electronics.example

PublicUpdateParcelInputكائن#

Parcel fields that can change. Only the fields you send are changed.

الحقلالنوعالوصف
weightKgnumber (double)يقبل null

Weight in kilograms.

مثال: 2

lengthCmnumber (double)يقبل null

Length in centimetres.

مثال: 20

widthCmnumber (double)يقبل null

Width in centimetres.

مثال: 15

heightCmnumber (double)يقبل null

Height in centimetres.

مثال: 10

piecesinteger (int32)يقبل null

Number of pieces.

مثال: 1

declaredValuenumber (double)يقبل null

Declared value of the goods.

مثال: 300

PublicUpdateRecipientInputكائن#

Recipient fields that can change. Sending any address field re-resolves the whole address (city and district are then required).

الحقلالنوعالوصف
countrystringيقبل null

Country id, ISO code or name. Optional when the city name is unambiguous.

مثال: SA

city
مطلوب
stringيقبل null

City id, code or name. Required.

مثال: Riyadh

district
مطلوب
stringيقبل null

District id, code or name. Required. Unknown districts are never created: you get geo_district_not_found.

مثال: Al Olaya

addressLine
مطلوب
stringيقبل null

Street, building and landmark. Required, up to 500 characters.

مثال: King Fahd Road, Building 12, Floor 3

shortAddress
مشروط
stringيقبل null

Saudi national short address: 4 letters and 4 digits. Required when the city is in Saudi Arabia.

مثال: RNBA6769

latitudenumber (double)يقبل null

Latitude, -90 to 90 (optional).

مثال: 24.7136

longitudenumber (double)يقبل null

Longitude, -180 to 180 (optional).

مثال: 46.6753

namestringيقبل null

Recipient name.

مثال: Khaled Alotaibi

phonestringيقبل null

Recipient phone.

مثال: 0555123456

secondaryPhonestringيقبل null

Second phone.

مثال: 0555987654

PublicUpdateShipmentRequestكائن#

Body of PUT /shipments/{trackingNumber}. Every field except reason is optional: only the fields you send change, everything else keeps its current value. At least one field is required.

الحقلالنوعالوصف
reason
مطلوب
stringيقبل null

Why the shipment is edited (kept in the shipment's audit trail). Required, up to 300 characters.

مثال: Customer changed the delivery address

referencestringيقبل null

New order reference.

مثال: ORD-1001-B

recipientPublicUpdateRecipientInput

Recipient fields that can change. Sending any address field re-resolves the whole address (city and district are then required).

parcelPublicUpdateParcelInput

Parcel fields that can change. Only the fields you send are changed.

paymentPublicPaymentInput

Cash on delivery and freight payment.

PublicUserDtoكائن#

The user behind a password-authenticated call.

الحقلالنوعالوصف
idstring (uuid)

User id.

namestringيقبل null

Full name.

PublicWebhookCreatedDtoكائن#

A newly created subscription. The signing secret is returned here once and cannot be read again.

الحقلالنوعالوصف
idstring (uuid)

Subscription id.

merchantIdstring (uuid)

The merchant whose shipments trigger the events.

urlstringيقبل null

The receiving URL.

eventsarray<string>يقبل null

Subscribed event types.

descriptionstringيقبل null

Description.

isActiveboolean

Whether it is active.

createdAtstring (date-time)

Creation time (UTC).

secretstringيقبل null

Signing secret: keep it safe, use it to verify the X-Signature header of every delivery.

PublicWebhookDtoكائن#

A webhook subscription of a merchant.

الحقلالنوعالوصف
idstring (uuid)

Subscription id.

merchantIdstring (uuid)

The merchant whose shipments trigger the events.

urlstringيقبل null

The receiving URL.

eventsarray<string>يقبل null

Subscribed event types.

descriptionstringيقبل null

Description.

isActiveboolean

False when the subscription is paused.

createdAtstring (date-time)

Creation time (UTC).

PublicWebhookEventDtoكائن#

An event type that can be subscribed to.

الحقلالنوعالوصف
typestringيقبل null

Event type, e.g. shipment.delivered.

descriptionstringيقبل null

When the event is sent.

examplePayloadanyيقبل null

An example of the JSON body of the delivery (event, occurredAt, data).

PublicWebhookSecretDtoكائن#

A rotated signing secret (shown once; the previous secret stops working immediately).

الحقلالنوعالوصف
secretstringيقبل null

The new signing secret.

PublicWebhookTestDtoكائن#

Result of a test delivery request.

الحقلالنوعالوصف
queuedboolean

True when a signed ping event was queued for delivery.

eventTypestringيقبل null

The event type sent (ping).

PublicZoneRefكائن#

A pricing zone.

الحقلالنوعالوصف
idstring (uuid)

Zone id.

namestringيقبل null

Zone name.