Create orders in batch

1 min

POST

https://{domain}/app/logisticsorders/v1/api/orders/batch

Header Parameters

X-COREOS-REQUEST-IDstringrequired
Description
Unique requestId
X-COREOS-TIDstringrequired
Description
Tenant id
X-COREOS-ACCESSstringrequired
Description
core-os access token
X-COREOS-USERINFOstringrequired
Description
core-os user info token
X-COREOS-CALLBACK-SECRETstring
Description
Core-os secret token

Body Parameters

bodyCreateBatchOrderEntityRequestrequired
- ordersOrderEntity[]
  - dropDetailsDropDetailsrequired
    - DropDetailsUpdateRequest
      - contactContact
        UniqueId
        ContactDetails
        Max depth limit reached
      - locationLocation
        UniqueId
        LocationDetails
        Max depth limit reached
  - orderSummaryOrderSummary
    - invoiceNumberstring
      Description
      Invoice Number associated with the order
    - orderDescriptionstring
      Description
      Description of the order
    - totalWeightTotalOrderWeight
      Description
      Total weight of the order
      - valuenumberrequired
    - totalVolumeTotalOrderVolume
      Description
      Total volume of the order
      - valuenumberrequired
    - totalItemsnumber
      Description
      Total number of containers in the order
    - totalOrderCostTotalOrderCost
      Description
      Total cost of the order
      - costnumberrequired
        Description
        value of cost incurred
      - currencyCodestring
        Description
        currency code
      - minorUnitnumber
        Description
        unit of cost
    - totalInvoiceInvoice
      Description
      invoice of order
      - valueinteger
        Description
        total invoice value of the order
      - currencyCodestring
        Description
        currency code
      - minorUnitinteger
        Description
        unit of invoice
  - clientDetailsClientDetailsrequired
    Description
    Client details
    - clientNamestring
    - clientIdUniqueId
      Description
      Unique ID. Combination of entity name and UUID.
    - clientOrderIdUniqueIdrequired
      Description
      Unique ID. Combination of entity name and UUID.
  - mpsMps
    - MpsUpdateRequest
      - groupIdstring
        Description
        Stores the Master object of an MPS lot
      - groupSizenumber
        Description
        Stores the count of objects in an MPS lot
      - isEnabledboolean
        Description
        Flag to identity if order is a multi-piece shipment
      - isPartialboolean
        Description
        Indicates if partial delivery is enabled for an MPS lot
  - eWaybillAttributeseWaybillAttributes
    - eWaybillAttributesRequest
      - is_valid_ewaybillboolean
        Description
        Flag to identity if ewaybill is valid
      - ewaybillsstring[]
        Description
        list of ewaybills
  - productTypeProductTyperequired
    Description
    Type of the product in the order
  - planningModePlanningMode
    Description
    Fulfillment Type
  - modeOfTransportModeOfTransport
    Description
    Mode via which shipment will be moved
  - speedOfTransportSpeedOfTransport
    Description
    Speed of transfer of shipment
  - shipmentFlowShipmentFlowrequired
    Description
    Nature of flow of shipment
  - pickupDetailsPickupDetailsrequired
    - PickupDetailsUpdateRequest
      - contactContact
        UniqueId
        ContactDetails
        Max depth limit reached
      - locationLocation
        UniqueId
        LocationDetails
        Max depth limit reached
      - pickupSlotTimeSlot
        Description
        Time Slot
        frominteger<int64>
        tointeger<int64>
      - serviceTimeinteger
        Description
        Number of seconds needed to complete the task
      - instructionstring
        Description
        instruction for the FE at the time of performing a pickup or drop objective.
  - paymentInformationPaymentInformation
    Description
    Payment Information
    - paymentTypePaymentType
      Description
      Type of payment done for the order
    - paymentOptionPaymentOption
      Description
      Mode of payment
  - deliveryDetailsDeliveryDetails
    Description
    Delivery details
    - promisedDeliveryDatestring
    - deliverySlotTimeSlot
      Description
      Time Slot
      - frominteger<int64>
      - tointeger<int64>
    - serviceTimeinteger
      Description
      Number of seconds needed to complete the task
    - instructionstring
      Description
      instruction for the FE at the time of performing a pickup or drop objective.
  - actionsDoorstepActions
    Description
    Doorstep actions information
    - qcValidationActionRequired
      - isRequiredbooleanrequired
      - requiredAtstring<PICKUP | DROP | BOTH>
    - qcValidationChecklistobject
      Description
      Checklist for QCValidation
    - kycVerificationActionRequired
      - isRequiredbooleanrequired
      - requiredAtstring<PICKUP | DROP | BOTH>
    - otpVerificationActionRequired
      - isRequiredbooleanrequired
      - requiredAtstring<PICKUP | DROP | BOTH>
    - signatureCollectionActionRequired
      - isRequiredbooleanrequired
      - requiredAtstring<PICKUP | DROP | BOTH>
  - notificationDetailsNotificationDetails
    Description
    Notification Information
    - notificationTypeNotificationType
      Description
      Key to identify if notification is needed at pickup or drop or both
    - notificationModeNotificationMode
      Description
      Notifcaition mode to identify what mediums should the notification go through
  - returnDetailsReturnDetails
    Description
    Return details
    - contactContact
      - UniqueId
      - ContactDetails
        namestringrequired
        Description
        Contact name
        phonePhone
        Description
        phone type data type, which consists below fields.
        Max depth limit reached
        emailMultipleEmail
        Email
        Max depth limit reached
        AdditionalEmail
        Max depth limit reached
        additionalPhonePhone[]
        Description
        phone type data type, which consists below fields.
        Max depth limit reached
        additionalEmailAdditionalEmail[]
        Max depth limit reached
    - locationLocation
      - UniqueId
      - LocationDetails
        locationInfoobject
        addressAddressrequired
        Description
        address type data type, which consists below fields.
        Max depth limit reached
        geolocationGeoCode
        Example
        { "lat": "30.3752° N", "long": "76.7821° E" }
        Max depth limit reached
    - returnSlotTimeSlot
      Description
      Time Slot
      - frominteger<int64>
      - tointeger<int64>
    - serviceTimeinteger
      Description
      Number of seconds needed to complete the task
  - prioritynumber
    Description
    Priority level of the order
  - maxAttemptsnumber
    Description
    Maximum number of attempts needed for servicing an order
    Default
    3
  - teamIdstringrequired
    Description
    Team Id that given order belongs to
  - seqNonumber
    Description
    Sequence in which the orders appear to the FE on the FE App
  - routeTagstring
    Description
    route tag
  - vehicleModelstring
    Description
    vehicle model
  - readyToProcessboolean
    Description
    ready to process
    Default
    true
  - containersContainerDetails[]
    Description
    Container Details
    - containerTypestringrequired
      Description
      Type of the container
      Default
      Shipment
    - scannableIdstringrequired
      Description
      Scannable ID
    - trackingDetailsTrackingDetails
      Description
      Tracking details of the container
      - operatorstringrequired
        Description
        Specify the owner of the tracking ID
      - trackingIdstringrequired
        Description
        Unique id of the container to be used for tracking
      - isPrimaryboolean
        Description
        Flag to identify if primary tracking id or not
    - attributesmap<string, string>
      - dimensionsDimensions
        Description
        dimensions of shipment
        weightnumber
        Description
        weight of shipment
        volumenumber
        Description
        volume of shipment
