Planning & Execution Interfac...
Order Creation
11 min
use this api to push sales or transfer orders from your erp to transportone these orders contain essential details like origin, destination, and products, and form the foundation for downstream load creation and dispatch planning overview every transport cycle in transportone begins when your erp sends an order these orders describe what needs to be moved, where it's going, and when it should be dispatched once orders are created in tms, they can be grouped into loads for dispatch tms uses this data to calculate vehicle requirements, route planning, and carrier allocation data flow this is an erp → tms api when a customer places an order — for example, 10 units of "3 ton lg ac" from warehouse whs blr 001 to goelfrd — your erp pushes the order to transportone using this api once received, tms prepares the order for planning grouping it into a load, assigning transport, and setting it up for dispatch use this api whenever new shipment instructions need to be sent to tms base urls and endpoint base urls environment base url sandbox https //{tenantid} sandbox getos1 com production https //{tenantid} logistax io endpoint http post /tms/api/v1/orders request headers header key type required description notes / constraints authorization string yes bearer token for authentication format bearer \<access token> x coreos access string yes coreos access key required for authentication content type string yes mime type of the request body must be `application/json` x coreos request id string yes unique request id for idempotency uuid or any unique string x coreos tid string yes tenant id (organization identifier) — x coreos userinfo string no userinfo token for auditing optional x tms callback secret string no secret for callback verification optional; should be base64 encoded string request payload { "origin" "del", "destination" "ggn", "destinationdetails" { "address" "string", "zipcode" "string", "city" "string", "state" "string", "pocdetails" { "name" "string", "number" "string", "email" "string" } }, "ordernumber" "ord12334222", "orderdate" 1737635778000, "consigneename" "aramex", "expdeliverydate" 1737635778000, "soldtofacility" "string", "customerreferencenumber" "string", "orderpriority" "high", "clientid" "string", "ispacked" true, "readytomanifest" true, "invoicedetails" \[ { "invoicenumber" "string", "invoicedt" 121923292, "invoiceamount" 233 56, "invoicedescription" "string", "ewaybill" "string", "ewaybillexpdt" "string", "irn" "string", "sellergst" "string", "buyergst" "string" } ], "boxdimension" \[ { "length" 24 67, "breadth" 24 67, "height" 24 67, "weight" 24 67, "quantity" 24 67, "weightunit" "string", "boxid" "string", "loadid" "string" } ], "lineitems" \[ { "lineitemnumber" "li00122", "measurementunit" "box", "volume" { "value" 24 5, "unit" "cft" }, "weight" { "value" 24 07, "unit" "kgs" }, "quantity" 2, "product" { "mrp" "string", "category" "electronics", "code" "60000000019522" } } ], "callbackurl" "string" } success response { "success" true, "message" "order created", "orderid" "ord123456" } field reference field type required description ordernumber string yes unique identifier for the order from erp ordertype string yes type of order (e g , sale, return, stock transfer) orderdate string yes date the order was created (iso 8601 format) originfacilitycode string yes facility code where the shipment starts destinationfacilitycode string yes final delivery facility code expecteddispatchdate string yes planned dispatch date (iso 8601 format) products yes yes list of products included in the order priority string optional order priority (e g , low, medium, high) remarks string optional free text comments or delivery notes product object field type required description productcode string yes unique sku code from erp quantity number yes quantity to ship uom string yes unit of measure (e g , box, pcs) what’s next? once orders are created, your erp must push invoice details using the material invoice api tms requires this data to complete planning and begin dispatch view api reference documentation for full field level details
