API Documentation
Transactions
Webhooks
Transaction completed webhook
WEBHOOK
transactionCompleted
Copy
Ask AI
{
"transactionId": "<string>",
"externalCustomerId": "<string>",
"externalTransactionId": "<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": {
"street": "<string>",
"city": "<string>",
"state": "AL",
"zipCode": "<string>",
"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 a transaction is completed
Response
200
Webhook received successfully
Copy
Ask AI
{
"transactionId": "<string>",
"externalCustomerId": "<string>",
"externalTransactionId": "<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": {
"street": "<string>",
"city": "<string>",
"state": "AL",
"zipCode": "<string>",
"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
}
}
Assistant
Responses are generated using AI and may contain mistakes.