Update Order core & custom attributes

1 min

PUT

https://{domain}/app/logisticsorders/v1/api/orders/edit/{orderId}

Path Parameters

orderIdstringrequired
Description
Code of an entity.

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

Body Parameters

bodyUpdateOrderEntityRequestDetailsrequired
- dropDetailsDropDetailsUpdateRequest
  Description
  Drop details
  - contactContact
    - UniqueId
    - ContactDetails
      - namestringrequired
        Description
        Contact name
      - phonePhone
        Description
        phone type data type, which consists below fields.
        countryCodestringrequired
        Description
        country code of the mobile it belongs.
        numberstringrequired
        Description
        user phone number
        isMobilebooleanrequired
        Description
        whether the phone is of type mobile or telephone.
        areaCodestring
        Description
        in case of type telephone, areaCode of the telephone it belongs.
        muteNotifboolean
        Description
        Should mute notification for this number
        Default
        false
      - emailMultipleEmail
        Email
        Max depth limit reached
        AdditionalEmail
        Max depth limit reached
      - additionalPhonePhone[]
        Description
        phone type data type, which consists below fields.
        countryCodestringrequired
        Description
        country code of the mobile it belongs.
        numberstringrequired
        Description
        user phone number
        isMobilebooleanrequired
        Description
        whether the phone is of type mobile or telephone.
        areaCodestring
        Description
        in case of type telephone, areaCode of the telephone it belongs.
        muteNotifboolean
        Description
        Should mute notification for this number
        Default
        false
      - additionalEmailAdditionalEmail[]
        idstring
        Description
        Email string
        muteNotifboolean
        Description
        Should mute notification for this number
        Default
        false
  - locationLocation
    - UniqueId
    - LocationDetails
      - locationInfoobject
      - addressAddressrequired
        Description
        address type data type, which consists below fields.
        buildingNumberstring
        Description
        house number can be alphanumeric
        addressLine1stringrequired
        Description
        address line1 of the address
        addressLine2string
        Description
        address line2 of the address
        addressLine3string
        Description
        address line3 of the address
        apartmentNumberstring
        Description
        apartment number of the address
        floorstring
        Description
        floor of the address
        countystring
        Description
        district or county of the address
        citystringrequired
        Description
        city of the address
        statestringrequired
        Description
        state of the address
        zipCodestringrequired
        Description
        zip code can be alphanumeric
        countryCountryrequired
        Description
        country which consists code and name
        Max depth limit reached
      - geolocationGeoCode
        Example
        { "lat": "30.3752° N", "long": "76.7821° E" }
        longstringrequired
        Description
        range of longitude is -180 to 180 and can be upto 6 decimal places
        latstringrequired
        Description
        range of latitude is -90 to 90 and can be upto 6 decimal places
- 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
- mpsMpsUpdateRequest
  Description
  multi part shipment
  - 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
- productTypeProductType
  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
- shipmentFlowShipmentFlow
  Description
  Nature of flow of shipment
- pickupDetailsPickupDetailsUpdateRequest
  Description
  Pickup details
  - contactContact
    - UniqueId
    - ContactDetails
      - namestringrequired
        Description
        Contact name
      - phonePhone
        Description
        phone type data type, which consists below fields.
        countryCodestringrequired
        Description
        country code of the mobile it belongs.
        numberstringrequired
        Description
        user phone number
        isMobilebooleanrequired
        Description
        whether the phone is of type mobile or telephone.
        areaCodestring
        Description
        in case of type telephone, areaCode of the telephone it belongs.
        muteNotifboolean
        Description
        Should mute notification for this number
        Default
        false
      - emailMultipleEmail
        Email
        Max depth limit reached
        AdditionalEmail
        Max depth limit reached
      - additionalPhonePhone[]
        Description
        phone type data type, which consists below fields.
        countryCodestringrequired
        Description
        country code of the mobile it belongs.
        numberstringrequired
        Description
        user phone number
        isMobilebooleanrequired
        Description
        whether the phone is of type mobile or telephone.
        areaCodestring
        Description
        in case of type telephone, areaCode of the telephone it belongs.
        muteNotifboolean
        Description
        Should mute notification for this number
        Default
        false
      - additionalEmailAdditionalEmail[]
        idstring
        Description
        Email string
        muteNotifboolean
        Description
        Should mute notification for this number
        Default
        false
  - locationLocation
    - UniqueId
    - LocationDetails
      - locationInfoobject
      - addressAddressrequired
        Description
        address type data type, which consists below fields.
        buildingNumberstring
        Description
        house number can be alphanumeric
        addressLine1stringrequired
        Description
        address line1 of the address
        addressLine2string
        Description
        address line2 of the address
        addressLine3string
        Description
        address line3 of the address
        apartmentNumberstring
        Description
        apartment number of the address
        floorstring
        Description
        floor of the address
        countystring
        Description
        district or county of the address
        citystringrequired
        Description
        city of the address
        statestringrequired
        Description
        state of the address
        zipCodestringrequired
        Description
        zip code can be alphanumeric
        countryCountryrequired
        Description
        country which consists code and name
        Max depth limit reached
      - geolocationGeoCode
        Example
        { "lat": "30.3752° N", "long": "76.7821° E" }
        longstringrequired
        Description
        range of longitude is -180 to 180 and can be upto 6 decimal places
        latstringrequired
        Description
        range of latitude is -90 to 90 and can be upto 6 decimal places
  - 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.
