Order - Payload

This payload represents the JSON body that Let’sTrade will send to a client’s designated webhook URL whenever:

  • A new order is created, or

  • An existing order status is updated.

The receiving endpoint should accept POST requests with application/json content type.


Payload Example

{
    "order_code": "string",
    "partner_id": "string",
    "branch_number": "string",
    "delivery_fee": "string",
    "order_date": "YYYY-MM-DDTHH:mm:ss",
    "order_type": "DELIVERY | COLLECTION | DINE-IN",
    "disposables": {
        "straw": "true | false",
        "cutlery": "true | false",
        "serviettes": "true | false"
    },
    "customer": {
        "integration_id": "string",
        "full_name": "string",
        "email": "string",
        "dialing_code": "string",
        "cell_number": "string",
        "delivery_ddress": {
            "instructions": "string",
            "full_address": "string",
            "lon": "string",
            "lat": "string"
        }
    },
    "instructions": "string",
    "order_items": [
        {
            "integration_id": "string",
            "pos_code": "string",
            "pid": "string",
            "sku": "string",
            "title": "string",
            "price": 0,
            "quantity": 0,
            "instructions": "string",
            "tax_code": "string",
            "options": [
                {
                    "integration_id": "string",
                    "pos_code": "string",
                    "pid": "string",
                    "sku": "string",
                    "title": "string",
                    "price": 0,
                    "quantity": 0,
                    "instructions": "string",
                    "tax_code": "string"
                }
            ]
        }
    ],
    "payments": [
        {
            "payment_method": "string",
            "amount": 0,
            "reference": "string"
        }
    ],
    "discounts": [
        {
            "discount": 0,
            "reference": "string",
            "description": "string"
        }
    ]
}

Notes

  • The payload is automatically posted to the registered webhook URL.

  • It is triggered on order creation and on order status changes.

  • The receiving system should respond with HTTP 200 OK to acknowledge successful receipt.

  • Retries may occur if a non-2xx response is returned.

Last updated