Update Order
API Update Order
CustomerAPIUpdateOrder
POST
/api/Customer/CustomerAPIUpdateOrder
Request Body
Name | Type | Description |
---|---|---|
OrderCode* | string | From response of Create an order api |
ClientHubID | interger | 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 |
Note | string | Note |
ExtraServices | array | List of VAT Services |
InformFee | string | 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 - In the form to select DVBH (insurance service), required to enter the declared value (InformFee). |
SpecialInstructionId | string | Special note code for COD orders only: 1 - Show the goods. 0 - Do not show the goods. |
MailerType | string | Code type of freight: HH - Goods TL - Document |
ExternalCode | string | Customer order code |
ReferenceCode | string | Customer reference code |
CODAmount | number | The amount of COD will be collected from the recipient |
ServiceTypeID | string | ServiceTypeID |
Height | number | Height (cm) |
Width | number | Width (cm) |
Length | number | Length(cm) |
Quantity | integer | Quantity package |
RealWeight | number | Real Weight (kg) |
ReceiverWardName | string | Recipient's Ward name |
ReceiverDistrictName* | string | Recipient's District name |
ReceiverProvinceName* | string | Recipient's Province name |
ReceiverAddress | string | Recipient's full address |
ReceiverName | string | Recipient's name |
ReceiverPhone | string | Recipient's phone |
Packages | array | { "PackageID" : PackageID, "Length": Length (cm) (Required when entering in Height, Width), "Width": Width (cm)(Required when entering in Height, Length), "Height": Height (cm)(Required when entering in Width, Length), "RealWeight": 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) |
Example
Errors Code
1: Ward error
2: District error
3: Province error
4: Duplicate ordercode
5: Server error
6: Was an exception
8: Update Order error
9: SpecialInstruction is required
10: ServiceType is required
12: Account is invalid
13: Order is not found
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 incomplete
25: COPAmt is invalid
Last updated