- eWaybillAttributeseWaybillAttributes
  - eWaybillAttributesRequest
    - is_valid_ewaybillboolean
      Description
      Flag to identity if ewaybill is valid
    - ewaybillsstring[]
      Description
      list of ewaybills
- 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.
        countryCodestringrequired
        Description
        country code of the mobile it belongs.
        numberstringrequired
        Description
        user phone number
        isMobilebooleanrequired
        Description
        whether the phone is of type mobile or telephone.
        areaCodestring
        Description
        in case of type telephone, areaCode of the telephone it belongs.
        muteNotifboolean
        Description
        Should mute notification for this number
        Default
        false
      - emailMultipleEmail
        Email
        Max depth limit reached
        AdditionalEmail
        Max depth limit reached
      - additionalPhonePhone[]
        Description
        phone type data type, which consists below fields.
        countryCodestringrequired
        Description
        country code of the mobile it belongs.
        numberstringrequired
        Description
        user phone number
        isMobilebooleanrequired
        Description
        whether the phone is of type mobile or telephone.
        areaCodestring
        Description
        in case of type telephone, areaCode of the telephone it belongs.
        muteNotifboolean
        Description
        Should mute notification for this number
        Default
        false
      - additionalEmailAdditionalEmail[]
        idstring
        Description
        Email string
        muteNotifboolean
        Description
        Should mute notification for this number
        Default
        false
  - locationLocation
    - UniqueId
    - LocationDetails
      - locationInfoobject
      - addressAddressrequired
        Description
        address type data type, which consists below fields.
        buildingNumberstring
        Description
        house number can be alphanumeric
        addressLine1stringrequired
        Description
        address line1 of the address
        addressLine2string
        Description
        address line2 of the address
        addressLine3string
        Description
        address line3 of the address
        apartmentNumberstring
        Description
        apartment number of the address
        floorstring
        Description
        floor of the address
        countystring
        Description
        district or county of the address
        citystringrequired
        Description
        city of the address
        statestringrequired
        Description
        state of the address
        zipCodestringrequired
        Description
        zip code can be alphanumeric
        countryCountryrequired
        Description
        country which consists code and name
        Max depth limit reached
      - geolocationGeoCode
        Example
        { "lat": "30.3752° N", "long": "76.7821° E" }
        longstringrequired
        Description
        range of longitude is -180 to 180 and can be upto 6 decimal places
        latstringrequired
        Description
        range of latitude is -90 to 90 and can be upto 6 decimal places
  - returnSlotTimeSlot
    Description
    Time Slot
    - frominteger<int64>
    - tointeger<int64>
  - serviceTimeinteger
    Description
    Number of seconds needed to complete the task
- containersContainerEditDetails[]
  Description
  Container Details
  - containerTypestringrequired
    Description
    Type of the container
    Default
    Shipment
  - scannableIdstringrequired
    Description
    Scannable ID
  - attributesmap<string, string>
    - dimensionsDimensions
      Description
      dimensions of shipment
      - weightnumber
        Description
        weight of shipment
      - volumenumber
        Description
        volume of shipment
- prioritynumber
  Description
  Priority level of the order
- maxAttemptsnumber
  Description
  Maximum number of attempts needed for servicing an order
- seqNonumber
  Description
  Sequence in which the orders appear to the FE on the FE App
- teamIdstring
  Description
  Team Id that given order belongs to
- readyToProcessboolean
  Description
  ready to process
- routeTagstring
  Description
  route tag
- callbackCallbackDetails
  - urlstring
    Example
    https://www.testsite.com
  - metamap<string, string>
- vehicleModelstring
  Description
  vehicle model

Responses

200Accepted

