Order Transfer (createOrder)
Order Transfer
The createOrder()
method is used to upload your order commands to the Horoz system. It supports both single and multiple order submissions.
- Before transferring orders using this method, details regarding Horoz Parametric Features should be communicated to Horoz Logistics.
- The maximum number of orders that can be sent in each request is 1,000.
- The "customerNumber" field found in the Order Transfer service is used for customer information related to the order. Orders cannot be sent without defining a customer code.
POST createOrder
Use
Parameter Descriptions & Rules
The table below lists the input and output parameters of the createOrder()
operation, along with their types and formats.
- Fields
- Example Services Request
- Example Response
Parameter | Mandatory | Description | Data Type |
---|---|---|---|
processKey | Yes | Information provided to you for processKey | string |
OrderNumber | Yes | Order Code | string |
CustomerNumber | No | Customer Code | string |
CustomerOrderNumber | No | Customer Order Code | string |
BranchCode | No | Branch Code | string |
OrderType | No | Order Type | string |
OrderDate | No | Order Date | string |
OrderComment | No | Order Note | string |
SenderTitle | No | Sender Title | string |
SenderAddress | No | Sender Address | string |
SenderPostCode | No | Sender Postal Code | string |
SenderArea | No | Sender District | string |
SenderCity | No | Sender City | string |
SenderPhoneNumber | No | Sender Phone Number | string |
SenderEmail | No | Sender Email | string |
RecepientTitle | No | Recipient Title | string |
RecepientAddress | No | Recipient Address | string |
RecepientArea | No | Recipient District | string |
RecepientCity | No | Recipient City | string |
RecepientPostCode | No | Recipient Postal Code | string |
RecepientPhoneNumber | No | Recipient Phone Number | string |
RecepientEmail | No | Recipient Email | string |
RecepientTaxOffice | No | Recipient Tax Office | string |
RecepientTaxNumber | No | Recipient Tax Number | string |
ShippingType | No | Shipping Type | string |
ShippingCode | No | Shipping Code | string |
RequestedShippingDate | No | Requested Shipping Date | string |
RequestedDeliveryDate | No | Requested Delivery Date | string |
RequestedDeliveryTimePeriod | No | Requested Delivery Time Period | string |
CarrierTitle | No | Carrier Title | string |
CarrierVehiclePlate | No | Carrier Vehicle Plate | string |
CarrierDriverName | No | Carrier Driver Name | string |
CarrierDriverPhoneNumber | No | Carrier Driver Phone Number | string |
CarrierRoute | No | Carrier Route | string |
CheckInWarehouse | No | Check-In Warehouse | string |
CheckOutWarehouse | No | Check-Out Warehouse | string |
DataTransferInfo | No | Data Transfer Information | string |
Parameter | No | Parametric Fields | string |
OrderDetail | Yes | Order Details | string |
{
"processKey": "string",
"orderNumber": "string",
"customerNumber": "string",
"customerOrderNumber": "string",
"branchCode": "string",
"orderType": "string",
"orderDate": "string",
"orderComment": "string",
"senderTitle": "string",
"senderAddress": "string",
"senderPostCode": "string",
"senderArea": "string",
"senderCity": "string",
"senderPhoneNumber": "string",
"senderEmail": "string",
"recepientTitle": "string",
"recepientAddress": "string",
"recepientArea": "string",
"recepientCity": "string",
"recepientPostCode": "string",
"recepientPhoneNumber": "string",
"recepientEmail": "string",
"recepientTaxOffice": "string",
"recepientTaxNumber": "string",
"shippingType": "string",
"shippingCode": "string",
"requestedShippingDate": "string",
"requestedDeliveryDate": "string",
"requestedDeliveryTimePeriod": "string",
"carrierTitle": "string",
"carrierVehiclePlate": "string",
"carrierDriverName": "string",
"carrierDriverPhoneNumber": "string",
"carrierRoute": "string",
"checkInWarehouse": "string",
"checkOutWarehouse": "string",
"dataTransferInfo": "string",
"parameter01": "string",
.
.
"parameter50": "string",
"orderDetail":
[
{
"parameter01": "string",
.
.
"parameter50": "string",
"productCode": "string",
"quantity": 0,
"packageType": "string",
"lineNumber": "string",
"serialNumber": "string",
"dataTransferInfo": "string"
}
]
}
{
"result": "0",
"errorCode": "",
"systemMessage": " "
}
OrderDetail
- Fields
Parameter | Mandatory | Description | Data Type |
---|---|---|---|
ProductCode | Yes | Product Code | string |
Quantity | Yes | Quantity | integer |
PackageType | No | Package Type | string |
LineNumber | No | Line Number | string |
SerialNumber | No | Serial Number | string |
DataTransferInfo | No | Data Transfer Info | string |
Services Response
result | errorCode | systemMessage | Description |
---|---|---|---|
1 | Order information sent to the Horoz system successfully. | ||
0 | 101 | SAME ORDER RECORD EXISTS! | Order information sent to the Horoz system already exists. |
0 | 101 | UNDEFINED SUPPLIER! | Supplier information sent to the Horoz system is undefined. |