Skip to main content
WEBHOOK
ORDER_PLACED
{
  "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
  "webhookId": "00aa4abd-5778-4199-8161-0b49b2f212e5",
  "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
  "type": "ORDER_PLACED",
  "apiVersion": "V1",
  "createdAt": "2020-08-13T09:05:36.939+00:00",
  "testMode": false,
  "data": {
    "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
    "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
    "friendlyId": "D3XZFWPP",
    "checkoutId": "ch_BV44UYrXQA2T_Xcf1288tw",
    "email": "supporter@fourthwall.com",
    "emailMarketingOptIn": true,
    "message": "Sample message",
    "amounts": {
      "subtotal": {
        "value": 10,
        "currency": "USD"
      },
      "shipping": {
        "value": 10,
        "currency": "USD"
      },
      "tax": {
        "value": 10,
        "currency": "USD"
      },
      "donation": {
        "value": 10,
        "currency": "USD"
      },
      "discount": {
        "value": 10,
        "currency": "USD"
      },
      "giftCards": [
        {
          "code": "<string>",
          "amountUsed": {
            "value": 10,
            "currency": "USD"
          }
        }
      ],
      "total": {
        "value": 10,
        "currency": "USD"
      }
    },
    "offers": [
      {
        "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
        "name": "My t-shirt",
        "slug": "my-t-shirt",
        "description": "My t-shirt description",
        "variant": {
          "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
          "name": "My t-shirt - Black, L",
          "sku": "WDEK-DRE200L",
          "unitPrice": {
            "value": 10,
            "currency": "USD"
          },
          "attributes": {
            "description": "Black, L"
          },
          "quantity": 5,
          "price": {
            "value": 10,
            "currency": "USD"
          },
          "weight": {
            "value": 1,
            "unit": "kg"
          },
          "dimensions": {
            "length": 1,
            "width": 2,
            "height": 3,
            "unit": "cm"
          }
        }
      }
    ],
    "source": {
      "type": "<string>",
      "giftId": "gft_EdJvIXu3SEiXe_QkPavHSA"
    },
    "createdAt": "2020-08-13T09:05:36.939Z",
    "updatedAt": "2020-08-13T09:05:36.939Z",
    "promotionId": "prm_EdJvIXu3SEiXe_QkPavHSA",
    "username": "Johnny123",
    "trackingParams": {
      "fbc": "<string>",
      "fbp": "<string>",
      "utm_source": "<string>",
      "utm_medium": "<string>",
      "utm_campaign": "<string>",
      "utm_content": "<string>",
      "utm_term": "<string>"
    },
    "metadata": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.fourthwall.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
​
id
string
required

Unique identifier for this webhook event

Example:

"00aa4abd-5778-4199-8161-0b49b2f212e5"

​
webhookId
string
required

ID of the webhook configuration that triggered this event

Example:

"00aa4abd-5778-4199-8161-0b49b2f212e5"

​
shopId
string
required

ID of the shop that generated this event

Example:

"sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb"

​
type
string
required

The event type

Example:

"ORDER_PLACED"

​
apiVersion
string
required

API version of the webhook payload

Example:

"V1"

​
createdAt
string<date-time>
required

When this event was created

Example:

"2020-08-13T09:05:36.939+00:00"

​
testMode
any
required

Whether this event was sent in test mode

Example:

false

​
data
Order · object
required

Response

200

Event received successfully