Update order by order number

Update order on Deeple system when some products in order cannot fulfill

Endpoint

/v1/orders/:orderNumber

Resource method

PATCH

Parameters

URL parameter

Field nameTypesRequired/OptionalDescription
orderNumberstring(12)ROrder's number

Body parameters

Field nameTypesRequired/OptionalDescription
userIdstring(36)RUser’s id from either LINE or Facebook
postalCodestring(10)OUser’s postal code
receiverNamestring(50)RReceiver name for order
firstNamestring(30)RFirst name for order
lastNamestring(30)RLast name for order
streetAddressstring(50)RStreet address for order
streetAddress2string(50)OStreet address2 for order
districtstring(50)RDistrict for order
subDistrictstring(50)RSub-district for order
provincestring(50)RProvince for order
postalCodestring(10)RPostal code for order
phoneNumberstring(10)RPhone number for order
emailstring(50)REmail for order
orderNumberstring(12)ROrder's number
notestring(50)ROrder's note from customer
grandTotalnumber(10)ROrder’s grand total
totalPricenumber(10)ROrder’s total price
vatPricenumber(10)ROrder's vat price
vatValuenumber(1)ROrder's vat value
vatOptionsstring(10)ROrder's vat option
discountTotalPricenumber(10)ROrder's total discount price
itemslist of itemRSelected Items’ in order

Example request parameter

{
"receiverName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"streetAddress": "T-One Building, 8 Sukhumvit",
"district": "Khet Khlong Toei",
"subDistrict": "Phra Khanong",
"province": "Bangkok",
"postalCode": "10110",
"phoneNumber": "0987654321",
"email": "john-doe@email.com",
"orderNumber": "ON2005220001",
"note": "customer's note",
"grandTotal": 1000,
"totalProductDiscount": 0,
"totalPrice": 934.58,
"vatPrice": 65.42,
"vatValue": 7,
"vatOptions": "INCLUDED",
"items": [
{
"productCode": "VA-4017",
"price": 250,
"amount": 4
},
{
"productCode": "VA-4015",
"price": 250,
"amount": 1
}
]
}

Example expected response object

200 - OK status code