• Overview
    • Packages
      • Create a shipment
      • Generate an AWB PDF for one or more packages
      • Get a package's current status
      • Get a package's full status history
      • List the possible package statuses
      • Cancel a package
      • Return a package to sender
      • List the company's service types
      • Calculate a shipment's delivery cost
      • List the company's vehicle types
      • List the company's parcel types
    • Webhooks
      • Package Status Webhook
    • Addresses
      • List the company's address book
      • List regions
      • List a region's cities
      • List a city's villages
      • List villages
    • Schemas
      • NoteMessage
      • AddressDto
      • IntegrationPackageRequestDto
      • ParcelType
      • IntegrationAddressDto
      • CitiesTripsTimeSchedule
      • IntegrationShipmentDto
      • CreatingPackageDto
      • MainCitiesTripsTimeSchedule
      • PackageItemsToDeliver
      • PackageIdentifiersWrapper
      • Address
      • LocalizedKeyData
      • CodChangeRequest
      • PackageStatusResponse
      • Customer
      • CustomerPromo
      • GeofenceData
      • CustomersPaymentTypes
      • DeliveryPaymentType
      • Device
      • DriverFailFollowUp
      • LabelConditionDto
      • LabelDto
      • LclSupplier
      • LenDetails
      • Location
      • MandatoryPackageFieldsConfig
      • NamedObject
      • NoteMessageInfo
      • Package
      • PackageApprovalFail
      • PackageApprovalPostpone
      • PackageApprovalReturn
      • PackageContent
      • PackageContentItem
      • PackageDevice
      • PackageFailure
      • PackageItem
      • PackageLocationMessage
      • PackageTrackingNodeMessage
      • PackageTrackingStatusCount
      • PalShipRole
      • PartnerConfigDto
      • PartnerDto
      • PostponePackageMessageInfo
      • Product
      • ProductExpiryBatchLot
      • ProductVariant
      • ProductVariantOption
      • ServiceType
      • SmsGateway
      • SubPackage
      • User
      • UserAttachmentsDto
      • Vehicle
      • VehicleType
      • GetPackageCostMessage
      • JettShippingRate
      • JettShippingRateDetails
      • NameAndIdDto
      • Region
      • City
      • Village
      • ModelTableMessageVillage
      • MoneyInfoDto

    IntegrationAddressDto

    Address. Identify the location with ANY ONE of: villageId, cityId, village (name) or city (name) — or send several of them. Missing ids are resolved automatically: a village gives its city and region, a city gives its region. Names match the English or Arabic name exactly. If a village name exists in more than one city, also send city or cityId.

    {
        "addressLine1": "123 Main Street, Apartment 2",
        "addressLine2": "Near the central mosque",
        "villageId": 18150,
        "cityId": 6824,
        "regionId": 395,
        "village": "Al Olaya",
        "city": "Riyadh",
        "latitude": 24.7136,
        "longitude": 46.6753,
        "shortAddress": "RRRD2929"
    }
    Built with