RequestProcessedSuccessResponse
- objectErrorResponse
  - errorErrorrequired
    Description
    Error Information
    - codestring
      Description
      Error code
    - descriptionstring
      Description
      Error description
    - additionalInfoobject
      Description
      Additional information related to the error
  - requestRequestrequired
    - uristringrequired
      Description
      The API end point where the request was received
    - methodstring<POST | GET | PUT>
      Description
      HTTP method requested on the API endpoint
    - queryStringstring
      Description
      Query string received by the server
    - bodyobject
      Description
      Request body data received by the server
- object
  - dataobject
    - idstringrequired
      Description
      success message

400Error Occurred

GetErrorResponse
- objectErrorResponse
  - errorErrorrequired
    Description
    Error Information
    - codestring
      Description
      Error code
    - descriptionstring
      Description
      Error description
    - additionalInfoobject
      Description
      Additional information related to the error
  - requestRequestrequired
    - uristringrequired
      Description
      The API end point where the request was received
    - methodstring<POST | GET | PUT>
      Description
      HTTP method requested on the API endpoint
    - queryStringstring
      Description
      Query string received by the server
    - bodyobject
      Description
      Request body data received by the server
- object
  - dataobject
    - idUniqueId
      Description
      Unique ID. Combination of entity name and UUID.

401Error Occurred

GetErrorResponse
- objectErrorResponse
  - errorErrorrequired
    Description
    Error Information
    - codestring
      Description
      Error code
    - descriptionstring
      Description
      Error description
    - additionalInfoobject
      Description
      Additional information related to the error
  - requestRequestrequired
    - uristringrequired
      Description
      The API end point where the request was received
    - methodstring<POST | GET | PUT>
      Description
      HTTP method requested on the API endpoint
    - queryStringstring
      Description
      Query string received by the server
    - bodyobject
      Description
      Request body data received by the server
- object
  - dataobject
    - idUniqueId
      Description
      Unique ID. Combination of entity name and UUID.

curl

curl --request PUT \
     --url https://{domain}/app/logisticsorders/v1/api/orders/edit/{orderId} \
     --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 '{
     "orderSummary": {
     "totalWeight": {
     "value": ""
     },
     "totalVolume": {
     "value": ""
     },
     "totalOrderCost": {
     "cost": ""
     }
     },
     "eWaybillAttributes": {},
     "actions": {
     "qcValidation": {
     "isRequired": ""
     },
     "kycVerification": {
     "isRequired": ""
     },
     "otpVerification": {
     "isRequired": ""
     },
     "signatureCollection": {
     "isRequired": ""
     }
     },
     "containers": [
     {
     "containerType": "Shipment",
     "scannableId": ""
     }
     ]
     }'

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({
   "orderSummary": {
      "totalWeight": {
         "value": ""
      },
      "totalVolume": {
         "value": ""
      },
      "totalOrderCost": {
         "cost": ""
      }
   },
   "eWaybillAttributes": {},
   "actions": {
      "qcValidation": {
         "isRequired": ""
      },
      "kycVerification": {
         "isRequired": ""
      },
      "otpVerification": {
         "isRequired": ""
      },
      "signatureCollection": {
         "isRequired": ""
      }
   },
   "containers": [
      {
         "containerType": "Shipment",
         "scannableId": ""
      }
   ]
});

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

fetch("https://{domain}/app/logisticsorders/v1/api/orders/edit/{orderId}", 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/edit/{orderId}")

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

request = Net::HTTP::Put.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({
   "orderSummary": {
      "totalWeight": {
         "value": ""
      },
      "totalVolume": {
         "value": ""
      },
      "totalOrderCost": {
         "cost": ""
      }
   },
   "eWaybillAttributes": {},
   "actions": {
      "qcValidation": {
         "isRequired": ""
      },
      "kycVerification": {
         "isRequired": ""
      },
      "otpVerification": {
         "isRequired": ""
      },
      "signatureCollection": {
         "isRequired": ""
      }
   },
   "containers": [
      {
         "containerType": "Shipment",
         "scannableId": ""
      }
   ]
})

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

python

import requests
import json

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

payload = json.dumps({
   "orderSummary": {
      "totalWeight": {
         "value": ""
      },
      "totalVolume": {
         "value": ""
      },
      "totalOrderCost": {
         "cost": ""
      }
   },
   "eWaybillAttributes": {},
   "actions": {
      "qcValidation": {
         "isRequired": ""
      },
      "kycVerification": {
         "isRequired": ""
      },
      "otpVerification": {
         "isRequired": ""
      },
      "signatureCollection": {
         "isRequired": ""
      }
   },
   "containers": [
      {
         "containerType": "Shipment",
         "scannableId": ""
      }
   ]
})
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("PUT", url, headers=headers, data=payload)

print(response.text)

200

// Accepted
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}

400

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

401

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

Update Order core & custom attributes