Update Order Status via API
To update an existing order in vCX you can call the order update API as below
https://productbackend.versal.one/api/order/updateOrder/<orderId>
{
// Mandatory Fields cannot be changed
"company_id": VERPL000972024,
// Optional Fields
"firstName": "Jane",
"lastName": "Smith",
"phoneNumber": "+9876543210",
"email": "jane.smith@example.com",
"postalCode": "12345",
"streetAddress1": "789 Oak Avenue",
"streetAddress2": "Unit 5C",
"city": "Shelbyville",
"state": "Indiana",
"specialInstructions": "Call upon arrival.",
"totalAmount": 2000.50,
"products": [
{ "product_id": "201", "quantity": 3, "price": 600 },
{ "product_id": "202", "quantity": 2, "price": 400.25 }
],
"billingStreetAddress1": "321 Pine Lane",
"billingStreetAddress2": "Office 101",
"billingCity": "Shelbyville",
"billingState": "Indiana",
"billingPostalCode": "12345",
"companyOrderDate": "2024-11-10",
"companyOrderDueDate": "2024-11-25",
"companyOrderDeliveryStatus": "Shipped",
"companyOrderPaymentReference": "PAY-654321",
"companyOrderStatus": "Shipped",
"companyOrderDescription": "Updated order description",
"company_order_other_attributes_1": { "giftWrap": true },
"company_order_other_attributes_3": { "priorityDelivery": true }
}
No Comments