PackageOrdersApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| fetchPackageOrderVendors | POST /package-order/fetch-vendors | Find vendors that service specified delivery locations. |
| getPackageOrderSummary | POST /package-order/summary | Calculate complete pricing for a package delivery order. |
| verifyOrderStop | POST /package-order/verify-stop/{id} | Mark a delivery stop as completed with proof. |
fetchPackageOrderVendors
FetchVendorsResponse fetchPackageOrderVendors(FetchVendorsInput)
Find vendors that service specified delivery locations.
Discovers available package delivery vendors based on pickup and dropoff locations, package type, and vendor type. Validates that coordinates are within service boundaries and returns vendors with their pricing information and service coverage details.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| FetchVendorsInput | FetchVendorsInput | Vendor search criteria including locations and package type |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
getPackageOrderSummary
PackageSummaryResponse getPackageOrderSummary(PackageOrderSummaryInput)
Calculate complete pricing for a package delivery order.
Computes total cost including base delivery fee, distance-based pricing, package size fees, multiple stop charges, taxes, vendor fees, and coupon discounts. Validates location service coverage and calculates distances between all stops.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| PackageOrderSummaryInput | PackageOrderSummaryInput | Package order details including vendor, locations, package type, and weight |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
verifyOrderStop
MessageResponse verifyOrderStop(id, signature, photos)
Mark a delivery stop as completed with proof.
Verifies package delivery at a specific stop by uploading signature and photos as proof of delivery. Updates the stop status to verified and stores all uploaded documentation for delivery confirmation.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Order stop ID to verify | [default to null] |
| signature | List | [default to null] | |
| photos | List | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: multipart/form-data
- Accept: application/json; charset=utf-8