Create an order

CustomerApiCreateOrder

POST:/Api/Customer/CustomerAPICreateOrder

Headers

Name	Value
ClientID	From login api
Token	From login api

Body

Name	Type	Description
ClientHubID*	integer	ClientHubID (Required when not passed CusWareHouseID)
CusWareHouseID	string	ShopID/WareHouseID (Required when not passed ClientHubID)
ContactName	string	Contact name
ContactPhone	string	Contact phone
SenderAddress	string	Sender full address
DirectSenderName	string	Direct sender name
ReceiverPhone	string	Recipient's phone.
ReceiverName	string	Recipient's name.
ReceiverAddress*	string	Recipient's full address (house number, Street name, Ward name, District name, Province name).
ReceiverProvinceName*	string	Recipient's Province name.
ReceiverDistrictName*	string	Recipient's District name.
ReceiverWardName	string	Recipient's Ward name.
RealWeight	number	Real weight(kg).
Length	number	Length (cm).
Width	number	Width (cm).
Height	number	Height (cm).
Quantity	integer	Quantity package.
Note	string	Note.
ServiceTypeID	string	Service code.
MailerType	string	Code type of freight: HH - Goods. TL - Document.
CODAmount	number	The amount of COD will be collected from the recipient.
ExternalCode	string	Customer order code.
ReferenceCode	string	Customer reference code
SpecialInstructionId	number	Special note code for COD orders only: 1 - Show the goods. 2 - Do not show the goods.
InformFee	number	Declared value. Cases to note when declaring: 1 - Price calculation volume >= 2.5kg need to choose type = HH (goods). 2 - Type = HH (goods), required to enter the declared value (InformFee). 3 - If you choose DVBH (insurance service), you must enter the declared value(InformFee)
ExtraServices	array	List of VAT Services
Packages	array	{ "PackageID": "HD000003/1", //PackageID, "Length": 100, // Length (cm) (Required when entering in Height, Width), "Width": 50, // Width (cm)(Required when entering in Height, Length), "Height": 80, // Height (cm) (Required when entering in Width, Length), "RealWeight": 25 //Real weight (kg) } (*)The number of Packages must be equal to Quantity property. In case Quantity = 1 thenPackages = []
COPAmt	number	COP amount (Cash on pickup)

Response

200

{
    "Errors": [],
    "ErrorCode": "0",
    "OrderInfo": {
        "OrderCode": "HD000003",
        "ReferenceCode": "HD000003",
        "ExternalCode": "HD000003",
        "TotalServiceCost": 44176,
        "ExtraServices": [
            {
                "ServiceName": "Chuyển phát nhanh",
                "ServiceID": "DE",
                "Cost": 16800
            },
            {
                "ServiceName": "Hàng đông lạnh",
                "ServiceID": "HDL",
                "Cost": 15000
            },
            {
                "ServiceName": "Báo phát",
                "ServiceID": "BP",
                "Cost": 5000
            },
            {
                "ServiceName": "Phí xăng dầu",
                "ServiceID": "Fuel",
                "Cost": 3360
            },
            {
                "ServiceName": "Phí VAT",
                "ServiceID": "VAT",
                "Cost": 4016
            }
        ],
        "DeliveryType": "1"
    },
    "ErrorMessage": ""
}

401

{
    "IsError": true,
    "ErrorMessage": "Bạn cần đăng nhập để truy cập chức năng này."
}

Name	Type	Description
Errors	array object	Array of Errors
ErrorCode	string	Error code
ErrorMessage	string	Error message
OrderInfo	object	Order Info
OrderCode	string	Order ID
ReferenceCode	string	Customer reference code
ExternalCode	string	Customer order code
TotalServiceCost	number	Total Service Cost
ExtraService	array object	Value-added services list
ServiceName	string	Value-added service name
ServiceID	string	Value-added service id
Cost	number	Value-added service cost
DeliveryTimeType	string	Delivery by: "1" - 247 Exprest "2" - Other

Example

{
   "OrderInfo":{
      "ClientHubID":11583,
      "CusWareHouseID":"30984",
      "ContactName": "Trần Văn B",
      "ContactPhone": "0332318317",      
      "ReceiverPhone":"0345555777",
      "ReceiverName":"Trương Chí Nhân",
      "ReceiverAddress":"326 Võ Văn Kiệt, phường Cô Giang, Quận 1, Hồ Chí Minh, Việt Nam",
      "ReceiverProvinceName":"Hồ Chí Minh",
      "ReceiverDistrictName":"Quận 1",
      "ReceiverWardName":"Phường Cô Giang",   
      "RealWeight":1,
      "Length":0,
      "Width":0,
      "Height":0,
      "Quantity":2,
      "Packages" :[
         {
            "PackageID":"HD000003/1",
            "Length":25,
            "Width":30,
            "Height": 10,
            "RealWeight": 5 
         },
         {
            "PackageID":"HD000003/2",
            "Length":33,
            "Width":25,
            "Height": 12,
            "RealWeight": 8.7
         }
      ],
      "Note":"Tài liệu",
      "ServiceTypeID":"DE",
      "MailerType":"HH",
      "CODAmount":0,
      "ExternalCode":"HD000003",
      "ReferenceCode": "HD000003",
      "SpecialInstructionId":1,
      "InformFee":500000,
      "COPAmt": 25000,
      "ExtraServices":[
         {
            "ServiceID":"PTN",
            "Type":2
         },
         {
            "ServiceID":"BP",
            "Type":2
         }
      ]
   }
}

Errors Code

• 1: Ward error

• 2: District error

• 3: Province error

• 4: Duplicate ordercode

• 5: Server error

• 6: Was an exception

• 9: SpecialInstruction is required

• 10: ServiceType is required

• 11: SenderAddred is invalid

• 12: Account is invalid

• 15: OrderCode is required

• 16: OrderCode is invalid

• 17: ReceiverAddress is invalid

• 18: MailerType is invalid

• 19: Quantity is invalid

• 20: Packages is invalid

• 21: Sender info is incomplete

• 25: COP amount is invalid