Predefined Logistics Order API Attributes
The following attributes are inbuilt into Logistics Order API:
Attribute Category | Attribute Label | Attribute Name | Description |
|---|---|---|---|
Order Identification | Order ID | orderId | Unique order ID generated by the platform for every order created. |
Drop Details | Contact information | contact | Information pertaining to contact details for the drop: - Name - Country Code - Contact Number - Contact ID {SDS ID of the contact. Subscribers can pass this if they don't wish to pass the other contact info} |
| Location Information | location | Information pertaining to drop location. One of the two is mandatory: - Address information (add line 1, line2, city, state, zipCode, country) - Facility ID {mandatory if Add info is not provided}- Geocodes |
Order Summary | Invoice Number (optional) | invoiceNumber | Invoice Number associated with the order. Can contain alphabets and numbers. |
| Order Description (optional) | orderDescription | Textual description of the order. It can contain details on the type of order, its contents, etc. |
| Total Weight (optional) | totalWeight | Total weight of the order. Information needed: - Value - Unit: Allowed values - Gram, Kilo, Ton |
| Total Containers (optional) | totalItems | Total number of containers in the order. The value should be an integer. |
| Total Order Cost (Mandatory for COD orders) | totalOrderCost | Total cost of the order. Information needed:- Cost- Currency Code- Minor Unit |
Client Details | Client Name (optional) | clientName | Name of the client. The value should be a string. |
| Client ID (optional) | clientId | ID of the client saved in internal systems. Would be alphanumeric. |
| Client Order ID (optional) | clientOrderId | Order ID passed by the client. This ID could be used by the client for internal tracking purposes. Value can be alphanumeric. |
Misc | MPS (optional) | mps | Flag to identify if an order is MPS (Default: false). |
Work Order Related | Work Order Flow Type | workOrderFlowType | Specifies the order in which the multiple work orders of an order will be executed by the orchestrator. The core attribute of coreOS Order Service. (Default: Sequential) |
| Work Order Type | type | Identifies the type of Work Order. The core attribute of coreOS Order Service. |
Service offering | Product Type | productType | Product for which the template is being created. Possible values: Parcel, PTL, Heavy, Services. (Single select) |
| Shipment flow | shipmentFlow | Nature of flow of shipment. Possible values: Forward, Reverse, None (Single select). Default: None |
Pickup Details | Contact information | contact | Information pertaining to contact details for pickup:- Name- Country Code- Contact Number- Contact ID {SDS ID of the contact. Subscribers can pass this if they don't wish to pass the other contact info} |
| Location Information | location | Information pertaining to the pickup location. Could be passed as address information or Facility ID. One of the two is mandatory: - Address information (add line 1, line2, city, state, zipCode, country) - Facility ID {mandatory if Add info is not provided} - Geocodes |
| Pick up slot (optional) | pickUpSlot | Date and time slot within which items are to be picked. Information to be captured - Date and time. |
| Service Time (optional) | serviceTime | Time it takes to serve the order at the pickup location. An optional field to be used mainly for the auto-routing engines. Information to be captured - # of hours needed to complete the task. |
Delivery Slot Information | Promised Delivery Date (optional) | promisedDeliveryDate | PDD provided by the tenant on order manifestation. Information to be captured - Date and time. |
| Delivery Slot (optional) | deliverySlot | Delivery slot provided by the end customer based on their availability. Information to be captured - Date and time. |
| Delivery Service time (optional) | deliveryServiceTime | Time it takes to serve the order at the drop location. An optional field to be used mainly for the auto-routing engines. Being captured at the WO level as the service time depends on the product/service being performed. Information to be captured - # of hours needed to complete the task. |
Doorstep Actions | QC validation checklist (optional) | qcValidationChecklist | If QC validation is marked as yes for either the pickup or drop or both, the subscriber should pass a list of questions to perform the validation. This attribute can provision for that. It will be a list of questions with yes/no answers. |
Notifications | Notification type (optional) | notificationType | To identify if notification is needed at pickup or drop or both. Possible values: Pickup or Drop or both (Single select). |
| Notification mode (optional) | notificationMode | Notification mode to identify what mediums should the notification go through. Possible values: SMS, Email, Whatsapp (multi-select) |
Return Details | Return slot (optional)
| returnSlot | Time slot within which items are to be returned. Should contain: - Date - Time |
| Service Time (optional) | serviceTime | Time it takes to serve the order at the return location. An optional field to be used mainly for the auto-routing engine. Information to be captured - # of hours needed to complete the task. |
Misc | Priority (optional) | priority | Captures the priority level of the order. Specifically for the auto-routing engine. Should be a positive integer. |
| Max Attempts (optional) | maxAttempts | Maximum number of attempts needed for servicing a WO. Should be an integer with the range 1-9. |
Teams | Team ID | teamId | Logistic companies have their Employees or Riders divided into Teams that have predefined serviceability. Orders in Order FPA will belong to a specific Team. This attribute will contain the Team ID that a given order belongs to. Should be alphanumeric values. |
Container details | Container Type | containerType | The type of the container. We will have only 1 type in the MVP. Default Type: Shipment |
| Dimension (optional) - Length - Breadth - Height - Unit | | - Length of the container. - Breadth of the container. - Height of the container. - Unit in which dimension is being measured. |
| Weight (optional) - Value - Unit | | - Weight of the container. - Unit in which weight is measured. |
Tracking details passed by the subscriber | Tracking Details (optional) | trackingDetails | Object to represent tracking ID (such as AWB) for a container which is usually pasted on the container and used for scanning it. Value: AWB |
Shipment details | Contents of a shipment (optional) | shipmentDetails | Individual articles in a given container. Example: 10 pairs of trousers. Values expected as a part of contents: - Description of the items - Quantity - Cost of item |