- callbackCallback
  - urlstring<uri>
    Example
    https://delhivery.requestcatcher.com/
  - metaobject

Responses

202Accepted

RequestProcessedBatchSuccessResponse
- object
  - dataobject
    - batchIdstring

400Validation Error Occurred

BatchValidationErrorResponse
- errorobjectrequired
  Description
  Error Information
  - codestring
    Description
    Error code
  - descriptionstring
    Description
    Error description
  - additionalInfoobject
    Description
    Additional information related to the error
    - errorsobject[]
      Description
      List of errors for the batch
      - clientOrderIdstring
        Description
        Client Order Id
      - errorsErrorEntity[]
        Description
        List of errors for the order
        MESSAGEstring
        Example
        returnSlot from must be greater than current timestamp in milliseconds
        Description
        Human readable error message
        LABELstring
        Example
        returnDetails.returnSlot.from
        Description
        JSON path for the attribute for which this error appears
        CODEstring
        Example
        F-A2137-E4012
        Description
        Error Code for the Error message.
        METAobject
        Description
        Additional metadata about the error

401Error Occurred

UnauthorizedErrorResponse
- errorErrorrequired
  Description
  Error Information
  - codestring
    Description
    Error code
  - descriptionstring
    Description
    Error description
  - additionalInfoobject
    Description
    Additional information related to the error
- requestAuthRequestAttributerequired
  - uristringrequired
    Description
    The API end point where the request was received
  - methodstring
    Description
    HTTP method requested on the API endpoint
  - queryStringstring
    Description
    Query string received by the server

curl

curl --request POST \
     --url https://{domain}/app/logisticsorders/v1/api/orders/batch \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-coreos-request-id: string' \
     --header 'x-coreos-tid: string' \
     --header 'x-coreos-access: string' \
     --header 'x-coreos-userinfo: string' \
     --data '{
     "orders": [
     {
     "dropDetails": {
     "contact": {},
     "location": {}
     },
     "orderSummary": {
     "totalWeight": {
     "value": ""
     },
     "totalVolume": {
     "value": ""
     },
     "totalOrderCost": {
     "cost": ""
     }
     },
     "clientDetails": {
     "clientOrderId": ""
     },
     "mps": {},
     "eWaybillAttributes": {},
     "productType": "",
     "shipmentFlow": "",
     "pickupDetails": {
     "contact": {},
     "location": {}
     },
     "actions": {
     "qcValidation": {
     "isRequired": ""
     },
     "kycVerification": {
     "isRequired": ""
     },
     "otpVerification": {
     "isRequired": ""
     },
     "signatureCollection": {
     "isRequired": ""
     }
     },
     "maxAttempts": 3,
     "teamId": "",
     "readyToProcess": true,
     "containers": [
     {
     "containerType": "Shipment",
     "scannableId": "",
     "trackingDetails": {
     "operator": "",
     "trackingId": ""
     }
     }
     ]
     }
     ]
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-coreos-request-id", "string");
myHeaders.append("x-coreos-tid", "string");
myHeaders.append("x-coreos-access", "string");
myHeaders.append("x-coreos-userinfo", "string");

