This is the XSD schema definition for oTMS web services. Please refer to collection of oTMS Web Services Specification documents for further details. The request for order import. Request contains the necessary information to authenticate into oTMS and the list of order data to import. Contains the list of order data to import. The version number of the request. Login name granted to perform import order for oTMS registered company. Supplied password for login. API Source, not mandatory. Response of order import service. Contains global response code for import operation and list of responses per incoming orders - in the same sequence as orders arrived. Global response code. If not empty - indicates general error with the response: 0 - service call not authorised 1 - unsupported version Number of processed orders. Contains the list of order responses in the same sequence as order came in the request. Returns back the response version. Single order data to import. Offline client code in case of SP oTMS perspective. This is skip in case of SR perspective. Customer reference number. It can be order identifier of a calling system. Branch name. Order Erp Number oTMS Order Number Order remarks. True/false flag - if true then the order will be updated if orders imported by API and orders that are still in INBOX or DRAFT and not been manually edited after import policyNumber orders imported by API ShipFrom location can be given in two ways: 1) by ShipFrom externalId - defined in MasterData 2) full location specification ShipTo location can be given in two ways: 1) by ShipTo externalId - defined in MasterData 2) full location specification Defines many cargo/product lines. May be missing. True/false flag - if true then no cargo/product details will be concealed from vendor. True/false flag - if true then the order will be rejected if it reaches only draft status (only orders that qualify for inbox will be imported) Online vendor code True/false - if true then ePOD is required before billing, if false then ePOD is optional. default to false Each order to import must contain the unique sequence value. The order responses contain these too. This way user can match incoming order to outgoing order response. Describes geographical location of ShipFrom/ShipTo points. ShipFrom/ShipTo location name. Full Chinese postcode of the location. 6 digits. Based on the full postcode and the town of the location, oTMS platform uses its Zipcode Engine to select right geography area. The province name (in native Chinese). Based on province, oTMS pltaform uses its Zipcode Engine to select right geography area. The town name (in native Chinese). Based on town, oTMS pltaform uses its Zipcode Engine to select right geography area. The county name (in native Chinese). Based on county, oTMS pltaform uses its Zipcode Engine to select right geography area. The address line. true/false flag saying if loading takes place in case of ShipFrom location or unloading in case of ShipTo location. true/false flag saying if order does support xtt and should send e-mails to contact persons ShipFrom/ShipTo point remarks. Notify radius, the radius Notify when driver enter in the specific radius of the shipFrom/shipTo. The contact details of the person available at point. Family and surname of contact person available at point. Desktop phone name. Must conform to the following regexp pattern: \d{6,10}(-[0-9]{1,5})? Area code for phone number. Regexp: \d{1,4} Mobile phone name. Must confirm to the following regexp pattern: \d{11}((;|; | ;| ; ||){1}\d{11})* Email of contact person. Must be a valid email. Time schedule for the order. Defines the pickup and delivery dates. Pickup date in Chinese Standard Time. Pickup date remarks. Delivery date in Chinese Standard Time. Delivery date remarks. PickupTimeFrom time in Chinese Standard Time. PickupTimeTo time in Chinese Standard Time. DeliveryTimeFrom time in Chinese Standard Time. DeliveryTimeTo time in Chinese Standard Time. Contains the cargo/product definition and its amounts in the order. The cargo/product definition may be referred in two ways: 1) by externalId, a unique identifier of the cargo definition within company master data 2) cargo/product definition is fully supplied here Number of cargo/product units. Total weight of all units. Total volume of all units. Total insurance value of all units. User remarks to the cargo/product line. Cargo description provides the definition of the product/cargo. The product code. The product name. Cargo Category Unit length. Unit width. Unit height. The single unit weight. Defines the main information of the truck details. Driver name of the truck. The plate of the truck. Phone number of the truck driver. Defines the main information of the shipping cargo. Defines the quantity of physical items to ship. Defines the total weight of the cargo. Defines the total volume of the cargo. Defines the total insurance amount of the cargo. Defines the transport aspect for the order. User defined remarks about the transport mode. The number of loading meters. The truck length. If given, must be selected from predefined values. The truck lengths are configured per company. The oTMS defines the global set of supported truck lengths. If truck length cannot be matched within oTMS system - error code 1006 is returned. The truck CBM capacity. If given, must be selected from predefined values. Truck lengths define a subset of available CBM truck capacities. The oTMS defines the global set of truck lengths and their capacities (CBM and MT). If truck CBM capacity cannot be matched within oTMS system - error code 1006 is returned. The truck MT capacity. If given, must be selected from predefined values. Truck lengths define a subset of available MT truck capacities. The oTMS defines the global set of truck lengths and their capacities (CBM and MT). If truck MT capacity cannot be matched within oTMS system - error code 1007 is returned. Defines revenue for order. Defines base rate of order. Base rate description. Defines other fees of order. Other fees description. Defines temperature threshold for order. Defines the minimum temperature of the cargo. Defines the maximum temperature of the cargo. The selected incubators of the order. A response record for order being imported. Returns back the client reference number for the order. Returns back the order number assigned by oTMS system for imported order. If order couldn't be imported. This may be empty in case of NOT IMPORTED status. Returns import status of the order. Three values possible: INBOX - an order was qualified as complete in terms of oTMS system DRAFT - an order has some missing information, thus it was qualified as DRAFT NOT IMPORTED - an order couldn't be imported at all Contains a list of response codes that describes more precisely the problems during the import of this order. This is the value of sequence that corresponds to incoming order entry. This way the order response can be matched with order to import. Following response codes are enumerated: 1000 Client short code not found for order – Order NOT IMPORTED 1001 Invalid datatype in order fields – Order NOT IMPORTED 1002 Reserved for future use 1003 ShipFrom externalId not found 1004 ShipTo externalId not found 1005 Cargo/Product line externalId not found 1006 Truck length mismatch 1007 Truck MT capacity mismatch 1008 Truck CBM capacity mismatch 1009 Multiple ShipFrom externalId found 1010 Multiple ShipTo externalId found 1011 Multiple Cargo/Product line externalId found 1012 No order revenue – this happens at SP perspective - order will be only a draft 1013 ShipFrom oTMS zipcode cluster matched solely by town 1014 ShipFrom oTMS zipcode cluster matched solely by full postcode 1015 ShipFrom oTMS zipcode cluster unmatched 1016 ShipFrom oTMS zipcode cluster matched by both full postcode and town 1017 ShipTo oTMS zipcode cluster matched solely by town 1018 ShipTo oTMS zipcode cluster matched solely by full postcode 1019 ShipTo oTMS zipcode cluster unmatched 1020 ShipTo oTMS zipcode cluster matched by both full postcode and town 1021 No Cargo/Product line definition nor externalId, but quantities/weights/volumes set 1022 External order number not unique 1030 Custom fields disabled for company 1031 Some custom field ignored - disabled in configuration 1032 Missing value of required custom field 1033 Enum value does not exist 1040 Branch not found 1100 Other failure Specifying what operation should be automatically applied to an order after import if such operation enabled. Import only. No other operations. Order should be released after import. Order should be dispatched after import. Order should be dispatched to truck after import. When auto dispatching, whether tariff selection should base on price or lead time. Will be ignored if auto dispatch not enabled. Tariff should be chosen by cheapest price. Tariff should be chosen by shortest lead time When auto dispatching, whether tariff selection should base on price or lead time. Will be ignored if auto dispatch not enabled. Tariff should be chosen by cheapest price. Tariff should be chosen by shortest lead time Pickup / delivery time divides the civil day into time ranges. The pickup or delivery must hit these ranges. whole day = 0:00 - 23:59 business hours = 8:00 - 18:00 morning = 6:00 - 12:00 afternoon = 12:00 - 18:00 evening = 18:00 - 23:59 night = 0:00 - 6:00 Describes the working days within the week that ShipFrom/ShipTo operates. Weekdays from Monday to Friday Weekdays from Monday to Saturday Weekdays from Monday to Sunday Specifies the unit type of cargo/product line. A palett. A box. A bag. A piece. A piece(ge). A case. Defines if cargo/product can be stacked and on how many layers. Not stackable. 2 layers. 3 layers. 4 layers. 5 layers. 6 layers. 7 layers. 8 layers. Defines cargo type for the order. Cargo classification allows for common understanding among oTMS users about nature of transport orders exchange. Ambient regular cargo. Temperature controlled Dangerous goods, ambient, all classes Dangerous goods and temperature controlled Transport Unit (TU) Class - oTMS classifies cargo outer package for transport purposes into 4 classes. TU classification allows for common understanding among oTMS users about nature of transport orders exchange. In case of order contains different TU classes please highest one A. Loose & Stackable - stackable by hand on truck with no specific limitations - it means available truck capacity can be fully utilised and transport provider doesn't need special loading equipment. B. Stackable Pallets/Crates - stackable by forklift to maximum truck height - it means generally high truck utilisation, pallet double stacking is allowed & possible. Transport provider need forklift to reload/unload cargo. C. Non-stackable Pallets/Crates/Odd Shapes - it means truck height cannot be fully utilised. It is recommended that for LTL tariffs with such cargo parties agree rates based on LDM (truck floor loading meters) instead of CBM/MT. D. FTL-only -Consolidation not allowed. In such order only FTL tariffs (pay by truck size) are found since shipper does not allow any consolidation irrespective of shipment size. E. Incubator Freight type. Full truckload freight. Less than truckload shipping. Airplane transport. Express transport. Rail transport. Water transport. Type of the truck. Open truck. Closed truck. Any truck. Car Trailer. To set up truck capacity use MT capacity with one of the value: 1, 4, 6, 8, 10, 12, 14, 18, 21, 24. Oil tank truck. Flying wing truck. Custom fields that company has defined. It contains up to 10 text fields, 10 numerical fields, 10 enum fields. Custom fields that company has defined. It contains up to 10 text fields, 10 numerical fields, 10 enum fields. The request for ship point import. Request contains the necessary information to authenticate into oTMS and the list of ship point data to import. Contains the list of ship point data to import. The version number of the request. Login name granted to perform import ship point for oTMS registered company. Supplied password for login. The request for ship point import. Request contains the necessary information to authenticate into oTMS and the list of ship point data to import. Contains the list of ship point data to remove. The version number of the request. Login name granted to perform import ship point for oTMS registered company. Supplied password for login. Single ship point data to import. Offline client code in case of SP oTMS perspective. This is skip in case of SR perspective. Customer reference number. It can be ship point identifier of a calling system. API will identify same ship points by the following three rules. If at least one condition is matched, two ship points will be identified as same ship points. 1) Same clientReferenceNumber 2) Same clientCode (in SP case), ship point type and externalId , and if existing clienetReferenceNumber is not blank. 3) Same clientCodde (in SP case), ship point type, companyName, address and remark, and if existing clienetReferenceNumber is not blank. Name of this ship point. true/false flag saying if the ShipFrom location is a national delivery center. true/false flag saying if the ShipFrom location is a regional delivery center. The location name this ship point belongs to. List of applicable location names for this ship point. Required if selectType == 3. External id for reference later. API will identify same ship points by the following three rules. If at least one condition is matched, two ship points will be identified as same ship points. 1) Same clientReferenceNumber 2) Same clientCode (in SP case), ship point type and externalId , and if existing clienetReferenceNumber is not blank. 3) Same clientCodde (in SP case), ship point type, companyName, address and remark, and if existing clienetReferenceNumber is not blank. Province name of this ship point (in Chinese). City name of this ship point (in Chinese). oTMS uses town name and full zipcode to select the right geography area. County name of this ship point (in Chinese). Detailed address. Zone Code. Full zipcode of this ship point in 6 digits. oTMS uses town name and full zipcode to select the right geography area. determine whether to update zipcode when update a ship point. if false, the zipcode and the zipcodeCluster of this ship point won't be updated. true/false flag saying if loading takes place in case of ShipFrom location or unloading in case of ShipTo location. true/false flag saying if order does support xtt and should send e-mails to contact persons. Flag to indicate of XTT SMS notification is enabled Remark for this ship point. Notify Radius Notify Distance Percentage Mobile Apps Radius List of working days. List of non working days. Each ship point to import must contain the unique sequence value. The ship point responses contain these too. This way user can match incoming ship point to outgoing ship point response. (non) working day type. Type of the weekday. SUNDAY MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY Single ship point data to remove. Offline client code in case of SP oTMS perspective. This is skip in case of SR perspective. Customer reference number. It can be ship point identifier of a calling system. API will identify same ship points by the following three rules. If at least one condition is matched, two ship points will be identified as same ship points. 1) Same clientReferenceNumber 2) Same clientCode (in SP case), ship point type and externalId , and if existing clienetReferenceNumber is not blank. 3) Same clientCodde (in SP case), ship point type, companyName, address and remark, and if existing clienetReferenceNumber is not blank. External id for reference later. API will identify same ship points by the following three rules. If at least one condition is matched, two ship points will be identified as same ship points. 1) Same clientReferenceNumber 2) Same clientCode (in SP case), ship point type and externalId , and if existing clienetReferenceNumber is not blank. 3) Same clientCodde (in SP case), ship point type, companyName, address and remark, and if existing clienetReferenceNumber is not blank. Each ship point to import must contain the unique sequence value. The ship point responses contain these too. This way user can match incoming ship point to outgoing ship point response. Response of ship point import service. Contains global response code for import operation and list of responses per incoming ship points - in the same sequence as ship points arrived. Global response code. If not empty - indicates general error with the response: 0 - service call not authorised 1 - unsupported version Number of processed ship points. Contains the list of ship point responses in the same sequence as order came in the request. Returns back the response version. Response of ship point remove service. Contains global response code for remove operation and list of responses per incoming ship points - in the same sequence as ship points arrived. Global response code. If not empty - indicates general error with the response: 0 - service call not authorised 1 - unsupported version Number of processed ship points. Contains the list of ship point responses in the same sequence as order came in the request. Returns back the response version. A response record for ship point being imported. Returns back the client reference number for the ship point. Returns import status of the ship point. Four values possible: ADDED - Ship point does not match any existing entries, imported as a new ship point. UPDATED - Ship point matches an existing entry, updated the existing entry with data of this ship point. REMOVED - Found and removed the entry that matches this ship point FAILED - The operation for this ship point failed. Contains a list of response codes that describes more precisely the problems during the import of this ship point. This is the value of sequence that corresponds to incoming ship point entry. This way the ship point response can be matched with ship point to import. Type of this ship point. Ship from Ship to Hub Type of applicable locations for this ship point. All locations. HQ only. Selected locations. The request for order query include query conditions, order-by and pagination parameters. Contains the list of query clause. Contains the list of query clause. Start index of returned orders base on 1. Maximum number of orders to be returned. If response should include order basic information like ship from, ship to, order lines. Order info include order position information if this value is true, default is false. Query orders which exist discrepancy if this value is true, default is false. Order info include truck location history if this value is true, default is false. Order info include portable device if this value is true, default is false. Order info include location event if this value is true, default is false. Order info include order rejection if this value is true, default is false. Order info include order discrepancy if this value is true, default is false. Order info include truck and driver info if this value is true, default is false. Order info include milestones if this value is true, default is false. Order info include exceptions if this value is true, default is false. Order info include order compensation if this value is true, default is false. Order info include pickup/delivery point if this value is true, default is false. Order info include client info if this value is true, default is false. Order info include vendor info if this value is true, default is false. Order info include order lines if this value is true, default is false. The version number of the request. Login name granted to perform import order for oTMS registered company. Supplied password for login. orderNumber to be queried. erpNumber to be queried. order location name. Attribute to be queried Attribute value equal to this Attribute value greater than or equal to this Attribute value less than or equal to this Attribute value in this list Attribute value wildcard match to this List available order attributes that can be used in query and ordering The client’s oTMS short code The vendor's oTMS short code oTMS order number ERP number Order pickup SLA date Order delivery SLA date Order actual pickup date Order actual delivery date Order create time Order allocate time Order status Order billing accept time Custom text field 1 Custom text field 2 Custom text field 3 Custom text field 4 Custom text field 5 Custom text field 6 Custom text field 7 Custom text field 8 Custom text field 9 Custom text field 10 Custom text field 11 Custom text field 12 Custom text field 13 Custom text field 14 Custom text field 15 Custom text field 16 Custom text field 17 Custom text field 18 Custom text field 19 Custom text field 20 Custom text field 21 Custom text field 22 Custom text field 23 Custom text field 24 Custom text field 25 Custom text field 26 Custom text field 27 Custom text field 28 Custom text field 29 Custom text field 30 Custom text field 31 Custom text field 32 Custom text field 33 Custom text field 34 Custom text field 35 Custom text field 36 Custom text field 37 Custom text field 38 Custom text field 39 Custom text field 40 Custom text field 41 Custom text field 42 Custom text field 43 Custom text field 44 Custom text field 45 Custom text field 46 Custom text field 47 Custom text field 48 Custom text field 49 Custom text field 50 Custom text field 51 Custom text field 52 Custom text field 53 Custom text field 54 Custom text field 55 Custom text field 56 Custom text field 57 Custom text field 58 Custom text field 59 Custom text field 60 Custom text field 61 Custom text field 62 Custom text field 63 Custom text field 64 Custom text field 65 Custom text field 66 Custom text field 67 Custom text field 68 Custom text field 69 Custom text field 70 Custom text field 71 Custom text field 72 Custom text field 73 Custom text field 74 Custom text field 75 Custom text field 76 Custom text field 77 Custom text field 78 Custom text field 79 Custom text field 80 Custom number field 1 Custom number field 2 Custom number field 3 Custom number field 4 Custom number field 5 Custom number field 6 Custom number field 7 Custom number field 8 Custom number field 9 Custom number field 10 Custom Enum field 1 Custom Enum field 2 Custom Enum field 3 Custom Enum field 4 Custom Enum field 5 Custom Enum field 6 Custom Enum field 7 Custom Enum field 8 Custom Enum field 9 Custom Enum field 10 The response of query containing returned orders information. A list of returned orders. Start index of returned orders base on 1. Actual number of orders that returned. Total number of orders found by this query. The detailed order information. Order details for client. Order details for vendor. Basic order information. Pick up SLA date. Delivery SLA date. Order status. List of order events in time order. List of discussions for internal. Assigned drivers. Assigned drivers for pickup. Assigned drivers for delivery. List available order statuses New order Released order Vendor released order Dispatched order Vendor dispatched order Picked order Delivered order Order billed to client Order billed by vendor Closed order The order event. Name/type of this event List of order line register discrepancy events. List of order line confirmed discrepancy events. Time of this event Remark to this event Category of cargo The order discussion. Author of this post. Message posted at. Message text. Pickup or delivery leg assigned driver. List of assigned drivers. Assigned driver. Name of assigned driver. Real name of assigned driver. Mobile phone number of assigned driver. ID card number of assigned driver. Truck plate of assigned truck. The per-partner order details. partner’s oTMS short code. partner’s name. partner’s head office company code. partner’s name. The order erp number. Order price with this partner. Order price with this partner. The order consolidation id List of special charges / compensations. List of discussions specific to the partner. Bill with partner is accepted or not Then name of this bill The first name of owner who created this bill The family name of owner who created this bill Bill with partner is accepted or not Final billed rate VAT the time when bill was accepted The vat register no of this bill The price details. Name of this price detail Rate of this price detail Description for this price detail Order rate adjustments include special charge or compensation. Amount of rate adjustment incl. special charge and compensation. Negative for compensation, positive for special charge. Time this special charge / compensation registered. Remark to this compensation / special charge. Final billed rate Manual adjustment reason category code of special charge or compensation Basic order information. Remark of the order. Name of the branch the order belongs to. Ship from information of the order. Ship to information of the order. Total weight of the order in kg. Total volume of the order in cbm. Total cargo quantity of the order. Total insurance of the cargos. Order lines information of the order. Custom fields on order level. Dock appointment infomation. Order positions information. Order position information. Truck plate. Order longitude. Order latitude. Order address. Order ship from/ship to information. Name of the location. External id of the location if exists, maintained by user in my masterdata module. Province name of the location. Town name of the location. County name of the location. Address of the location. Custom fields on the location. The information of contact name. The information of contact mobile. The information of contact phone. The information of contact email. The order line discrepancy event. cargo code . cargo name . Total loss quantity . Total damage quantity . The order line confirm discrepancy event. cargo code . cargo name . unit . Total loss quantity . Total damage quantity . Discrepancy State . Discrepancy State REGISTERED. REJECTED. RECALLED. ACCEPTED. REASSIGNED. UPDATED. A single order line of a order. Product code of the order line. Product name of the order line. Quantity of the order line. Total volume of the order line. Total weight of the order line. Unit type of the order line. Cargo category of the order line. Custom fields on the order line. Expected arrival time of the appointment. Name of driver assigned to the appointment. Truck plate number of the truck assigned to the appointment. Mobile phone number of the driver assigned to the appointment. The request for external billing update. The version number of the request. Login name granted to perform order partial update for oTMS registered company. Supplied password for login. The request for external billing delete. The version number of the request. Login name granted to perform order partial update for oTMS registered company. Supplied password for login. Delay Reason Customer Reason Carrier Reason Other Reason Default Reason Unknown Reason The request for pause, resume or re-trigger job manual.. The version number of the request. Login name granted to perform import ship point for oTMS registered company. Supplied password for login. The request for truck import and driver import. Request contains the necessary information to authenticate into oTMS and the list of data to import. Contains the list of driver data to import. Contains the list of truck data to import. The version number of the request. Login name granted to perform import truck/driver for oTMS registered company. Supplied password for login. Single driver data to import. Name of the driver to import. Note that the name actually imported into system will be the name registered by driver himself in mobile app. Mobile of the driver to import. This is a unique identifier of driver. System will send an invitation to this mobile after import. Must be a valid single mobile number. Remarks on the imported driver. Is the imported driver a trusted driver. Default value is false. ID card number of the driver to import. It should be 18 bit and valid by format. Each entry to import must contain the unique sequence value. The responses contain these too. This way user can match incoming entry to outgoing response. Single truck data to import. Type of cargo that the imported truck is licensed for. Type of the imported truck. The truck length. If given, must be selected from predefined values. This field is required if truck type is not car trailer. The truck CBM capacity. If given, must be selected from predefined values. Truck lengths define a subset of available CBM truck capacities. The truck MT capacity. If given, must be selected from predefined values. Truck lengths define a subset of available MT truck capacities. The truck plate. This is a unique identifier for truck. Must be a valid truck plate. The trailer plate. Must be a valid truck plate. Remarks on the imported truck. Each entry to import must contain the unique sequence value. The responses contain these too. This way user can match incoming entry to outgoing response. Response of truck/driver import service. Contains global response code for import operation and list of responses per incoming entry - in the same sequence as the entries arrived. Global response code. If not empty - indicates general error with the response: 0 - service call not authorised 1 - unsupported version Number of successfully imported trucks. Number of successfully imported drivers. Contains the list of truck responses in the same sequence as truck came in the request. Contains the list of driver responses in the same sequence as driver came in the request. Returns back the response version. Response of truck/driver import service. Contains global response code for import operation and list of responses per incoming entry - in the same sequence as the entries arrived. Returns back the truck plate. Returns import status of the entry. Two values possible: SUCCESS - entry was successfully imported. FAILED - error occured during import, entry will not be imported. Contains a list of response codes that describes more precisely the problems during the import. This is the value of sequence that corresponds to incoming entry. This way the response can be matched with processed entries. Response of truck/driver import service. Contains global response code for import operation and list of responses per incoming entry - in the same sequence as the entries arrived. Returns back the driver name. This driver name is the name that is imported in to the system if the import succeeded, which is the name that driver registered in mobile app if it exists. Returns back the mobile number. Returns import status of the entry. Two values possible: SUCCESS - entry was successfully imported. FAILED - error occured during import, entry will not be imported. Contains a list of response codes that describes more precisely the problems during the import. This is the value of sequence that corresponds to incoming entry. This way the response can be matched with processed entries. The request for assign order to driver. Request contains the necessary information to authenticate into oTMS and the list of driver/order pair. The list of information for assign order to driver. The version number of the request. Login name granted to perform driver assignment for oTMS registered company. Supplied password for login. Short code of client company of the order. Only needed for SP account. Order can be matched in two ways: 1) By oTMS order number. This number is assigned per order after order is created. 2) By erp number from external system. Order can be matched in two ways: 1) By oTMS order number. This number is assigned per order after order is created. 2) By erp number from external system. The branch that this order belongs to. If called by location user, then this must be the same with the user's location. The list of information for drivers and trucks. This is the value of sequence that corresponds to incoming entry. This way the response can be matched with processed entries. Truck plate to match a truck, which is assigned to a driver. Driver name to match a driver. Driver mobile to match a driver. Response of driver assignment service. Contains global response code for the operation and list of responses per incoming entry - in the same sequence as the entries arrived. The number of successful assignments. Global response code. If not empty - indicates general error with the response: 0 - service call not authorised 1 - unsupported version The list of detailed result of the assign operation. Returns back the response version. The detailed information for the process result of a single incoming entry. The result of the process. Can take two values: DISPATCHED: order is successfully assigned to a driver and a truck and is dispatched in oTMS system. FAILED: error occured during process, no data will be changed. The number of orders actually assigned to the driver. oTMS order numbers for orders assigned to the driver. The list of information for drivers trucks and responseCodes. This is the value of sequence that corresponds to incoming entry. This way the response can be matched with processed entries. The actual truck plate of the truck that the order is assigned to. The name of the driver that the order is assigned to. The mobile of the driver that the order is assigned to. Contains a list of response codes that describes more precisely the problems during the process. The number of successfully proceeded order split. The number of failed proceeded order split. The result split. The results of process of external orders. The results of process of one split order. the order info of the split order. the status of the proceed result(SUCCEED/FAILED). The error Message to describe the case of the failure. if the status is SUCCEED, this field should ignored. split order sub orderNumber. This is the value of sequence that corresponds to incoming entry. This way the response can be matched with processed entries. The orderNumber of sub order. The number of successfully proceeded external order infos. The results of porcess of external orders. The results of porcess of one external order. the order number of the order. the erp number of the order. the code of product. the name of product. the status of the proceed result(SUCCEED/FAILED). the status of the proceed epod upload result(SUCCEED/FAILED). the ErrCode of the upload epod attachment result(CODE). the status of the upload attachment result(SUCCEED/FAILED). the ErrCode of the upload attachment result(CODE). The error code to describe the case of the failure. if the status is SUCCEED, this field shoule ignored. This is the value of sequence that corresponds to incoming entry. This way the response can be matched with processed entries. The operation type. the value can be one of below. SPLIT_ORDER. The operation type split order. the list of the external order info. the hub info of the aplit order. the transport mode of order. pickup hub transport mode. delivery hub transport mode. line transport mode. Login name granted to perform import order for oTMS registered company. Supplied password for login. Version number. (must be "0.1" now) The operation type. the value can be one of below. PICKUP, DELIVERY, EXCETION_H The operation type pickup. The operation type delivery. The operation type exception_H. The operation type exception_B. The operation type EXCEPTION_G1. The operation type EPOD_UPLOAD. The operation type COMPENSATION. The operation type register C/D. The operation type register AH. The operation type register LH. the list of the external order infos the list of the external epod infos Login name granted to perform import order for oTMS registered company. Supplied password for login. Version number. (must be "0.1" now) order split hub info. value can be hubName or hub external code. order split info deliveryToHubFrom. order split info deliveryToHubTo. order split info pickupFromHubFrom. order split info pickupFromHubTo. The operation type. the value can be one of below. The operation type split order. The operation type split order. The operation type split order. The eventDate of the order intransitEvent happened. The eventReason of the order intransitEvent happened. The remark of the order exception happened. The truck plate of arriving hub. The hub name of arriving hub. The boxes number of scans of arriving hub. The claimTo. the exception claim for client or vendor. CLIENT, VENDOR The claim for CLIENT. The claim for VENDOR. the list of the external order attachments Product code of the order line. Product name of the order line. unit type of product. unit price of product. damage cargo. shortage cargo. orderLineId OrderLine Sequence orderLine quantity. Attribute value fileName Attribute value content The compensation method. the value can be one of below. INSURANCE, DISCREPANCY, NONE The compensation is based on insurance. The compensation is based on discrepancy. The compensation is normal. The compensation type. the value can be one of below. SKU, TOTAL The compensation is based on sku The compensation is based on total The phone number of the driver who you want to compensation The compensation method. the value can be one of below. INSURANCE, DISCREPANCY, NONE The compensation objective is client. The compensation objective is vendor. The compensation objective is driver. The total fee of the compensation. the list of the order line compensation. The code of the product The name of the product The unit of the product The quantity of the damage. The quantity of the shortage. The damage unit price. The shortage unit price. The date of the order picked up/deliver happened. The latitude of event pickup/deliver happened. The longitude of event pickup/deliver happened. The file name of epod The file content of epod The request for order recall. Request contains the necessary information to authenticate into oTMS and the list of order number to recall. Contains the list of order number to recall. The version number of the request. Login name granted to perform import order for oTMS registered company. Supplied password for login. Single order data to recall. Order Number Each order to recall must contains the unique sequence value. The order responses contain these too. This way user can match incoming order to outgoing order response. Response of order recall service. Contains global response code for recall operation and list of responses per recall orders - in the same sequence as orders arrived. Global response code. If not empty - indicates general error with the response: 0 - service call not authorised 1 - unsupported version Number of successful recalled orders. Contains the list of order responses in the same sequence as order came in the request. Returns back the response version. A response record for order being recalled. Returns back the order number that the API received Returns recall status of the order. Three values possible: SUCCESS - recall succeed FAILED - an order couldn't be recall at all Contains a list of response codes that describes more precisely the problems during the recall of this order. This is the value of sequence that corresponds to incoming order entry. This way the order response can be matched with order to recall. The request for share order. Contains the list of share order. The version number of the request. Login name granted to perform import order for oTMS registered company. Supplied password for login. Single share order request. Erp number. Order number. Each share order sequence. The response for share order. Global response code. Number of success orders. Number of fail orders. Contains the list of share order. Returns back the response version. Single share order response. Status. Code. Erp number. Order number. Url. Each share order sequence. The request for jobSheet import. Request contains the necessary information to authenticate into oTMS and the list of jobSheet data to import. Contains the list of jobSheet data to import. The version number of the request. Login name granted to perform import jobSheet for oTMS registered company. Supplied password for login. Single jobSheet data to import. Offline client code in case of SP oTMS perspective. This is skip in case of SR perspective. Customer reference number. It can be order identifier of a calling system. Branch name. jobSheet external shipment id. vendor short code for auto dispatch Defines many orders information, May be missing. Each jobSheet to import must contain the unique sequence value. The jobSheet responses contain these too. This way user can match incoming jobSheet to outgoing jobSheet response. Single jobSheet Order data to import. Offline client code in case of SP oTMS perspective. This is skip in case of SR perspective. Customer reference number. It can be order identifier of a calling system. orderNumber to be queried. erpNumber to be queried. order's sequence for jobsheet Response of jobSheet import service. Contains global response code for import operation and list of responses per incoming jobSheet - in the same sequence as jobSheet arrived. Global response code. If not empty - indicates general error with the response: 0 - service call not authorised 1 - unsupported version Contains the list of order responses in the same sequence as jobSheet came in the request. Returns back the response version. A response record for jobSheet being imported. Returns back the external shipment number for jobSheet. Returns import status of the jobSheet. Two values possible: RELEASE - a jobSheet was released in terms of oTMS system NOT IMPORTED - a jobSheet couldn't be imported at all jobSheet import response Contains the list of jobSheet response This is the value of sequence that corresponds to incoming order entry. This way the order response can be matched with order to import. A response record for order being imported. Returns back the order number assigned by oTMS system for imported order. If order couldn't be imported. This may be empty in case of NOT IMPORTED status. Contains a list of response codes that describes more precisely the problems during the import of this order. The request for vendor outbound. Request contains the necessary information to authenticate into oTMS. The version number of the request. Login name granted to perform import order for oTMS registered company. Supplied password for login. Response of vendor outbound service. Contains list of vendors Contains the list of vendors Vendor company name Vendor company code Company registered date Company contact person A list of returned orders. A list of returned orders. Company contact person name Company contact person phoneNumber Company contact person mobile phone Company contact person email erp# and orderNumber at least exist one, for query order. erp# and orderNumber at least exist one, for query order. assign vendor code. must be online company. cost, order dispatch need. DispatchOrder sequence. responseCode for all orders process result. orders for response erp# from request. orderNumber from otms. single dispatchOrder process result. single dispatchOrder process result. msg for failed reason. orderDispatchResult sequence. erp# and orderNumber at least exist one, for query order. erp# and orderNumber at least exist one, for query order. orderRevoke sequence. responseCode for all orders process result. orders for response erp# from request. orderNumber from otms. single revoke order process result. single revoke order process result. msg for failed reason. order revoke process result sequence. The request for share h5 order link. Contains the list of h5 order. The version number of the request. Login name granted to perform import order for oTMS registered company. Supplied password for login. Single h5 order request. Erp number. Order number. user type. Each share order sequence. The response for h5 order. Global response code. Number of success orders. Number of fail orders. Contains the list of h5 order. Returns back the response version. Single h5 order response. Status. Code. Erp number. Order number. Url. User type. Each h5 order sequence. The request for creating handover and generating barcode. Contains the list order with erp number. The version number of the request. Login name granted to perform import order for oTMS registered company. Supplied password for login. Single handover order request. Offline client code in case of SP oTMS perspective. This is skip in case of SR perspective. Erp number. oTMS Order Number Each share order sequence. The response for handover creation. Global response code. Generated handover barcode content. Contains the list of order process result when generating barcode. Returns back the response version. Single handover order response. Process status. Erp number. oTMS Order Number Contains a list of response codes that describes more precisely the problems during the import of this order. Each handover order response entry sequence.