v2

latestOpenAPI 3.1.02026-07-26102336742.6 KB
Order Events

Order Updated

Fired when an order's status, shipping address, or email is updated.

postWebhookORDER_UPDATED

Payload

idstring required

Unique identifier for this webhook event

webhookIdstring required

ID of the webhook configuration that triggered this event

shopIdstring required

ID of the shop that generated this event

typestring required

The event type

apiVersionstring required

API version of the webhook payload

createdAtstring date-time required

When this event was created

testModeboolean required

Whether this event was sent in test mode

Example payload

{
  "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
  "webhookId": "00aa4abd-5778-4199-8161-0b49b2f212e5",
  "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
  "type": "ORDER_UPDATED",
  "apiVersion": "V1",
  "createdAt": "2020-08-13T09:05:36.939+00:00",
  "data": {
    "order": {
      "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
      "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
      "friendlyId": "D3XZFWPP",
      "checkoutId": "ch_BV44UYrXQA2T_Xcf1288tw",
      "promotionId": "prm_EdJvIXu3SEiXe_QkPavHSA",
      "email": "supporter@fourthwall.com",
      "username": "Johnny123",
      "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": [
          {
            "amountUsed": {
              "value": 10,
              "currency": "USD"
            }
          }
        ],
        "total": {
          "value": 10,
          "currency": "USD"
        }
      },
      "billing": {
        "address": {
          "name": "Joe Doe",
          "address1": "Main Street 1",
          "city": "San Francisco",
          "state": "CA",
          "country": "US",
          "zip": "12345",
          "phone": "123456789"
        }
      },
      "shipping": {
        "address": {
          "name": "Joe Doe",
          "address1": "Main Street 1",
          "city": "San Francisco",
          "state": "CA",
          "country": "US",
          "zip": "12345",
          "phone": "123456789"
        }
      },
      "offers": [
        {
          "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
          "name": "My t-shirt",
          "slug": "my-t-shirt",
          "description": "My t-shirt description",
          "primaryImage": {
            "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
            "url": "https://fourthwall.com/image.png",
            "width": 800,
            "height": 600,
            "transformedUrl": "https://fourthwall.com/image.png"
          },
          "variant": {
            "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
            "name": "My t-shirt - Black, L",
            "sku": "WDEK-DRE200L",
            "unitPrice": {
              "value": 10,
              "currency": "USD"
            },
            "unitCost": {
              "value": 10,
              "currency": "USD"
            },
            "compareAtPrice": {
              "value": 10,
              "currency": "USD"
            },
            "attributes": {
              "description": "Black, L",
              "color": {
                "name": "Black",
                "swatch": "#000000"
              },
              "size": {
                "name": "L"
              }
            },
            "quantity": 5,
            "price": {
              "value": 10,
              "currency": "USD"
            },
            "cost": {
              "value": 10,
              "currency": "USD"
            },
            "weight": {
              "value": 1,
              "unit": "kg"
            },
            "dimensions": {
              "length": 1,
              "width": 2,
              "height": 3,
              "unit": "cm"
            }
          }
        }
      ],
      "source": {
        "giftId": "gft_EdJvIXu3SEiXe_QkPavHSA"
      },
      "createdAt": "2020-08-13T09:05:36.939Z",
      "updatedAt": "2020-08-13T09:05:36.939Z"
    }
  }
}

Response

Event received successfully