• 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

    CreatingPackageDto

    {
        "description": "string",
        "weight": 10,
        "quantity": 10,
        "width": 10,
        "length": 10,
        "height": 10,
        "expectedDeliveryDate": "2023-01-1T00:00:00.692Z",
        "cod": 10,
        "serviceType": "STANDARD",
        "shipmentType": "COD,REGULAR,SWAP,BRING",
        "senderPhone": "0123456789",
        "receiverPhone": "0123456789",
        "senderPhone2": "0123456789",
        "phoneType": "string",
        "receiverName": "XXX YYYY",
        "receiverPhone2": "0123456789",
        "notes": "string",
        "getePaymentLink": "https://saeepay.com/p?i=VAR_PAYMENT_CODE",
        "pincode": 152016,
        "isInsurance": true,
        "isFragile": true,
        "isPackageHasDeliveryNote": true,
        "isflammable": true,
        "isHazardousMaterial": true,
        "isAnimalOrPit": true,
        "isNeedPackaging": true,
        "businessReceiverName": "string",
        "businessSenderName": "string",
        "senderName": "XXX YYYY",
        "invoiceNumber": 11111222,
        "supplierInvoice": "string",
        "serviceTypeId": 0,
        "vehicleTypeId": 0,
        "isFingerprintRequired": true,
        "msisdn": "string",
        "simNumber": "string",
        "paymentType": "CASH",
        "isNeedCooling": true,
        "isNeedMeasurement": true,
        "isNeedPreview": true,
        "isPreventOpen": true,
        "isDestructible": true,
        "toPayToReceiver": 15,
        "toCollectFromReceiver": 200,
        "senderFirstName": "X",
        "senderLastName": "Y",
        "receiverFirstName": "X",
        "receiverLastName": "Y",
        "parcelTypeId": 5,
        "toHub": 0,
        "tripNumber": "string",
        "trip": {
            "createdDate": "2019-08-24T14:15:22.123Z",
            "id": 0,
            "companyId": 0,
            "tripNumber": "string",
            "mainTripCapacity": 0,
            "citiiesTripsTimeSchedules": [
                {
                    "createdDate": "2019-08-24T14:15:22.123Z",
                    "id": 0,
                    "companyId": 0,
                    "fromHubId": 0,
                    "toHubId": 0,
                    "fromTime": "2019-08-24T14:15:22.123Z",
                    "toTime": "2019-08-24T14:15:22.123Z",
                    "days": [
                        "SATURDAY"
                    ],
                    "fromHubName": "string",
                    "toHubName": "string",
                    "tripName": "string",
                    "trips": [
                        {}
                    ],
                    "cost": 0,
                    "isSaturday": true,
                    "isSunday": true,
                    "isMonday": true,
                    "isTuesday": true,
                    "isWednesday": true,
                    "isThursday": true,
                    "isFriday": true,
                    "parcelTypeId": 0,
                    "parcelTypeName": "string",
                    "capacity": 0,
                    "mainCitiesTripsTimeScheduleId": 0,
                    "validFrom": "2019-08-24T14:15:22.123Z",
                    "validTo": "2019-08-24T14:15:22.123Z"
                }
            ]
        },
        "expectedPickupDate": "2019-08-24T14:15:22.123Z",
        "integrationSource": "string",
        "packageItemsToDeliverList": [
            {
                "createdDate": "2019-08-24T14:15:22.123Z",
                "id": 0,
                "companyId": 0,
                "name": "string",
                "sku": "string",
                "quantity": 0,
                "cod": 0,
                "price": 0,
                "status": "IN_PROGRESS",
                "hsCode": "string",
                "netWeight": 0,
                "grossWeight": 0,
                "description": "string",
                "productImageUrl": "string",
                "unit": "BOX",
                "direction": "OUTBOUND",
                "displayName": "string",
                "displayCost": 0
            }
        ],
        "webhookUrl": "string",
        "customerAuthorId": 0,
        "hubId": 0,
        "thirdPartyBarcode": "string",
        "paymentTypeId": 0,
        "cbm": 0,
        "attachmentUrls": [
            "string"
        ],
        "subPackages": [
            {
                "createdDate": "2019-08-24T14:15:22.123Z",
                "id": 0,
                "companyId": 0,
                "weight": 0,
                "width": 0,
                "length": 0,
                "height": 0,
                "invoiceNumber": "string",
                "invoiceNumberBarcodeImage": "string",
                "barcode": "string",
                "barcodeImage": "string",
                "packageId": 0,
                "cost": 0
            }
        ],
        "declaredValue": 0,
        "fromHub": 0
    }
    Built with