Skip to main content
POST
Update order status

Overview

With this method you can send order status update messages.
This method is only available for WhatsApp Business accounts. All original order data must be resent with the additional mandatory parameters returned via webhook.

Example on WhatsApp


Attributes

string
required
Your instance ID. Available in the Z-API panel under Instances.
string
required
Your Z-API instance token.

Required

string
required
Recipient’s phone number in DDI DDD NUMBER format. E.g.: 551199999999
string
required
Original order message ID from WhatsApp
string
required
Order reference ID (obtained via webhook)
string
required
Order request reference ID (obtained via webhook)
string
required
New order status: pending, processing, shipped, completed or canceled
string
required
Payment status: pending or paid
object
required
Order data

Optional

string
Order update text message

Request Body


Response

200

405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.