Webhook order action - OgnianApostolov/builderly-api-docs GitHub Wiki

Model

OrderWebhook order_webook: {
    "firstname": {
        "type": "string",
        "required": "true"
    },
    "lastname": {
        "type": "string",
        "required": "true"
    },
    "email": {
        "type": "string",
        "required": "true"
    },
    "phone_number": {
        "type": "string",
        "required": "true"
    },
    "address": {
        "type": "string",
        "required": "true"
    },
    "city": {
        "type": "string",
        "required": "true"
    },
    "state": {
        "type": "string"
    },
    "country": {
        "type": "string",
        "required": "true"
    },
    "zip_code": {
        "type": "string",
        "required": "true"
    },
    "notes": {
        "type": "string",
        "required": "true"
    },
    "organization_name": {
        "type": "string"
    },
    "tax_identification_number": {
        "type": "string",
        "required": "true"
    },
    "lifetime_value": {
        "type": "number",
        "required": "true"
    },
    "addToNewletter": {
        "type": "string",
        "required": "true"
    },
    "value": {
        "type": "number",
        "required": "true"
    },
    "shipping_cost": {
        "type": "number",
        "required": "true"
    },
    "product_reference_ids": {
        "type": "string",
        "required": "true"
    },
    "vendor": {
        "type": "string",
        "required": "true"
    },
    "product_titles": {
        "type": "string",
        "required": "true"
    },
    "product_titles_variants": {
        "type": "string",
        "required": "true"
    },
    "product_prices": {
        "type": "string",
        "required": "true"
    },
    "product_quantities": {
        "type": "string",
        "required": "true"
    },
    "currency": {
        "type": "string",
        "required": "true"
    },
    "reference_id": {
        "type": "string",
        "required": "true"
    }
}

Method

Create new

POST 'https://{{your-builderly-domain}}/webhook/order' req.body required

method: 'POST'
{
    url: 'https://{{your-builderly-domain}}/webhook/order',
    headers: {
        'X-API-KEY': api_key
    },
    json: true,
    body: webhook_order
}

Responses Success - status 201

{ }

Error - status 400

{
    error_message
}