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