var raw = JSON.stringify({
   "orders": [
      {
         "dropDetails": {
            "contact": {},
            "location": {}
         },
         "orderSummary": {
            "totalWeight": {
               "value": ""
            },
            "totalVolume": {
               "value": ""
            },
            "totalOrderCost": {
               "cost": ""
            }
         },
         "clientDetails": {
            "clientOrderId": ""
         },
         "mps": {},
         "eWaybillAttributes": {},
         "productType": "",
         "shipmentFlow": "",
         "pickupDetails": {
            "contact": {},
            "location": {}
         },
         "actions": {
            "qcValidation": {
               "isRequired": ""
            },
            "kycVerification": {
               "isRequired": ""
            },
            "otpVerification": {
               "isRequired": ""
            },
            "signatureCollection": {
               "isRequired": ""
            }
         },
         "maxAttempts": 3,
         "teamId": "",
         "readyToProcess": true,
         "containers": [
            {
               "containerType": "Shipment",
               "scannableId": "",
               "trackingDetails": {
                  "operator": "",
                  "trackingId": ""
               }
            }
         ]
      }
   ]
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://{domain}/app/logisticsorders/v1/api/orders/batch", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://{domain}/app/logisticsorders/v1/api/orders/batch")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-coreos-request-id"] = "string"
request["x-coreos-tid"] = "string"
request["x-coreos-access"] = "string"
request["x-coreos-userinfo"] = "string"
request.body = JSON.dump({
   "orders": [
      {
         "dropDetails": {
            "contact": {},
            "location": {}
         },
         "orderSummary": {
            "totalWeight": {
               "value": ""
            },
            "totalVolume": {
               "value": ""
            },
            "totalOrderCost": {
               "cost": ""
            }
         },
         "clientDetails": {
            "clientOrderId": ""
         },
         "mps": {},
         "eWaybillAttributes": {},
         "productType": "",
         "shipmentFlow": "",
         "pickupDetails": {
            "contact": {},
            "location": {}
         },
         "actions": {
            "qcValidation": {
               "isRequired": ""
            },
            "kycVerification": {
               "isRequired": ""
            },
            "otpVerification": {
               "isRequired": ""
            },
            "signatureCollection": {
               "isRequired": ""
            }
         },
         "maxAttempts": 3,
         "teamId": "",
         "readyToProcess": true,
         "containers": [
            {
               "containerType": "Shipment",
               "scannableId": "",
               "trackingDetails": {
                  "operator": "",
                  "trackingId": ""
               }
            }
         ]
      }
   ]
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://{domain}/app/logisticsorders/v1/api/orders/batch"

payload = json.dumps({
   "orders": [
      {
         "dropDetails": {
            "contact": {},
            "location": {}
         },
         "orderSummary": {
            "totalWeight": {
               "value": ""
            },
            "totalVolume": {
               "value": ""
            },
            "totalOrderCost": {
               "cost": ""
            }
         },
         "clientDetails": {
            "clientOrderId": ""
         },
         "mps": {},
         "eWaybillAttributes": {},
         "productType": "",
         "shipmentFlow": "",
         "pickupDetails": {
            "contact": {},
            "location": {}
         },
         "actions": {
            "qcValidation": {
               "isRequired": ""
            },
            "kycVerification": {
               "isRequired": ""
            },
            "otpVerification": {
               "isRequired": ""
            },
            "signatureCollection": {
               "isRequired": ""
            }
         },
         "maxAttempts": 3,
         "teamId": "",
         "readyToProcess": True,
         "containers": [
            {
               "containerType": "Shipment",
               "scannableId": "",
               "trackingDetails": {
                  "operator": "",
                  "trackingId": ""
               }
            }
         ]
      }
   ]
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-coreos-request-id': 'string',
   'x-coreos-tid': 'string',
   'x-coreos-access': 'string',
   'x-coreos-userinfo': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

202

// Accepted
{
  "data": {
    "batchId": ""
  }
}

400

// Validation Error Occurred
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {
      "errors": [
        {
          "clientOrderId": "",
          "errors": [
            {
              "MESSAGE": "returnSlot from must be greater than current timestamp in milliseconds",
              "LABEL": "returnDetails.returnSlot.from",
              "CODE": "F-A2137-E4012",
              "META": {}
            }
          ]
        }
      ]
    }
  }
}

401

// Error Occurred
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": ""
  }
}

Create orders in batch