Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-order
Send order
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-order \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "order": {
    "currency": "<string>",
    "products": [
      {
        "name": "<string>",
        "value": 123,
        "quantity": 123,
        "productId": "<string>"
      }
    ],
    "discount": 123,
    "tax": 123,
    "shipping": 123
  }
}
'

​
Overview

With this method you can send order messages, containing products from your catalog or customized at the time of sending. This message is the same as the one sent when you click the “Accept order” or “Send invoice” button.
Available only for WhatsApp business accounts. Products without productId are treated as custom items.

​
Attributes

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

​
Required

​
phone
string
required
Recipient’s phone number in DDI DDD NUMBER format. E.g.: 551199999999
​
order
object
required
Order data

​
Optional

​
paymentSettings
object
Payment settings

​
Request Body

With catalog products and payment: 
{
  "phone": "554499999999",
  "order": {
    "currency": "BRL",
    "discount": 10,
    "tax": 10,
    "shipping": 5,
    "products": [
      {
        "productId": "23940797548900636",
        "name": "Product name",
        "value": 10,
        "quantity": 2
      }
    ]
  },
  "paymentSettings": {
    "pix": {
      "key": "PIX Key",
      "keyType": "cpf",
      "name": "Key name"
    },
    "card": {
      "enabled": true
    }
  }
}
Required fields only (custom product): 
{
  "phone": "554499999999",
  "order": {
    "currency": "BRL",
    "products": [
      {
        "name": "Product name",
        "value": 150,
        "quantity": 1
      }
    ]
  }
}

​
Response

​
200

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
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”.