For information about prerequisites, see Integrate with LogisticsOrder.
To create an Order, call the Create a new order endpoint and specify the required attributes in the request body.
The request body is specified in JSON format. The following example of a request body shows how to create a new Order:
{ "dropDetails": { "contact": "+15551234567", "location": "Queens" }, "orderSummary": { "invoiceNumber": "12345678", "orderDescription": "This is a sample order description", "totalWeight": { "value": 0, "unit": "grams" }, "totalItems": 0, "totalOrderCost": { "cost": 0, "currencyCode": "USD", "minorUnit": 0 } }, "clientDetails": { "clientName": "JohnDoe", "clientId": "123123123123", //This is a sample value "clientOrderId": "123123123123" //This is a sample value }, "mps": false, "productType": "PARCEL", "planningMode": "onDemand", "modeOfTransport": "AIR", "speedOfTransport": "EXPRESS", "shipmentFlow": "FORWARD", "pickupDetails": { "contact": "+15559876543", "location": "New Jersey", "pickupSlot": { "from": 0, "to": 0 }, "serviceTime": 1 }, "paymentInformation": { "paymentType": "collectAtDelivery", "paymentOption": "CARD" }, "deliveryDetails": { "promisedDeliveryDate": "03-12-2023", "deliverySlot": { "from": 0, "to": 0 }, "serviceTime": 1 }, "actions": { "qcValidation": { "isRequired": true, "requiredAt": "PICKUP" }, "qcValidationChecklist": {}, "kycVerification": { "isRequired": true, "requiredAt": "PICKUP" }, "otpVerification": { "isRequired": true, "requiredAt": "PICKUP" }, "signatureCollection": { "isRequired": true, "requiredAt": "PICKUP" } }, "notificationDetails": { "notificationType": "PICKUP", "notificationMode": "SMS" }, "returnDetails": { "contact": "+15551234567", "location": "Queens", "returnSlot": { "from": 0, "to": 0 }, "serviceTime": 1 }, "priority": 3, "maxAttempts": 5, "teamId": "123123", "containers": [ { "containerType": "Shipment", "dimensions": { "length": "string", "breadth": "string", "height": "string", "unit": "string" }, "weight": { "value": "string", "unit": "string" }, "trackingDetails": { "operator": "string", "trackingId": "string", "isPrimary": true }, "shipmentDetails": [ { "name": "string", "code": "string", "quantity": 1, "totalCost": { "cost": 0, "currencyCode": "string", "minorUnit": 0 } } ] } ] }