• 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

    IntegrationShipmentDto

    Shipment data, including where it is picked up from and where it is delivered to

    {
        "originAddress": {
            "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"
        },
        "destinationAddress": {
            "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"
        },
        "receiverName": "XXX YYYY",
        "receiverPhone": "0123456789",
        "receiverPhone2": "0123456789",
        "senderName": "XXX YYYY",
        "senderPhone": "0123456789",
        "shipmentType": "COD",
        "cod": 10,
        "paymentType": "CASH",
        "paymentTypeId": 0,
        "toCollectFromReceiver": "200",
        "toPayToReceiver": "15",
        "description": "string",
        "notes": "string",
        "invoiceNumber": "INV-11111222",
        "quantity": 1,
        "weight": 1,
        "width": 10,
        "length": 10,
        "height": 10,
        "parcelTypeId": 5,
        "serviceTypeId": 12,
        "vehicleTypeId": 3,
        "packageItemsToDeliverList": [
            {}
        ],
        "webhookUrl": "string"
    }
    Built with