---
title: Get Order Details
slug: mihai-tests/get-order-details
createdAt: 2025-05-09T09:41:47.053Z
---
{
"id": "jyih4aRFMctcIqjGws7h1",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "https://{domain}/app/logisticsorders/v1/api/orders/{orderId}",
"servers": [
{
"url": "https://{domain}/app/logisticsorders/v1/api/orders/{orderId}"
}
],
"name": "Get Order Details",
"description": "Get Order Details",
"contentType": "application/json",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "orderId",
"type": "string",
"description": "Code of an entity."
}
],
"headerParameters": [
{
"kind": "required",
"name": "X-COREOS-REQUEST-ID",
"type": "string",
"description": "Unique requestId"
},
{
"kind": "required",
"name": "X-COREOS-TID",
"type": "string",
"description": "Tenant id"
},
{
"kind": "required",
"name": "X-COREOS-ACCESS",
"type": "string",
"description": "core-os access token
"
},
{
"kind": "required",
"name": "X-COREOS-USERINFO",
"type": "string",
"description": "core-os user info token
"
}
],
"queryParameters": [],
"bodyDataParameters": [],
"formDataParameters": [],
"oAuthParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "Entity event mapped response",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "OrderGetResponse",
"schema": [
{
"name": "error",
"kind": "required",
"type": "object",
"description": "Error Information",
"modelRef": "#/components/schemas/Error",
"customType": "Error",
"schema": [
{
"name": "code",
"kind": "optional",
"type": "string",
"description": "Error code",
"example": ""
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": "Error description",
"example": ""
},
{
"name": "additionalInfo",
"kind": "optional",
"type": "object",
"description": "Additional information related to the error",
"example": "",
"schema": []
}
]
},
{
"name": "request",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Request",
"customType": "Request",
"schema": [
{
"name": "uri",
"kind": "required",
"type": "string",
"description": "The API end point where the request was received",
"example": ""
},
{
"name": "method",
"kind": "optional",
"type": "string",
"description": "HTTP method requested on the API endpoint",
"example": ""
},
{
"name": "queryString",
"kind": "optional",
"type": "string",
"description": "Query string received by the server",
"example": ""
},
{
"name": "body",
"kind": "optional",
"type": "object",
"description": "Request body data received by the server",
"example": "",
"schema": []
}
]
},
{
"name": "data",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/OrderResponse",
"customType": "OrderResponse",
"schema": [],
"complexType": "allOf",
"complexItems": [
{
"name": "OrderEntity",
"description": "",
"modelRef": "#/components/schemas/OrderEntity",
"schema": [
{
"name": "dropDetails",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/DropDetails",
"customType": "DropDetails",
"schema": [],
"complexType": "allOf",
"complexItems": [
{
"name": "DropDetailsUpdateRequest",
"description": "",
"modelRef": "#/components/schemas/DropDetailsUpdateRequest",
"schema": [
{
"name": "contact",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Contact",
"customType": "Contact",
"schema": [],
"complexType": "anyOf",
"complexItems": [
{
"name": "UniqueId",
"description": "",
"modelRef": "#/components/schemas/UniqueId",
"schema": []
},
{
"name": "ContactDetails",
"description": "",
"modelRef": "#/components/schemas/ContactDetails",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": "Contact name",
"example": ""
},
{
"name": "phone",
"kind": "optional",
"type": "object",
"description": "phone type data type, which consists below fields.",
"modelRef": "#/components/schemas/Phone",
"customType": "Phone",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "email",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/MultipleEmail",
"customType": "MultipleEmail",
"schema": [],
"complexType": "oneOf",
"complexItems": [
{
"name": "Email",
"description": "",
"modelRef": "#/components/schemas/Email",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "AdditionalEmail",
"description": "",
"modelRef": "#/components/schemas/AdditionalEmail",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
},
{
"name": "additionalPhone",
"kind": "optional",
"type": "array",
"description": "phone type data type, which consists below fields.",
"modelRef": "#/components/schemas/Phone",
"customType": "Phone[]",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "additionalEmail",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/AdditionalEmail",
"customType": "AdditionalEmail[]",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
}
]
},
{
"name": "location",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Location",
"customType": "Location",
"schema": [],
"complexType": "anyOf",
"complexItems": [
{
"name": "UniqueId",
"description": "",
"modelRef": "#/components/schemas/UniqueId",
"schema": []
},
{
"name": "LocationDetails",
"description": "",
"modelRef": "#/components/schemas/LocationDetails",
"schema": [
{
"name": "locationInfo",
"kind": "optional",
"type": "object",
"example": "",
"schema": []
},
{
"name": "address",
"kind": "required",
"type": "object",
"description": "address type data type, which consists below fields.",
"modelRef": "#/components/schemas/Address",
"customType": "Address",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "geolocation",
"kind": "optional",
"type": "object",
"description": "",
"example": "{\"lat\":\"30.3752° N\",\"long\":\"76.7821° E\"}",
"modelRef": "#/components/schemas/GeoCode",
"customType": "GeoCode",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
}
]
}
]
}
]
},
{
"name": "orderSummary",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/OrderSummary",
"customType": "OrderSummary",
"schema": [
{
"name": "invoiceNumber",
"kind": "optional",
"type": "string",
"description": "Invoice Number associated with the order",
"example": ""
},
{
"name": "orderDescription",
"kind": "optional",
"type": "string",
"description": "Description of the order",
"example": ""
},
{
"name": "totalWeight",
"kind": "optional",
"type": "object",
"description": "Total weight of the order",
"modelRef": "#/components/schemas/TotalOrderWeight",
"customType": "TotalOrderWeight",
"schema": [
{
"name": "value",
"kind": "required",
"type": "number",
"example": ""
}
]
},
{
"name": "totalVolume",
"kind": "optional",
"type": "object",
"description": "Total volume of the order",
"modelRef": "#/components/schemas/TotalOrderVolume",
"customType": "TotalOrderVolume",
"schema": [
{
"name": "value",
"kind": "required",
"type": "number",
"example": ""
}
]
},
{
"name": "totalItems",
"kind": "optional",
"type": "number",
"description": "Total number of containers in the order",
"example": ""
},
{
"name": "totalOrderCost",
"kind": "optional",
"type": "object",
"description": "Total cost of the order",
"modelRef": "#/components/schemas/TotalOrderCost",
"customType": "TotalOrderCost",
"schema": [
{
"name": "cost",
"kind": "required",
"type": "number",
"description": "value of cost incurred",
"example": ""
},
{
"name": "currencyCode",
"kind": "optional",
"type": "string",
"description": "currency code",
"example": ""
},
{
"name": "minorUnit",
"kind": "optional",
"type": "number",
"description": "unit of cost",
"example": ""
}
]
},
{
"name": "totalInvoice",
"kind": "optional",
"type": "object",
"description": "invoice of order",
"modelRef": "#/components/schemas/Invoice",
"customType": "Invoice",
"schema": [
{
"name": "value",
"kind": "optional",
"type": "integer",
"description": "total invoice value of the order",
"example": 0
},
{
"name": "currencyCode",
"kind": "optional",
"type": "string",
"description": "currency code",
"example": ""
},
{
"name": "minorUnit",
"kind": "optional",
"type": "integer",
"description": "unit of invoice",
"example": 0
}
]
}
]
},
{
"name": "clientDetails",
"kind": "required",
"type": "object",
"description": "Client details",
"modelRef": "#/components/schemas/ClientDetails",
"customType": "ClientDetails",
"schema": [
{
"name": "clientName",
"kind": "optional",
"type": "string",
"example": ""
},
{
"name": "clientId",
"kind": "optional",
"type": "string",
"description": "Unique ID. Combination of entity name and UUID.",
"modelRef": "#/components/schemas/UniqueId",
"customType": "UniqueId",
"schema": []
},
{
"name": "clientOrderId",
"kind": "required",
"type": "string",
"description": "Unique ID. Combination of entity name and UUID.",
"modelRef": "#/components/schemas/UniqueId",
"customType": "UniqueId",
"schema": []
}
]
},
{
"name": "mps",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Mps",
"customType": "Mps",
"schema": [],
"complexType": "allOf",
"complexItems": [
{
"name": "MpsUpdateRequest",
"description": "",
"modelRef": "#/components/schemas/MpsUpdateRequest",
"schema": [
{
"name": "groupId",
"kind": "optional",
"type": "string",
"description": "Stores the Master object of an MPS lot",
"example": ""
},
{
"name": "groupSize",
"kind": "optional",
"type": "number",
"description": "Stores the count of objects in an MPS lot",
"example": ""
},
{
"name": "isEnabled",
"kind": "optional",
"type": "boolean",
"description": "Flag to identity if order is a multi-piece shipment",
"example": ""
},
{
"name": "isPartial",
"kind": "optional",
"type": "boolean",
"description": "Indicates if partial delivery is enabled for an MPS lot",
"example": ""
}
]
}
]
},
{
"name": "eWaybillAttributes",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/eWaybillAttributes",
"customType": "eWaybillAttributes",
"schema": [],
"complexType": "allOf",
"complexItems": [
{
"name": "eWaybillAttributesRequest",
"description": "",
"modelRef": "#/components/schemas/eWaybillAttributesRequest",
"schema": [
{
"name": "is_valid_ewaybill",
"kind": "optional",
"type": "boolean",
"description": "Flag to identity if ewaybill is valid",
"example": ""
},
{
"name": "ewaybills",
"kind": "optional",
"type": "array",
"description": "list of ewaybills",
"example": "",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
}
]
}
]
},
{
"name": "productType",
"kind": "required",
"type": "string",
"description": "Type of the product in the order",
"modelRef": "#/components/schemas/ProductType",
"customType": "ProductType",
"schema": []
},
{
"name": "planningMode",
"kind": "optional",
"type": "string",
"description": "Fulfillment Type",
"modelRef": "#/components/schemas/PlanningMode",
"customType": "PlanningMode",
"schema": []
},
{
"name": "modeOfTransport",
"kind": "optional",
"type": "string",
"description": "Mode via which shipment will be moved",
"modelRef": "#/components/schemas/ModeOfTransport",
"customType": "ModeOfTransport",
"schema": []
},
{
"name": "speedOfTransport",
"kind": "optional",
"type": "string",
"description": "Speed of transfer of shipment",
"modelRef": "#/components/schemas/SpeedOfTransport",
"customType": "SpeedOfTransport",
"schema": []
},
{
"name": "shipmentFlow",
"kind": "required",
"type": "string",
"description": "Nature of flow of shipment",
"modelRef": "#/components/schemas/ShipmentFlow",
"customType": "ShipmentFlow",
"schema": []
},
{
"name": "pickupDetails",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/PickupDetails",
"customType": "PickupDetails",
"schema": [],
"complexType": "allOf",
"complexItems": [
{
"name": "PickupDetailsUpdateRequest",
"description": "",
"modelRef": "#/components/schemas/PickupDetailsUpdateRequest",
"schema": [
{
"name": "contact",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Contact",
"customType": "Contact",
"schema": [],
"complexType": "anyOf",
"complexItems": [
{
"name": "UniqueId",
"description": "",
"modelRef": "#/components/schemas/UniqueId",
"schema": []
},
{
"name": "ContactDetails",
"description": "",
"modelRef": "#/components/schemas/ContactDetails",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": "Contact name",
"example": ""
},
{
"name": "phone",
"kind": "optional",
"type": "object",
"description": "phone type data type, which consists below fields.",
"modelRef": "#/components/schemas/Phone",
"customType": "Phone",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "email",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/MultipleEmail",
"customType": "MultipleEmail",
"schema": [],
"complexType": "oneOf",
"complexItems": [
{
"name": "Email",
"description": "",
"modelRef": "#/components/schemas/Email",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "AdditionalEmail",
"description": "",
"modelRef": "#/components/schemas/AdditionalEmail",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
},
{
"name": "additionalPhone",
"kind": "optional",
"type": "array",
"description": "phone type data type, which consists below fields.",
"modelRef": "#/components/schemas/Phone",
"customType": "Phone[]",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "additionalEmail",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/AdditionalEmail",
"customType": "AdditionalEmail[]",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
}
]
},
{
"name": "location",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Location",
"customType": "Location",
"schema": [],
"complexType": "anyOf",
"complexItems": [
{
"name": "UniqueId",
"description": "",
"modelRef": "#/components/schemas/UniqueId",
"schema": []
},
{
"name": "LocationDetails",
"description": "",
"modelRef": "#/components/schemas/LocationDetails",
"schema": [
{
"name": "locationInfo",
"kind": "optional",
"type": "object",
"example": "",
"schema": []
},
{
"name": "address",
"kind": "required",
"type": "object",
"description": "address type data type, which consists below fields.",
"modelRef": "#/components/schemas/Address",
"customType": "Address",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "geolocation",
"kind": "optional",
"type": "object",
"description": "",
"example": "{\"lat\":\"30.3752° N\",\"long\":\"76.7821° E\"}",
"modelRef": "#/components/schemas/GeoCode",
"customType": "GeoCode",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
}
]
},
{
"name": "pickupSlot",
"kind": "optional",
"type": "object",
"description": "Time Slot",
"modelRef": "#/components/schemas/TimeSlot",
"customType": "TimeSlot",
"schema": [
{
"name": "from",
"kind": "optional",
"type": "integer",
"example": 0
},
{
"name": "to",
"kind": "optional",
"type": "integer",
"example": 0
}
]
},
{
"name": "serviceTime",
"kind": "optional",
"type": "integer",
"description": "Number of seconds needed to complete the task",
"example": 0
},
{
"name": "instruction",
"kind": "optional",
"type": "string",
"description": "instruction for the FE at the time of performing a pickup or drop objective.",
"example": ""
}
]
}
]
},
{
"name": "paymentInformation",
"kind": "optional",
"type": "object",
"description": "Payment Information",
"modelRef": "#/components/schemas/PaymentInformation",
"customType": "PaymentInformation",
"schema": [
{
"name": "paymentType",
"kind": "optional",
"type": "string",
"description": "Type of payment done for the order",
"modelRef": "#/components/schemas/PaymentType",
"customType": "PaymentType",
"schema": []
},
{
"name": "paymentOption",
"kind": "optional",
"type": "string",
"description": "Mode of payment",
"modelRef": "#/components/schemas/PaymentOption",
"customType": "PaymentOption",
"schema": []
}
]
},
{
"name": "deliveryDetails",
"kind": "optional",
"type": "object",
"description": "Delivery details",
"modelRef": "#/components/schemas/DeliveryDetails",
"customType": "DeliveryDetails",
"schema": [
{
"name": "promisedDeliveryDate",
"kind": "optional",
"type": "string",
"example": ""
},
{
"name": "deliverySlot",
"kind": "optional",
"type": "object",
"description": "Time Slot",
"modelRef": "#/components/schemas/TimeSlot",
"customType": "TimeSlot",
"schema": [
{
"name": "from",
"kind": "optional",
"type": "integer",
"example": 0
},
{
"name": "to",
"kind": "optional",
"type": "integer",
"example": 0
}
]
},
{
"name": "serviceTime",
"kind": "optional",
"type": "integer",
"description": "Number of seconds needed to complete the task",
"example": 0
},
{
"name": "instruction",
"kind": "optional",
"type": "string",
"description": "instruction for the FE at the time of performing a pickup or drop objective.",
"example": ""
}
]
},
{
"name": "actions",
"kind": "optional",
"type": "object",
"description": "Doorstep actions information",
"modelRef": "#/components/schemas/DoorstepActions",
"customType": "DoorstepActions",
"schema": [
{
"name": "qcValidation",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/ActionRequired",
"customType": "ActionRequired",
"schema": [
{
"name": "isRequired",
"kind": "required",
"type": "boolean",
"example": ""
},
{
"name": "requiredAt",
"kind": "optional",
"type": "string",
"example": ""
}
]
},
{
"name": "qcValidationChecklist",
"kind": "optional",
"type": "object",
"description": "Checklist for QCValidation",
"example": "",
"schema": []
},
{
"name": "kycVerification",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/ActionRequired",
"customType": "ActionRequired",
"schema": [
{
"name": "isRequired",
"kind": "required",
"type": "boolean",
"example": ""
},
{
"name": "requiredAt",
"kind": "optional",
"type": "string",
"example": ""
}
]
},
{
"name": "otpVerification",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/ActionRequired",
"customType": "ActionRequired",
"schema": [
{
"name": "isRequired",
"kind": "required",
"type": "boolean",
"example": ""
},
{
"name": "requiredAt",
"kind": "optional",
"type": "string",
"example": ""
}
]
},
{
"name": "signatureCollection",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/ActionRequired",
"customType": "ActionRequired",
"schema": [
{
"name": "isRequired",
"kind": "required",
"type": "boolean",
"example": ""
},
{
"name": "requiredAt",
"kind": "optional",
"type": "string",
"example": ""
}
]
}
]
},
{
"name": "notificationDetails",
"kind": "optional",
"type": "object",
"description": "Notification Information",
"modelRef": "#/components/schemas/NotificationDetails",
"customType": "NotificationDetails",
"schema": [
{
"name": "notificationType",
"kind": "optional",
"type": "string",
"description": "Key to identify if notification is needed at pickup or drop or both",
"modelRef": "#/components/schemas/NotificationType",
"customType": "NotificationType",
"schema": []
},
{
"name": "notificationMode",
"kind": "optional",
"type": "string",
"description": "Notifcaition mode to identify what mediums should the notification go through",
"modelRef": "#/components/schemas/NotificationMode",
"customType": "NotificationMode",
"schema": []
}
]
},
{
"name": "returnDetails",
"kind": "optional",
"type": "object",
"description": "Return details",
"modelRef": "#/components/schemas/ReturnDetails",
"customType": "ReturnDetails",
"schema": [
{
"name": "contact",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Contact",
"customType": "Contact",
"schema": [],
"complexType": "anyOf",
"complexItems": [
{
"name": "UniqueId",
"description": "",
"modelRef": "#/components/schemas/UniqueId",
"schema": []
},
{
"name": "ContactDetails",
"description": "",
"modelRef": "#/components/schemas/ContactDetails",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": "Contact name",
"example": ""
},
{
"name": "phone",
"kind": "optional",
"type": "object",
"description": "phone type data type, which consists below fields.",
"modelRef": "#/components/schemas/Phone",
"customType": "Phone",
"schema": [
{
"name": "countryCode",
"kind": "required",
"type": "string",
"description": "country code of the mobile it belongs.",
"example": ""
},
{
"name": "number",
"kind": "required",
"type": "string",
"description": "user phone number",
"example": ""
},
{
"name": "isMobile",
"kind": "required",
"type": "boolean",
"description": "whether the phone is of type mobile or telephone.",
"example": ""
},
{
"name": "areaCode",
"kind": "optional",
"type": "string",
"description": "in case of type telephone, areaCode of the telephone it belongs.",
"example": ""
},
{
"name": "muteNotif",
"kind": "optional",
"type": "boolean",
"description": "Should mute notification for this number",
"example": "",
"default": false
}
]
},
{
"name": "email",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/MultipleEmail",
"customType": "MultipleEmail",
"schema": [],
"complexType": "oneOf",
"complexItems": [
{
"name": "Email",
"description": "",
"modelRef": "#/components/schemas/Email",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "AdditionalEmail",
"description": "",
"modelRef": "#/components/schemas/AdditionalEmail",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
},
{
"name": "additionalPhone",
"kind": "optional",
"type": "array",
"description": "phone type data type, which consists below fields.",
"modelRef": "#/components/schemas/Phone",
"customType": "Phone[]",
"schema": [
{
"name": "countryCode",
"kind": "required",
"type": "string",
"description": "country code of the mobile it belongs.",
"example": ""
},
{
"name": "number",
"kind": "required",
"type": "string",
"description": "user phone number",
"example": ""
},
{
"name": "isMobile",
"kind": "required",
"type": "boolean",
"description": "whether the phone is of type mobile or telephone.",
"example": ""
},
{
"name": "areaCode",
"kind": "optional",
"type": "string",
"description": "in case of type telephone, areaCode of the telephone it belongs.",
"example": ""
},
{
"name": "muteNotif",
"kind": "optional",
"type": "boolean",
"description": "Should mute notification for this number",
"example": "",
"default": false
}
]
},
{
"name": "additionalEmail",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/AdditionalEmail",
"customType": "AdditionalEmail[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "Email string",
"example": ""
},
{
"name": "muteNotif",
"kind": "optional",
"type": "boolean",
"description": "Should mute notification for this number",
"example": "",
"default": false
}
]
}
]
}
]
},
{
"name": "location",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Location",
"customType": "Location",
"schema": [],
"complexType": "anyOf",
"complexItems": [
{
"name": "UniqueId",
"description": "",
"modelRef": "#/components/schemas/UniqueId",
"schema": []
},
{
"name": "LocationDetails",
"description": "",
"modelRef": "#/components/schemas/LocationDetails",
"schema": [
{
"name": "locationInfo",
"kind": "optional",
"type": "object",
"example": "",
"schema": []
},
{
"name": "address",
"kind": "required",
"type": "object",
"description": "address type data type, which consists below fields.",
"modelRef": "#/components/schemas/Address",
"customType": "Address",
"schema": [
{
"name": "buildingNumber",
"kind": "optional",
"type": "string",
"description": "house number can be alphanumeric",
"example": ""
},
{
"name": "addressLine1",
"kind": "required",
"type": "string",
"description": "address line1 of the address",
"example": ""
},
{
"name": "addressLine2",
"kind": "optional",
"type": "string",
"description": "address line2 of the address",
"example": ""
},
{
"name": "addressLine3",
"kind": "optional",
"type": "string",
"description": "address line3 of the address",
"example": ""
},
{
"name": "apartmentNumber",
"kind": "optional",
"type": "string",
"description": "apartment number of the address",
"example": ""
},
{
"name": "floor",
"kind": "optional",
"type": "string",
"description": "floor of the address",
"example": ""
},
{
"name": "county",
"kind": "optional",
"type": "string",
"description": "district or county of the address",
"example": ""
},
{
"name": "city",
"kind": "required",
"type": "string",
"description": "city of the address",
"example": ""
},
{
"name": "state",
"kind": "required",
"type": "string",
"description": "state of the address",
"example": ""
},
{
"name": "zipCode",
"kind": "required",
"type": "string",
"description": "zip code can be alphanumeric",
"example": ""
},
{
"name": "country",
"kind": "required",
"type": "object",
"description": "country which consists code and name",
"modelRef": "#/components/schemas/Country",
"customType": "Country",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
},
{
"name": "geolocation",
"kind": "optional",
"type": "object",
"description": "",
"example": "{\"lat\":\"30.3752° N\",\"long\":\"76.7821° E\"}",
"modelRef": "#/components/schemas/GeoCode",
"customType": "GeoCode",
"schema": [
{
"name": "long",
"kind": "required",
"type": "string",
"description": "range of longitude is -180 to 180 and can be upto 6 decimal places",
"example": ""
},
{
"name": "lat",
"kind": "required",
"type": "string",
"description": "range of latitude is -90 to 90 and can be upto 6 decimal places",
"example": ""
}
]
}
]
}
]
},
{
"name": "returnSlot",
"kind": "optional",
"type": "object",
"description": "Time Slot",
"modelRef": "#/components/schemas/TimeSlot",
"customType": "TimeSlot",
"schema": [
{
"name": "from",
"kind": "optional",
"type": "integer",
"example": 0
},
{
"name": "to",
"kind": "optional",
"type": "integer",
"example": 0
}
]
},
{
"name": "serviceTime",
"kind": "optional",
"type": "integer",
"description": "Number of seconds needed to complete the task",
"example": 0
}
]
},
{
"name": "priority",
"kind": "optional",
"type": "number",
"description": "Priority level of the order",
"example": ""
},
{
"name": "maxAttempts",
"kind": "optional",
"type": "number",
"description": "Maximum number of attempts needed for servicing an order",
"example": "",
"default": 3
},
{
"name": "teamId",
"kind": "required",
"type": "string",
"description": "Team Id that given order belongs to",
"example": ""
},
{
"name": "seqNo",
"kind": "optional",
"type": "number",
"description": "Sequence in which the orders appear to the FE on the FE App",
"example": ""
},
{
"name": "routeTag",
"kind": "optional",
"type": "string",
"description": "route tag",
"example": ""
},
{
"name": "vehicleModel",
"kind": "optional",
"type": "string",
"description": "vehicle model",
"example": ""
},
{
"name": "readyToProcess",
"kind": "optional",
"type": "boolean",
"description": "ready to process",
"example": "",
"default": true
},
{
"name": "containers",
"kind": "optional",
"type": "array",
"description": "Container Details",
"modelRef": "#/components/schemas/ContainerDetails",
"customType": "ContainerDetails[]",
"schema": [
{
"name": "containerType",
"kind": "required",
"type": "string",
"description": "Type of the container",
"example": "",
"default": "Shipment"
},
{
"name": "scannableId",
"kind": "required",
"type": "string",
"description": "Scannable ID",
"example": ""
},
{
"name": "trackingDetails",
"kind": "optional",
"type": "object",
"description": "Tracking details of the container",
"modelRef": "#/components/schemas/TrackingDetails",
"customType": "TrackingDetails",
"schema": [
{
"name": "operator",
"kind": "required",
"type": "string",
"description": "Specify the owner of the tracking ID",
"example": ""
},
{
"name": "trackingId",
"kind": "required",
"type": "string",
"description": "Unique id of the container to be used for tracking",
"example": ""
},
{
"name": "isPrimary",
"kind": "optional",
"type": "boolean",
"description": "Flag to identify if primary tracking id or not",
"example": ""
}
]
},
{
"name": "attributes",
"kind": "optional",
"type": "map",
"example": "",
"customType": "map",
"schema": [
{
"name": "dimensions",
"kind": "optional",
"type": "object",
"description": "dimensions of shipment",
"modelRef": "#/components/schemas/Dimensions",
"customType": "Dimensions",
"schema": [
{
"name": "weight",
"kind": "optional",
"type": "number",
"description": "weight of shipment",
"example": ""
},
{
"name": "volume",
"kind": "optional",
"type": "number",
"description": "volume of shipment",
"example": ""
}
]
}
]
}
]
}
]
},
{
"name": "object",
"description": "",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "Unique ID. Combination of entity name and UUID.",
"modelRef": "#/components/schemas/UniqueId",
"customType": "UniqueId",
"schema": []
},
{
"name": "offeringCategory",
"kind": "optional",
"type": "string",
"description": "Type of service offered by the tenant",
"modelRef": "#/components/schemas/OfferingCategory",
"customType": "OfferingCategory",
"schema": []
}
]
}
]
}
],
"modelRef": "#/components/schemas/OrderGetResponse",
"complexItems": [
{
"name": "object",
"schema": [
{
"name": "error",
"kind": "required",
"type": "object",
"description": "Error Information",
"modelRef": "#/components/schemas/Error",
"customType": "Error",
"schema": [
{
"name": "code",
"kind": "optional",
"type": "string",
"description": "Error code",
"example": ""
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": "Error description",
"example": ""
},
{
"name": "additionalInfo",
"kind": "optional",
"type": "object",
"description": "Additional information related to the error",
"example": "",
"schema": []
}
]
},
{
"name": "request",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Request",
"customType": "Request",
"schema": [
{
"name": "uri",
"kind": "required",
"type": "string",
"description": "The API end point where the request was received",
"example": ""
},
{
"name": "method",
"kind": "optional",
"type": "string",
"description": "HTTP method requested on the API endpoint",
"example": ""
},
{
"name": "queryString",
"kind": "optional",
"type": "string",
"description": "Query string received by the server",
"example": ""
},
{
"name": "body",
"kind": "optional",
"type": "object",
"description": "Request body data received by the server",
"example": "",
"schema": []
}
]
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"customType": "ErrorResponse"
},
{
"name": "object",
"schema": [
{
"name": "data",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/OrderResponse",
"customType": "OrderResponse",
"schema": [],
"complexType": "allOf",
"complexItems": [
{
"name": "OrderEntity",
"description": "",
"modelRef": "#/components/schemas/OrderEntity",
"schema": [
{
"name": "dropDetails",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/DropDetails",
"customType": "DropDetails",
"schema": [],
"complexType": "allOf",
"complexItems": [
{
"name": "DropDetailsUpdateRequest",
"description": "",
"modelRef": "#/components/schemas/DropDetailsUpdateRequest",
"schema": [
{
"name": "contact",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Contact",
"customType": "Contact",
"schema": [],
"complexType": "anyOf",
"complexItems": [
{
"name": "UniqueId",
"description": "",
"modelRef": "#/components/schemas/UniqueId",
"schema": []
},
{
"name": "ContactDetails",
"description": "",
"modelRef": "#/components/schemas/ContactDetails",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": "Contact name",
"example": ""
},
{
"name": "phone",
"kind": "optional",
"type": "object",
"description": "phone type data type, which consists below fields.",
"modelRef": "#/components/schemas/Phone",
"customType": "Phone",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "email",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/MultipleEmail",
"customType": "MultipleEmail",
"schema": [],
"complexType": "oneOf",
"complexItems": [
{
"name": "Email",
"description": "",
"modelRef": "#/components/schemas/Email",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "AdditionalEmail",
"description": "",
"modelRef": "#/components/schemas/AdditionalEmail",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
},
{
"name": "additionalPhone",
"kind": "optional",
"type": "array",
"description": "phone type data type, which consists below fields.",
"modelRef": "#/components/schemas/Phone",
"customType": "Phone[]",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "additionalEmail",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/AdditionalEmail",
"customType": "AdditionalEmail[]",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
}
]
},
{
"name": "location",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Location",
"customType": "Location",
"schema": [],
"complexType": "anyOf",
"complexItems": [
{
"name": "UniqueId",
"description": "",
"modelRef": "#/components/schemas/UniqueId",
"schema": []
},
{
"name": "LocationDetails",
"description": "",
"modelRef": "#/components/schemas/LocationDetails",
"schema": [
{
"name": "locationInfo",
"kind": "optional",
"type": "object",
"example": "",
"schema": []
},
{
"name": "address",
"kind": "required",
"type": "object",
"description": "address type data type, which consists below fields.",
"modelRef": "#/components/schemas/Address",
"customType": "Address",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "geolocation",
"kind": "optional",
"type": "object",
"description": "",
"example": "{\"lat\":\"30.3752° N\",\"long\":\"76.7821° E\"}",
"modelRef": "#/components/schemas/GeoCode",
"customType": "GeoCode",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
}
]
}
]
}
]
},
{
"name": "orderSummary",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/OrderSummary",
"customType": "OrderSummary",
"schema": [
{
"name": "invoiceNumber",
"kind": "optional",
"type": "string",
"description": "Invoice Number associated with the order",
"example": ""
},
{
"name": "orderDescription",
"kind": "optional",
"type": "string",
"description": "Description of the order",
"example": ""
},
{
"name": "totalWeight",
"kind": "optional",
"type": "object",
"description": "Total weight of the order",
"modelRef": "#/components/schemas/TotalOrderWeight",
"customType": "TotalOrderWeight",
"schema": [
{
"name": "value",
"kind": "required",
"type": "number",
"example": ""
}
]
},
{
"name": "totalVolume",
"kind": "optional",
"type": "object",
"description": "Total volume of the order",
"modelRef": "#/components/schemas/TotalOrderVolume",
"customType": "TotalOrderVolume",
"schema": [
{
"name": "value",
"kind": "required",
"type": "number",
"example": ""
}
]
},
{
"name": "totalItems",
"kind": "optional",
"type": "number",
"description": "Total number of containers in the order",
"example": ""
},
{
"name": "totalOrderCost",
"kind": "optional",
"type": "object",
"description": "Total cost of the order",
"modelRef": "#/components/schemas/TotalOrderCost",
"customType": "TotalOrderCost",
"schema": [
{
"name": "cost",
"kind": "required",
"type": "number",
"description": "value of cost incurred",
"example": ""
},
{
"name": "currencyCode",
"kind": "optional",
"type": "string",
"description": "currency code",
"example": ""
},
{
"name": "minorUnit",
"kind": "optional",
"type": "number",
"description": "unit of cost",
"example": ""
}
]
},
{
"name": "totalInvoice",
"kind": "optional",
"type": "object",
"description": "invoice of order",
"modelRef": "#/components/schemas/Invoice",
"customType": "Invoice",
"schema": [
{
"name": "value",
"kind": "optional",
"type": "integer",
"description": "total invoice value of the order",
"example": 0
},
{
"name": "currencyCode",
"kind": "optional",
"type": "string",
"description": "currency code",
"example": ""
},
{
"name": "minorUnit",
"kind": "optional",
"type": "integer",
"description": "unit of invoice",
"example": 0
}
]
}
]
},
{
"name": "clientDetails",
"kind": "required",
"type": "object",
"description": "Client details",
"modelRef": "#/components/schemas/ClientDetails",
"customType": "ClientDetails",
"schema": [
{
"name": "clientName",
"kind": "optional",
"type": "string",
"example": ""
},
{
"name": "clientId",
"kind": "optional",
"type": "string",
"description": "Unique ID. Combination of entity name and UUID.",
"modelRef": "#/components/schemas/UniqueId",
"customType": "UniqueId",
"schema": []
},
{
"name": "clientOrderId",
"kind": "required",
"type": "string",
"description": "Unique ID. Combination of entity name and UUID.",
"modelRef": "#/components/schemas/UniqueId",
"customType": "UniqueId",
"schema": []
}
]
},
{
"name": "mps",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Mps",
"customType": "Mps",
"schema": [],
"complexType": "allOf",
"complexItems": [
{
"name": "MpsUpdateRequest",
"description": "",
"modelRef": "#/components/schemas/MpsUpdateRequest",
"schema": [
{
"name": "groupId",
"kind": "optional",
"type": "string",
"description": "Stores the Master object of an MPS lot",
"example": ""
},
{
"name": "groupSize",
"kind": "optional",
"type": "number",
"description": "Stores the count of objects in an MPS lot",
"example": ""
},
{
"name": "isEnabled",
"kind": "optional",
"type": "boolean",
"description": "Flag to identity if order is a multi-piece shipment",
"example": ""
},
{
"name": "isPartial",
"kind": "optional",
"type": "boolean",
"description": "Indicates if partial delivery is enabled for an MPS lot",
"example": ""
}
]
}
]
},
{
"name": "eWaybillAttributes",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/eWaybillAttributes",
"customType": "eWaybillAttributes",
"schema": [],
"complexType": "allOf",
"complexItems": [
{
"name": "eWaybillAttributesRequest",
"description": "",
"modelRef": "#/components/schemas/eWaybillAttributesRequest",
"schema": [
{
"name": "is_valid_ewaybill",
"kind": "optional",
"type": "boolean",
"description": "Flag to identity if ewaybill is valid",
"example": ""
},
{
"name": "ewaybills",
"kind": "optional",
"type": "array",
"description": "list of ewaybills",
"example": "",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
}
]
}
]
},
{
"name": "productType",
"kind": "required",
"type": "string",
"description": "Type of the product in the order",
"modelRef": "#/components/schemas/ProductType",
"customType": "ProductType",
"schema": []
},
{
"name": "planningMode",
"kind": "optional",
"type": "string",
"description": "Fulfillment Type",
"modelRef": "#/components/schemas/PlanningMode",
"customType": "PlanningMode",
"schema": []
},
{
"name": "modeOfTransport",
"kind": "optional",
"type": "string",
"description": "Mode via which shipment will be moved",
"modelRef": "#/components/schemas/ModeOfTransport",
"customType": "ModeOfTransport",
"schema": []
},
{
"name": "speedOfTransport",
"kind": "optional",
"type": "string",
"description": "Speed of transfer of shipment",
"modelRef": "#/components/schemas/SpeedOfTransport",
"customType": "SpeedOfTransport",
"schema": []
},
{
"name": "shipmentFlow",
"kind": "required",
"type": "string",
"description": "Nature of flow of shipment",
"modelRef": "#/components/schemas/ShipmentFlow",
"customType": "ShipmentFlow",
"schema": []
},
{
"name": "pickupDetails",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/PickupDetails",
"customType": "PickupDetails",
"schema": [],
"complexType": "allOf",
"complexItems": [
{
"name": "PickupDetailsUpdateRequest",
"description": "",
"modelRef": "#/components/schemas/PickupDetailsUpdateRequest",
"schema": [
{
"name": "contact",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Contact",
"customType": "Contact",
"schema": [],
"complexType": "anyOf",
"complexItems": [
{
"name": "UniqueId",
"description": "",
"modelRef": "#/components/schemas/UniqueId",
"schema": []
},
{
"name": "ContactDetails",
"description": "",
"modelRef": "#/components/schemas/ContactDetails",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": "Contact name",
"example": ""
},
{
"name": "phone",
"kind": "optional",
"type": "object",
"description": "phone type data type, which consists below fields.",
"modelRef": "#/components/schemas/Phone",
"customType": "Phone",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "email",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/MultipleEmail",
"customType": "MultipleEmail",
"schema": [],
"complexType": "oneOf",
"complexItems": [
{
"name": "Email",
"description": "",
"modelRef": "#/components/schemas/Email",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "AdditionalEmail",
"description": "",
"modelRef": "#/components/schemas/AdditionalEmail",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
},
{
"name": "additionalPhone",
"kind": "optional",
"type": "array",
"description": "phone type data type, which consists below fields.",
"modelRef": "#/components/schemas/Phone",
"customType": "Phone[]",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "additionalEmail",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/AdditionalEmail",
"customType": "AdditionalEmail[]",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
}
]
},
{
"name": "location",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Location",
"customType": "Location",
"schema": [],
"complexType": "anyOf",
"complexItems": [
{
"name": "UniqueId",
"description": "",
"modelRef": "#/components/schemas/UniqueId",
"schema": []
},
{
"name": "LocationDetails",
"description": "",
"modelRef": "#/components/schemas/LocationDetails",
"schema": [
{
"name": "locationInfo",
"kind": "optional",
"type": "object",
"example": "",
"schema": []
},
{
"name": "address",
"kind": "required",
"type": "object",
"description": "address type data type, which consists below fields.",
"modelRef": "#/components/schemas/Address",
"customType": "Address",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "geolocation",
"kind": "optional",
"type": "object",
"description": "",
"example": "{\"lat\":\"30.3752° N\",\"long\":\"76.7821° E\"}",
"modelRef": "#/components/schemas/GeoCode",
"customType": "GeoCode",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
}
]
},
{
"name": "pickupSlot",
"kind": "optional",
"type": "object",
"description": "Time Slot",
"modelRef": "#/components/schemas/TimeSlot",
"customType": "TimeSlot",
"schema": [
{
"name": "from",
"kind": "optional",
"type": "integer",
"example": 0
},
{
"name": "to",
"kind": "optional",
"type": "integer",
"example": 0
}
]
},
{
"name": "serviceTime",
"kind": "optional",
"type": "integer",
"description": "Number of seconds needed to complete the task",
"example": 0
},
{
"name": "instruction",
"kind": "optional",
"type": "string",
"description": "instruction for the FE at the time of performing a pickup or drop objective.",
"example": ""
}
]
}
]
},
{
"name": "paymentInformation",
"kind": "optional",
"type": "object",
"description": "Payment Information",
"modelRef": "#/components/schemas/PaymentInformation",
"customType": "PaymentInformation",
"schema": [
{
"name": "paymentType",
"kind": "optional",
"type": "string",
"description": "Type of payment done for the order",
"modelRef": "#/components/schemas/PaymentType",
"customType": "PaymentType",
"schema": []
},
{
"name": "paymentOption",
"kind": "optional",
"type": "string",
"description": "Mode of payment",
"modelRef": "#/components/schemas/PaymentOption",
"customType": "PaymentOption",
"schema": []
}
]
},
{
"name": "deliveryDetails",
"kind": "optional",
"type": "object",
"description": "Delivery details",
"modelRef": "#/components/schemas/DeliveryDetails",
"customType": "DeliveryDetails",
"schema": [
{
"name": "promisedDeliveryDate",
"kind": "optional",
"type": "string",
"example": ""
},
{
"name": "deliverySlot",
"kind": "optional",
"type": "object",
"description": "Time Slot",
"modelRef": "#/components/schemas/TimeSlot",
"customType": "TimeSlot",
"schema": [
{
"name": "from",
"kind": "optional",
"type": "integer",
"example": 0
},
{
"name": "to",
"kind": "optional",
"type": "integer",
"example": 0
}
]
},
{
"name": "serviceTime",
"kind": "optional",
"type": "integer",
"description": "Number of seconds needed to complete the task",
"example": 0
},
{
"name": "instruction",
"kind": "optional",
"type": "string",
"description": "instruction for the FE at the time of performing a pickup or drop objective.",
"example": ""
}
]
},
{
"name": "actions",
"kind": "optional",
"type": "object",
"description": "Doorstep actions information",
"modelRef": "#/components/schemas/DoorstepActions",
"customType": "DoorstepActions",
"schema": [
{
"name": "qcValidation",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/ActionRequired",
"customType": "ActionRequired",
"schema": [
{
"name": "isRequired",
"kind": "required",
"type": "boolean",
"example": ""
},
{
"name": "requiredAt",
"kind": "optional",
"type": "string",
"example": ""
}
]
},
{
"name": "qcValidationChecklist",
"kind": "optional",
"type": "object",
"description": "Checklist for QCValidation",
"example": "",
"schema": []
},
{
"name": "kycVerification",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/ActionRequired",
"customType": "ActionRequired",
"schema": [
{
"name": "isRequired",
"kind": "required",
"type": "boolean",
"example": ""
},
{
"name": "requiredAt",
"kind": "optional",
"type": "string",
"example": ""
}
]
},
{
"name": "otpVerification",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/ActionRequired",
"customType": "ActionRequired",
"schema": [
{
"name": "isRequired",
"kind": "required",
"type": "boolean",
"example": ""
},
{
"name": "requiredAt",
"kind": "optional",
"type": "string",
"example": ""
}
]
},
{
"name": "signatureCollection",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/ActionRequired",
"customType": "ActionRequired",
"schema": [
{
"name": "isRequired",
"kind": "required",
"type": "boolean",
"example": ""
},
{
"name": "requiredAt",
"kind": "optional",
"type": "string",
"example": ""
}
]
}
]
},
{
"name": "notificationDetails",
"kind": "optional",
"type": "object",
"description": "Notification Information",
"modelRef": "#/components/schemas/NotificationDetails",
"customType": "NotificationDetails",
"schema": [
{
"name": "notificationType",
"kind": "optional",
"type": "string",
"description": "Key to identify if notification is needed at pickup or drop or both",
"modelRef": "#/components/schemas/NotificationType",
"customType": "NotificationType",
"schema": []
},
{
"name": "notificationMode",
"kind": "optional",
"type": "string",
"description": "Notifcaition mode to identify what mediums should the notification go through",
"modelRef": "#/components/schemas/NotificationMode",
"customType": "NotificationMode",
"schema": []
}
]
},
{
"name": "returnDetails",
"kind": "optional",
"type": "object",
"description": "Return details",
"modelRef": "#/components/schemas/ReturnDetails",
"customType": "ReturnDetails",
"schema": [
{
"name": "contact",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Contact",
"customType": "Contact",
"schema": [],
"complexType": "anyOf",
"complexItems": [
{
"name": "UniqueId",
"description": "",
"modelRef": "#/components/schemas/UniqueId",
"schema": []
},
{
"name": "ContactDetails",
"description": "",
"modelRef": "#/components/schemas/ContactDetails",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": "Contact name",
"example": ""
},
{
"name": "phone",
"kind": "optional",
"type": "object",
"description": "phone type data type, which consists below fields.",
"modelRef": "#/components/schemas/Phone",
"customType": "Phone",
"schema": [
{
"name": "countryCode",
"kind": "required",
"type": "string",
"description": "country code of the mobile it belongs.",
"example": ""
},
{
"name": "number",
"kind": "required",
"type": "string",
"description": "user phone number",
"example": ""
},
{
"name": "isMobile",
"kind": "required",
"type": "boolean",
"description": "whether the phone is of type mobile or telephone.",
"example": ""
},
{
"name": "areaCode",
"kind": "optional",
"type": "string",
"description": "in case of type telephone, areaCode of the telephone it belongs.",
"example": ""
},
{
"name": "muteNotif",
"kind": "optional",
"type": "boolean",
"description": "Should mute notification for this number",
"example": "",
"default": false
}
]
},
{
"name": "email",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/MultipleEmail",
"customType": "MultipleEmail",
"schema": [],
"complexType": "oneOf",
"complexItems": [
{
"name": "Email",
"description": "",
"modelRef": "#/components/schemas/Email",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "AdditionalEmail",
"description": "",
"modelRef": "#/components/schemas/AdditionalEmail",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
},
{
"name": "additionalPhone",
"kind": "optional",
"type": "array",
"description": "phone type data type, which consists below fields.",
"modelRef": "#/components/schemas/Phone",
"customType": "Phone[]",
"schema": [
{
"name": "countryCode",
"kind": "required",
"type": "string",
"description": "country code of the mobile it belongs.",
"example": ""
},
{
"name": "number",
"kind": "required",
"type": "string",
"description": "user phone number",
"example": ""
},
{
"name": "isMobile",
"kind": "required",
"type": "boolean",
"description": "whether the phone is of type mobile or telephone.",
"example": ""
},
{
"name": "areaCode",
"kind": "optional",
"type": "string",
"description": "in case of type telephone, areaCode of the telephone it belongs.",
"example": ""
},
{
"name": "muteNotif",
"kind": "optional",
"type": "boolean",
"description": "Should mute notification for this number",
"example": "",
"default": false
}
]
},
{
"name": "additionalEmail",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/AdditionalEmail",
"customType": "AdditionalEmail[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "Email string",
"example": ""
},
{
"name": "muteNotif",
"kind": "optional",
"type": "boolean",
"description": "Should mute notification for this number",
"example": "",
"default": false
}
]
}
]
}
]
},
{
"name": "location",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Location",
"customType": "Location",
"schema": [],
"complexType": "anyOf",
"complexItems": [
{
"name": "UniqueId",
"description": "",
"modelRef": "#/components/schemas/UniqueId",
"schema": []
},
{
"name": "LocationDetails",
"description": "",
"modelRef": "#/components/schemas/LocationDetails",
"schema": [
{
"name": "locationInfo",
"kind": "optional",
"type": "object",
"example": "",
"schema": []
},
{
"name": "address",
"kind": "required",
"type": "object",
"description": "address type data type, which consists below fields.",
"modelRef": "#/components/schemas/Address",
"customType": "Address",
"schema": [
{
"name": "buildingNumber",
"kind": "optional",
"type": "string",
"description": "house number can be alphanumeric",
"example": ""
},
{
"name": "addressLine1",
"kind": "required",
"type": "string",
"description": "address line1 of the address",
"example": ""
},
{
"name": "addressLine2",
"kind": "optional",
"type": "string",
"description": "address line2 of the address",
"example": ""
},
{
"name": "addressLine3",
"kind": "optional",
"type": "string",
"description": "address line3 of the address",
"example": ""
},
{
"name": "apartmentNumber",
"kind": "optional",
"type": "string",
"description": "apartment number of the address",
"example": ""
},
{
"name": "floor",
"kind": "optional",
"type": "string",
"description": "floor of the address",
"example": ""
},
{
"name": "county",
"kind": "optional",
"type": "string",
"description": "district or county of the address",
"example": ""
},
{
"name": "city",
"kind": "required",
"type": "string",
"description": "city of the address",
"example": ""
},
{
"name": "state",
"kind": "required",
"type": "string",
"description": "state of the address",
"example": ""
},
{
"name": "zipCode",
"kind": "required",
"type": "string",
"description": "zip code can be alphanumeric",
"example": ""
},
{
"name": "country",
"kind": "required",
"type": "object",
"description": "country which consists code and name",
"modelRef": "#/components/schemas/Country",
"customType": "Country",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
},
{
"name": "geolocation",
"kind": "optional",
"type": "object",
"description": "",
"example": "{\"lat\":\"30.3752° N\",\"long\":\"76.7821° E\"}",
"modelRef": "#/components/schemas/GeoCode",
"customType": "GeoCode",
"schema": [
{
"name": "long",
"kind": "required",
"type": "string",
"description": "range of longitude is -180 to 180 and can be upto 6 decimal places",
"example": ""
},
{
"name": "lat",
"kind": "required",
"type": "string",
"description": "range of latitude is -90 to 90 and can be upto 6 decimal places",
"example": ""
}
]
}
]
}
]
},
{
"name": "returnSlot",
"kind": "optional",
"type": "object",
"description": "Time Slot",
"modelRef": "#/components/schemas/TimeSlot",
"customType": "TimeSlot",
"schema": [
{
"name": "from",
"kind": "optional",
"type": "integer",
"example": 0
},
{
"name": "to",
"kind": "optional",
"type": "integer",
"example": 0
}
]
},
{
"name": "serviceTime",
"kind": "optional",
"type": "integer",
"description": "Number of seconds needed to complete the task",
"example": 0
}
]
},
{
"name": "priority",
"kind": "optional",
"type": "number",
"description": "Priority level of the order",
"example": ""
},
{
"name": "maxAttempts",
"kind": "optional",
"type": "number",
"description": "Maximum number of attempts needed for servicing an order",
"example": "",
"default": 3
},
{
"name": "teamId",
"kind": "required",
"type": "string",
"description": "Team Id that given order belongs to",
"example": ""
},
{
"name": "seqNo",
"kind": "optional",
"type": "number",
"description": "Sequence in which the orders appear to the FE on the FE App",
"example": ""
},
{
"name": "routeTag",
"kind": "optional",
"type": "string",
"description": "route tag",
"example": ""
},
{
"name": "vehicleModel",
"kind": "optional",
"type": "string",
"description": "vehicle model",
"example": ""
},
{
"name": "readyToProcess",
"kind": "optional",
"type": "boolean",
"description": "ready to process",
"example": "",
"default": true
},
{
"name": "containers",
"kind": "optional",
"type": "array",
"description": "Container Details",
"modelRef": "#/components/schemas/ContainerDetails",
"customType": "ContainerDetails[]",
"schema": [
{
"name": "containerType",
"kind": "required",
"type": "string",
"description": "Type of the container",
"example": "",
"default": "Shipment"
},
{
"name": "scannableId",
"kind": "required",
"type": "string",
"description": "Scannable ID",
"example": ""
},
{
"name": "trackingDetails",
"kind": "optional",
"type": "object",
"description": "Tracking details of the container",
"modelRef": "#/components/schemas/TrackingDetails",
"customType": "TrackingDetails",
"schema": [
{
"name": "operator",
"kind": "required",
"type": "string",
"description": "Specify the owner of the tracking ID",
"example": ""
},
{
"name": "trackingId",
"kind": "required",
"type": "string",
"description": "Unique id of the container to be used for tracking",
"example": ""
},
{
"name": "isPrimary",
"kind": "optional",
"type": "boolean",
"description": "Flag to identify if primary tracking id or not",
"example": ""
}
]
},
{
"name": "attributes",
"kind": "optional",
"type": "map",
"example": "",
"customType": "map",
"schema": [
{
"name": "dimensions",
"kind": "optional",
"type": "object",
"description": "dimensions of shipment",
"modelRef": "#/components/schemas/Dimensions",
"customType": "Dimensions",
"schema": [
{
"name": "weight",
"kind": "optional",
"type": "number",
"description": "weight of shipment",
"example": ""
},
{
"name": "volume",
"kind": "optional",
"type": "number",
"description": "volume of shipment",
"example": ""
}
]
}
]
}
]
}
]
},
{
"name": "object",
"description": "",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "Unique ID. Combination of entity name and UUID.",
"modelRef": "#/components/schemas/UniqueId",
"customType": "UniqueId",
"schema": []
},
{
"name": "offeringCategory",
"kind": "optional",
"type": "string",
"description": "Type of service offered by the tenant",
"modelRef": "#/components/schemas/OfferingCategory",
"customType": "OfferingCategory",
"schema": []
}
]
}
]
}
]
}
],
"complexType": "allOf",
"isExpanded": true
}
]
},
{
"statusCode": "400",
"description": "Error Occurred",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "GetErrorResponse",
"schema": [
{
"name": "error",
"kind": "required",
"type": "object",
"description": "Error Information",
"modelRef": "#/components/schemas/Error",
"customType": "Error",
"schema": [
{
"name": "code",
"kind": "optional",
"type": "string",
"description": "Error code",
"example": ""
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": "Error description",
"example": ""
},
{
"name": "additionalInfo",
"kind": "optional",
"type": "object",
"description": "Additional information related to the error",
"example": "",
"schema": []
}
]
},
{
"name": "request",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Request",
"customType": "Request",
"schema": [
{
"name": "uri",
"kind": "required",
"type": "string",
"description": "The API end point where the request was received",
"example": ""
},
{
"name": "method",
"kind": "optional",
"type": "string",
"description": "HTTP method requested on the API endpoint",
"example": ""
},
{
"name": "queryString",
"kind": "optional",
"type": "string",
"description": "Query string received by the server",
"example": ""
},
{
"name": "body",
"kind": "optional",
"type": "object",
"description": "Request body data received by the server",
"example": "",
"schema": []
}
]
},
{
"name": "data",
"kind": "optional",
"type": "object",
"example": "",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "Unique ID. Combination of entity name and UUID.",
"modelRef": "#/components/schemas/UniqueId",
"customType": "UniqueId",
"schema": []
}
]
}
],
"modelRef": "#/components/schemas/GetErrorResponse",
"complexItems": [
{
"name": "object",
"schema": [
{
"name": "error",
"kind": "required",
"type": "object",
"description": "Error Information",
"modelRef": "#/components/schemas/Error",
"customType": "Error",
"schema": [
{
"name": "code",
"kind": "optional",
"type": "string",
"description": "Error code",
"example": ""
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": "Error description",
"example": ""
},
{
"name": "additionalInfo",
"kind": "optional",
"type": "object",
"description": "Additional information related to the error",
"example": "",
"schema": []
}
]
},
{
"name": "request",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Request",
"customType": "Request",
"schema": [
{
"name": "uri",
"kind": "required",
"type": "string",
"description": "The API end point where the request was received",
"example": ""
},
{
"name": "method",
"kind": "optional",
"type": "string",
"description": "HTTP method requested on the API endpoint",
"example": ""
},
{
"name": "queryString",
"kind": "optional",
"type": "string",
"description": "Query string received by the server",
"example": ""
},
{
"name": "body",
"kind": "optional",
"type": "object",
"description": "Request body data received by the server",
"example": "",
"schema": []
}
]
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"customType": "ErrorResponse"
},
{
"name": "object",
"schema": [
{
"name": "data",
"kind": "optional",
"type": "object",
"example": "",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "Unique ID. Combination of entity name and UUID.",
"modelRef": "#/components/schemas/UniqueId",
"customType": "UniqueId",
"schema": []
}
]
}
]
}
],
"complexType": "allOf",
"isExpanded": true
}
]
},
{
"statusCode": "401",
"description": "Error Occurred",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "GetErrorResponse",
"schema": [
{
"name": "error",
"kind": "required",
"type": "object",
"description": "Error Information",
"modelRef": "#/components/schemas/Error",
"customType": "Error",
"schema": [
{
"name": "code",
"kind": "optional",
"type": "string",
"description": "Error code",
"example": ""
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": "Error description",
"example": ""
},
{
"name": "additionalInfo",
"kind": "optional",
"type": "object",
"description": "Additional information related to the error",
"example": "",
"schema": []
}
]
},
{
"name": "request",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Request",
"customType": "Request",
"schema": [
{
"name": "uri",
"kind": "required",
"type": "string",
"description": "The API end point where the request was received",
"example": ""
},
{
"name": "method",
"kind": "optional",
"type": "string",
"description": "HTTP method requested on the API endpoint",
"example": ""
},
{
"name": "queryString",
"kind": "optional",
"type": "string",
"description": "Query string received by the server",
"example": ""
},
{
"name": "body",
"kind": "optional",
"type": "object",
"description": "Request body data received by the server",
"example": "",
"schema": []
}
]
},
{
"name": "data",
"kind": "optional",
"type": "object",
"example": "",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "Unique ID. Combination of entity name and UUID.",
"modelRef": "#/components/schemas/UniqueId",
"customType": "UniqueId",
"schema": []
}
]
}
],
"modelRef": "#/components/schemas/GetErrorResponse",
"complexItems": [
{
"name": "object",
"schema": [
{
"name": "error",
"kind": "required",
"type": "object",
"description": "Error Information",
"modelRef": "#/components/schemas/Error",
"customType": "Error",
"schema": [
{
"name": "code",
"kind": "optional",
"type": "string",
"description": "Error code",
"example": ""
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": "Error description",
"example": ""
},
{
"name": "additionalInfo",
"kind": "optional",
"type": "object",
"description": "Additional information related to the error",
"example": "",
"schema": []
}
]
},
{
"name": "request",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Request",
"customType": "Request",
"schema": [
{
"name": "uri",
"kind": "required",
"type": "string",
"description": "The API end point where the request was received",
"example": ""
},
{
"name": "method",
"kind": "optional",
"type": "string",
"description": "HTTP method requested on the API endpoint",
"example": ""
},
{
"name": "queryString",
"kind": "optional",
"type": "string",
"description": "Query string received by the server",
"example": ""
},
{
"name": "body",
"kind": "optional",
"type": "object",
"description": "Request body data received by the server",
"example": "",
"schema": []
}
]
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"customType": "ErrorResponse"
},
{
"name": "object",
"schema": [
{
"name": "data",
"kind": "optional",
"type": "object",
"example": "",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "Unique ID. Combination of entity name and UUID.",
"modelRef": "#/components/schemas/UniqueId",
"customType": "UniqueId",
"schema": []
}
]
}
]
}
],
"complexType": "allOf",
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "example-0-curl",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url https://{domain}/app/logisticsorders/v1/api/orders/{orderId} \\\n --header 'accept: application/json' \\\n --header 'x-coreos-request-id: string' \\\n --header 'x-coreos-tid: string' \\\n --header 'x-coreos-access: string' \\\n --header 'x-coreos-userinfo: string'"
},
{
"id": "example-1-javascript",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-coreos-request-id\", \"string\");\nmyHeaders.append(\"x-coreos-tid\", \"string\");\nmyHeaders.append(\"x-coreos-access\", \"string\");\nmyHeaders.append(\"x-coreos-userinfo\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://{domain}/app/logisticsorders/v1/api/orders/{orderId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "example-2-ruby",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://{domain}/app/logisticsorders/v1/api/orders/{orderId}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-coreos-request-id\"] = \"string\"\nrequest[\"x-coreos-tid\"] = \"string\"\nrequest[\"x-coreos-access\"] = \"string\"\nrequest[\"x-coreos-userinfo\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "example-3-python",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://{domain}/app/logisticsorders/v1/api/orders/{orderId}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-coreos-request-id': 'string',\n 'x-coreos-tid': 'string',\n 'x-coreos-access': 'string',\n 'x-coreos-userinfo': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "example-0-curl"
},
"results": {
"languages": [
{
"id": "response-0-200",
"language": "200",
"code": "// Entity event mapped response\n{\n \"error\": {\n \"code\": \"\",\n \"description\": \"\",\n \"additionalInfo\": {}\n },\n \"request\": {\n \"uri\": \"\",\n \"method\": \"\",\n \"queryString\": \"\",\n \"body\": {}\n },\n \"data\": {}\n}"
},
{
"id": "response-1-400",
"language": "400",
"code": "// Error Occurred\n{\n \"error\": {\n \"code\": \"\",\n \"description\": \"\",\n \"additionalInfo\": {}\n },\n \"request\": {\n \"uri\": \"\",\n \"method\": \"\",\n \"queryString\": \"\",\n \"body\": {}\n },\n \"data\": {\n \"id\": \"\"\n }\n}"
},
{
"id": "response-2-401",
"language": "401",
"code": "// Error Occurred\n{\n \"error\": {\n \"code\": \"\",\n \"description\": \"\",\n \"additionalInfo\": {}\n },\n \"request\": {\n \"uri\": \"\",\n \"method\": \"\",\n \"queryString\": \"\",\n \"body\": {}\n },\n \"data\": {\n \"id\": \"\"\n }\n}"
}
],
"selectedLanguageId": "response-0-200"
}
},
"children": [
{
"id": "OISoxinZ9QtMHrhrgH_Dj",
"type": "paragraph",
"children": [
{
"text": "Get Order Details"
}
]
}
]
}