Create an order

POST

/orders

Create a new order for collecting payments from your customer on WhatsApp

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Body Params application/json

Example

{
    "id": "your_order_id",
    "app_execution_id": "app_exec_1234",
    "type": "physical_goods",
    "contact": {
        "name": "Alfred Hitchcock",
        "language": "string",
        "email": "alfred@example.com",
        "phone_number": "+919988776655",
        "metadata": {
            "key": "value"
        }
    },
    "items": [
        {
            "name": "Product 1",
            "amount": 12000,
            "quantity": 2,
            "sale_amount": 12000
        }
    ],
    "expiration": {
        "timestamp": 1711929600,
        "description": "Sorry, the event is booked."
    },
    "currency": "INR",
    "subtotal": 12380,
    "tax": {
        "value": 1200,
        "description": "GST"
    },
    "shipping": {
        "value": 15000,
        "description": "Prime shipping"
    },
    "discount": {
        "value": 1000,
        "description": "10OFF on first purchase"
    },
    "total_amount": 200
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/orders' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "your_order_id",
    "app_execution_id": "app_exec_1234",
    "type": "physical_goods",
    "contact": {
        "name": "Alfred Hitchcock",
        "language": "string",
        "email": "alfred@example.com",
        "phone_number": "+919988776655",
        "metadata": {
            "key": "value"
        }
    },
    "items": [
        {
            "name": "Product 1",
            "amount": 12000,
            "quantity": 2,
            "sale_amount": 12000
        }
    ],
    "expiration": {
        "timestamp": 1711929600,
        "description": "Sorry, the event is booked."
    },
    "currency": "INR",
    "subtotal": 12380,
    "tax": {
        "value": 1200,
        "description": "GST"
    },
    "shipping": {
        "value": 15000,
        "description": "Prime shipping"
    },
    "discount": {
        "value": 1000,
        "description": "10OFF on first purchase"
    },
    "total_amount": 200
}'

Responses

🟢201Created

application/json

Created order successfully

Body

Example

{
    "id": "your_order_id",
    "app_execution_id": "app_exec_1234",
    "type": "physical_goods",
    "contact": {
        "name": "Alfred Hitchcock",
        "language": "string",
        "email": "alfred@example.com",
        "phone_number": "+919988776655",
        "metadata": {
            "key": "value"
        }
    },
    "items": [
        {
            "name": "Product 1",
            "amount": 12000,
            "quantity": 2,
            "sale_amount": 12000
        }
    ],
    "expiration": {
        "timestamp": 1711929600,
        "description": "Sorry, the event is booked."
    },
    "currency": "INR",
    "subtotal": 12380,
    "tax": {
        "value": 1200,
        "description": "GST"
    },
    "shipping": {
        "value": 15000,
        "description": "Prime shipping"
    },
    "discount": {
        "value": 1000,
        "description": "10OFF on first purchase"
    },
    "total_amount": 200
}

🟠422Parameter Error

Modified at 2025-04-02 04:39:19

Create multiple contacts

Find order by ID