Orders
Send product orders from catalogs directly to your internal systems using webhooks.
You can now connect your own webhook endpoint to receive real-time order data from your interactive catalogs. Just provide the URL of your webhook, and every time a customer submits an order inside one of your flipbooks, we’ll send the full order payload to your endpoint in JSON format.
Returned codes: when the webhook returns non 2xx codes, we will consider it a failed request and log the error message. Failed requests are found in the Webhook section of the Integrations page.
Restrictions
Only HTTPS endpoints are allowed
Max timeout: 10 seconds (typical)
Retry up to 5 times with exponential backoff
Disabled automatically after 5 failures
Webhook URL cannot require authentication
One webhook per workspace/account
Important attributes
Order JSON
type
String
The type of the event. Make sure you always check the value before processing data you received. For orders, the value should be "orders" (other values may be supported in the future).
order_id
String
The ID of the order as it is recorded in the Flipsnack back-end.
timestamp
Numeric
The timestamp value when the order was received.
datetime
Datetime
The UTC date and time the order was received by Flipsnack.
custom_fields
Object
A list of one or more custom fields required by the publisher for buyers to submit. Each field has a 'field_name' (string) and 'field_value' (string) property. Example:
{
"field_name": "Full name",
"field_value": "John Smith"
}items
Array
The list of items specified in the order. Each item is a separate object containing information like SKU, name or price.
total_price
Number
The total value of the order (if items contain price information).
currency
String
The currency used for items in the order. If items in the order do not have a price, the currency will not be specified.
Item JSON
sku
String
The SKU of the product, as specified in the product feed used by the catalog.
name
String
The name of the product. In case of product variations, it will contain the variations as well.
quantity
Number
The number of items ordered for a specific product.
discounted_price
Number
The discounted price of the product. If not specified, no discount was applied.
price
Number
The full price of the product. If not specified, the item does not have a price.
total
Number
The line item total (price × quantity). Calculated using discounted_price if available, otherwise price.
image
String
The URL of the product image.
Below is an example of the JSON structure sent for each order:
{
"type": "order",
"order_id": "1234567",
"timestamp": 1763108200,
"datetime": "2025-11-14 08:16:40",
"flipbook_hash": "tjsdsf9o7k",
"flipbook_title": "Summer catalog",
"custom_fields":
[
{
"field_name": "Email address",
"field_value": "[email protected]"
},
{
"field_name": "Full name",
"field_value": "John Smith"
}
],
"items":
[
{
"sku": "P001",
"name": "Scandinavian dining chair with light wood frame and soft fabric seat",
"quantity": 3,
"discounted_price": 232.99,
"price": 327.99,
"total": 698.97,
"image": "image_url"
},
{
"sku": "P003",
"name": "Modern dining chair with sleek metal frame and fabric upholstery",
"quantity": 1,
"discounted_price": 242.99,
"price": 283.99,
"total": 242.99,
"image": "image_url"
},
{
"sku": "P010",
"name": "Contemporary two-seater sofa with slim legs and plush cushions",
"quantity": 1,
"discounted_price": 112.99,
"price": 139.99,
"total": 112.99,
"image": "image_url"
},
{
"sku": "P002",
"name": "Minimalist sectional sofa with low-profile, modular design",
"quantity": 2,
"discounted_price": 115.99,
"price": 142.99,
"total": 231.98,
"image": "image_url"
}
],
"total": 1286.93,
"currency": "USD"
}Last updated