DispatchOne Solution
LogisticsOrder API
LogisticsOrder API Functionalities
2 min
the logisticsorder api has the following endpoints https //docs getos1 com/reference/create a new order https //docs getos1 com/reference/7lu6 get order details https //docs getos1 com/reference/order cancellation request attributes for creating orders to create an order, call the https //docs getos1 com/reference/create a new order endpoint and specify the below given attributes in the request body member description remarks dropdetails > contact > name contact name string, minlength 1, maxlength 128 dropdetails > contact > phone > countrycode country code of the mobile it belongs string, pattern ^+(\d{1} )?(\d{1,3})$ dropdetails > contact > phone > number user phone number string, minlength 4, maxlength 13 dropdetails > contact > phone > ismobile whether the phone is type mobile or telephone boolean dropdetails > location > address > addressline1 address line 1 of the address string, minlength 1, maxlength 128 dropdetails > location > address > city city of the address string, pattern \[a za z]{2,64} dropdetails > location > address > country > code code of the country string, pattern \[a z]{2,3} dropdetails > location > address > country > name name of the country string, pattern \[a za z]{2,64} dropdetails > location > geolocation > long range of longitude is 180 to 180 and can be up to 6 decimal places string pattern ^(+| )?(? 180(? (? 0{1,6})?)|(? \[0 9]|\[1 9]\[0 9]|1\[0 7]\[0 9])(? (? \[0 9]{1,6})?))$ dropdetails > location > geolocation > lat range of latitude is 90 to 90 and can be up to 6 decimal places string pattern ^(+| )?(? 90(? (? 0{1,6})?)|(? \[0 9]|\[1 8]\[0 9])(? (? \[0 9]{1,6})?))$ ordersummary > totalweight > value total weight of the order number ordersummary > totalordercost > cost value of cost incurred number producttype type of the product in the order string, enum \[ parcel, ptl, heavy, services ] shipmentflow nature of flow of shipment string, enum \[ forward, reverse, none ] pickupdetails > contact > name contact name string, minlength 1, maxlength 128 pickupdetails > contact > phone > countrycode country code of the mobile it belongs string, pattern ^+(\d{1} )?(\d{1,3})$ pickupdetails > contact > phone > number user phone number string, minlength 4, maxlength 13 pickupdetails > contact > phone > ismobile whether the phone is of type mobile or telephone boolean pickupdetails > location > address > addressline1 address line 1 of the address string, minlength 1, maxlength 128 pickupdetails > location > address > city city of the address string pattern \[a za z]{2,64} pickupdetails > location > address > country > code code of the country string pattern \[a z]{2,3} pickupdetails > location > address > country > name name of the country string pattern \[a za z]{2,64} pickupdetails > location > geolocation > long range of longitude is 180 to 180 and can be up to 6 decimal places string pattern ^(+| )?(? 180(? (? 0{1,6})?)|(? \[0 9]|\[1 9]\[0 9]|1\[0 7]\[0 9])(? (? \[0 9]{1,6})?))$ pickupdetails > location > geolocation > lat range of latitude is 90 to 90 and can be up to 6 decimal places string pattern ^(+| )?(? 90(? (? 0{1,6})?)|(? \[0 9]|\[1 8]\[0 9])(? (? \[0 9]{1,6})?))$ actions > qcvalidation > isrequired if qc validation is required boolean actions > kycverification > isrequired if kyc verification is required boolean actions > otpverification > isrequired if otp verification is required boolean actions > signaturecollection > isrequired if a signature is required boolean returndetails > contact > name contact name string, minlength 1, maxlength 128 returndetails > contact > phone > countrycode country code of the mobile it belongs string, pattern ^+(\d{1} )?(\d{1,3})$ returndetails > contact > phone > number user phone number string, minlength 4, maxlength 13 returndetails > contact > phone \> ismobile whether the phone is of type mobile or telephone boolean returndetails > location > address > addressline1 address line 1 of the address string, minlength 1, maxlength 128 returndetails > location > address > city city of the address string, pattern \[a za z]{2,64} returndetails > location > address > country > code code of the country string, pattern \[a z]{2,3} returndetails > location > address > country > name name of the country string, pattern \[a za z]{2,64} returndetails > location > geolocation > long range of longitude is 180 to 180 and can be up to 6 decimal places string pattern ^(+| )?(? 180(? (? 0{1,6})?)|(? \[0 9]|\[1 9]\[0 9]|1\[0 7]\[0 9])(? (? \[0 9]{1,6})?))$ returndetails > location > geolocation > lat range of latitude is 90 to 90 and can be up to 6 decimal places string pattern ^(+| )?(? 90(? (? 0{1,6})?)|(? \[0 9]|\[1 8]\[0 9])(? (? \[0 9]{1,6})?))$ teamid team id that the given order belongs to string containers > trackingdetails > operator specify the owner of the tracking id string containers > trackingdetails > trackingid unique id of the container to be used for tracking string learn more about https //docs getos1 com/how to create orders