Skip to main content
POST
https://api-ai.textyess.com
/
webhooks
/
new-order
/
{organizationId}
Webhook for new orders
curl --request POST \
  --url https://api-ai.textyess.com/webhooks/new-order/{organizationId} \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --data '
{
  "id": "<string>",
  "shipping_address": {
    "first_name": "<string>",
    "last_name": "<string>",
    "address1": "<string>",
    "address2": "<string>",
    "phone": "<string>",
    "city": "<string>",
    "zip": "<string>",
    "company": "<string>",
    "country_code": "<string>",
    "province": "<string>",
    "country": "<string>"
  },
  "billing_address": {
    "first_name": "<string>",
    "last_name": "<string>",
    "address1": "<string>",
    "address2": "<string>",
    "phone": "<string>",
    "city": "<string>",
    "zip": "<string>",
    "company": "<string>",
    "country_code": "<string>",
    "province": "<string>",
    "country": "<string>"
  },
  "created_at": "<string>",
  "email": "<string>",
  "customer": {
    "id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "phone": "<string>"
  },
  "order_number": 123,
  "total_price": "<string>",
  "payment_gateway_names": [
    {}
  ],
  "line_items": [
    {
      "price": "<string>",
      "quantity": 123,
      "title": "<string>",
      "variant_title": "<string>"
    }
  ],
  "financial_status": "<string>",
  "phone": "<string>",
  "fulfillments": [
    {
      "id": "<string>",
      "shipment_status": "<string>",
      "tracking_company": "<string>",
      "tracking_url": "<string>",
      "tracking_urls": [
        "<string>"
      ]
    }
  ],
  "order_status_url": "<string>"
}
'
{ "success": "true" }

​
Overview

The webhook for new orders enables TextYess to receive and manage data from newly created orders. By receiving this data, TextYess can unlock enhanced analytics and provide powerful automation features.

​
Path Parameters

​
organizationid
string
required
The id of the organization You can get your organization id from https://ai.textyess.com/developers

​
Body Parameters

​
id
string
required
The id of the order
​
shipping_address
object
Shipping address information
​
billing_address
object
Billing address information
​
created_at
string
required
The date and time when the order was created
​
email
string
Customer’s email address
​
customer
object
Customer information
​
order_number
number
required
The order number
​
total_price
string
required
The total price of the order
​
payment_gateway_names
array
required
An array of payment gateway names used for the order
​
line_items
array
required
An array of items in the order
​
financial_status
string
required
The financial status of the order
​
phone
string
required
The phone number associated with the order (must start with dial code eg: +39)
​
fulfillments
array
An array of fulfillment information
​
order_status_url
string
URL to check the order status

​
Response

​
success
boolean
If the webhook was sucessfully process
{ "success": "true" }