Skip to main content
WEBHOOK
order.completed
{
  "orderId": "<string>",
  "externalCustomerId": "<string>",
  "externalOrderId": "<string>",
  "items": [
    {
      "description": "<string>",
      "id": "<string>",
      "paddedPrice": 123,
      "photoUrl": "<string>",
      "price": 123,
      "quantity": 123,
      "snapEligible": true,
      "taxRate": 123,
      "unit": "COUNT"
    }
  ],
  "subtotalAmount": 123,
  "shippingAmount": 123,
  "totalAmount": 123,
  "shippingAddress": {
    "address1": "<string>",
    "address2": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "state": "AL",
    "country": "US"
  },
  "deliveryPickupDetails": {
    "type": "DELIVERY",
    "scheduledTime": "2023-11-07T05:31:56Z",
    "instructions": "<string>"
  },
  "completedAt": "2023-11-07T05:31:56Z",
  "allocatedAmounts": {
    "bankCardAmount": 123,
    "ebtCashAmount": 123,
    "snapAmount": 123
  }
}

Body

application/json

Webhook payload sent when an order is completed

orderId
string
required

Unique identifier of the order

items
object[]
required

List of items in the completed order

subtotalAmount
integer
required

Subtotal amount before tax and shipping (in cents)

totalAmount
integer
required

Total amount including tax and shipping (in cents)

completedAt
string<date-time>
required

Timestamp when the order was completed

externalCustomerId
string

External customer identifier

externalOrderId
string

External order identifier

shippingAmount
integer

Shipping amount (in cents)

shippingAddress
object

Shipping address for the order

deliveryPickupDetails
object

Delivery or pickup details for the order

allocatedAmounts
object

Final payment allocation for the order

Response

Webhook received successfully

I