Create Job

Jobs

Jobs represent the core delivery operations within your system, encompassing pickup and delivery tasks that need to be executed by your fleet. Effective job management is crucial for optimizing delivery operations, ensuring customer satisfaction, and maintaining operational efficiency. This guide will walk you through how to manage your jobs within the system.

Create a job with pickups and deliveries.

Notes:

job.order_id is required.
job.type must be one of: pickup_delivery, appointment.
Times are epoch seconds.

Parameters

job

dictionary

POST/v1/jobs

curl https://api.lynxo.ai/v1/jobs \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR....." \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{"job":{"order_id":"LLOP2528","timezone":"Asia/Singapore","type":"pickup_delivery","delivery_type":1,"notes":"Handle with care. thanks","package_scanning_required":true,"test_mode":false,"pickups":[{"branch_id":"HYD","notes":"Call before pickup","pickup_slot_from":1751619600,"pickup_slot_to":1751623200,"packages":[{"id":"PKG001","barcode":"BR001"}]}],"deliveries":[{"payment_type":1,"amount":0,"first_order":true,"address":{"coordinates":{"latitude":24.633333,"longitude":46.716667}},"customer":{"name":"Perth Smith","email":"perth@example.com","mobile":"500234561","dial_code":"966"},"notes":"Leave","delivery_slot_from":1751587200,"delivery_slot_to":1751634000,"enable_otp":true,"otp":"437448","packages":[{"id":"PKG001","barcode":"BR001"}]}]}}'

POST/v1/jobs

curl https://api.lynxo.ai/v1/jobs \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR....." \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{"job":{"order_id":"LLOP2528","timezone":"Asia/Singapore","type":"pickup_delivery","delivery_type":1,"notes":"Handle with care. thanks","package_scanning_required":true,"test_mode":false,"pickups":[{"branch_id":"HYD","notes":"Call before pickup","pickup_slot_from":1751619600,"pickup_slot_to":1751623200,"packages":[{"id":"PKG001","barcode":"BR001"}]}],"deliveries":[{"payment_type":1,"amount":0,"first_order":true,"address":{"coordinates":{"latitude":24.633333,"longitude":46.716667}},"customer":{"name":"Perth Smith","email":"perth@example.com","mobile":"500234561","dial_code":"966"},"notes":"Leave","delivery_slot_from":1751587200,"delivery_slot_to":1751634000,"enable_otp":true,"otp":"437448","packages":[{"id":"PKG001","barcode":"BR001"}]}]}}'