{ "applied_vouchers": { "id": "Unique identifier for the order voucher.", "voucher": { "expires_on": "The date when the voucher expires.", "id": "Unique identifier for the voucher.", "redeemed_at": "When the Voucher was redeemed.", "services": { "category": { "id": "Unique identifier for the service category.", "name": "Name of the service category." }, "created_at": "The date and time when the service was created.", "description": "Description of the service.", "id": "Unique identifier for the service.", "is_active": "Whether the service is active.", "name": "Name of the service.", "updated_at": "The date and time when the service was last updated." } } }, "client": { "email_address": "Client's email address.", "first_name": "Client's first name.", "id": "Unique identifier for the client in the Boulevard system.", "last_name": "Client's last name.", "phone_number": "Client's mobile phone number." }, "closed_at": "The date and time when the order was closed.", "closed_by": { "email_address": "Email address of the staff member.", "first_name": "First name of the staff member.", "id": "Unique identifier for the staff member.", "last_name": "Last name of the staff member.", "phone_number": "Mobile phone number of the staff member.", "role_name": "Name of the staff member's role." }, "created_at": "The date and time when the order was created.", "fee_lines": { "absolute_amount_cents": "Absolute amount for the fee in cents. Null if percentage_amount is set.", "calculated_amount_cents": "Current calculated amount for the fee in cents.", "calculated_tax_amount_cents": "Current calculated tax amount for the fee in cents.", "id": "Unique identifier for the fee line.", "label": "Human-readable fee label.", "percentage_amount": "Percentage amount for the fee. Null if absolute_amount_cents is set.", "refunds": { "id": "Unique identifier for the fee line refund.", "order_refund_id": "ID of the order refund the fee was refunded on.", "refund_amount_cents": "Amount of the fee refunded in cents.", "refunded_at": "When the fee was refunded." }, "type": "Machine-readable fee type." }, "id": "Unique identifier for the order in the Boulevard system.", "line_groups": { "id": "Unique identifier for the line group.", "lines": { "current_discount_amount_cents": "Current discount amount in cents.", "current_price_cents": "Current price in cents.", "current_subtotal_cents": "Current subtotal in cents.", "discounts": { "description": "Description of the discount.", "discount_amount_cents": "Discount amount in cents.", "discount_percentage": "Discount percentage, if applicable.", "discount_reason": { "id": "Unique identifier for the discount reason.", "is_hidden": "Whether the discount reason is hidden.", "name": "Name of the discount reason." }, "id": "Unique identifier for the discount." }, "id": "Unique identifier for the order line.", "initial_discount_amount_cents": "Initial discount amount in cents.", "initial_price_cents": "Initial price in cents.", "initial_subtotal_cents": "Initial subtotal in cents.", "quantity": "Quantity of the item." } }, "location": { "address": { "city": "City of the Address", "country": "Country for the Address.", "line1": "Line 1 of the Address", "line2": "Line 2 of the Address", "province": "Province of the Address.", "state": "State of the Address.", "zip_code": "Zip (postal) code for the Address." }, "external_id": "External identifier for the location.", "id": "Unique identifier for the location.", "is_remote": "Indicates that the location is a remote location, and that appointments for this location are carried out remotely.", "name": "Name of the location.", "timezone": "Timezone associated with the location." }, "note": "An optional note tied to the order.", "number": "Unique order number for the business.", "payment_groups": { "id": "Unique identifier for the payment group.", "is_independent_merchant": "Whether this is an independent merchant.", "merchant_id": "ID of the merchant.", "merchant_name": "Name of the merchant.", "payments": { "id": "Unique identifier for the payment.", "merchant_id": "ID of the merchant.", "order_id": "ID of the order.", "paid_amount_cents": "Amount paid in cents.", "payment_method_label": "Human-readable label for the payment method.", "refund_amount_cents": "The total amount refunded, if any, in cents.", "refunds": { "id": "Unique identifier for the payment refund.", "is_full_refund": "Whether this is a full refund.", "refund_amount_cents": "Amount refunded in cents.", "refund_id": "ID of the refund.", "refunded_at": "When the refund was processed." } }, "total_cents": "Total amount for this payment group in cents.", "total_fees_cents": "Total fees for this payment group in cents.", "total_paid_cents": "Total paid for this payment group in cents.", "total_unpaid_cents": "Total unpaid for this payment group in cents." }, "refunds": { "closed_at": "When the refund was closed.", "closed_by": { "email_address": "Email address of the staff member.", "first_name": "First name of the staff member.", "id": "Unique identifier for the staff member.", "last_name": "Last name of the staff member.", "phone_number": "Mobile phone number of the staff member.", "role_name": "Name of the staff member's role." }, "created_at": "The date and time when the order refund was created.", "id": "Unique identifier for the order refund.", "number": "Refund number.", "payments": { "id": "Unique identifier for the refund payment.", "order_payment_id": "When this payment is one of the original payments on the order, this ID is present and can be used to read more information on the payment.", "refund_amount_cents": "Total amount to be refunded to this payment method, including any tax, in cents.", "refund_limit_cents": "Maximum amount that can be refunded to this payment method in cents." }, "refund_reason": "Value that describes why this refund was made. When the reason is OTHER, refund_reason_text should also be set.", "refund_reason_text": "Additional description, usually available when the refund reason is OTHER.", "status": "Closed status of the refund.", "summary": { "refund_amount_cents": "Total refund amount in cents.", "refund_tax_cents": "Refund tax amount in cents.", "refund_total_cents": "Total refund including tax in cents." }, "updated_at": "The date and time when the order refund was last updated." }, "summary": { "current_discount_amount_cents": "Current discount amount in cents.", "current_fee_amount_cents": "Current fee amount in cents.", "current_gratuity_amount_cents": "Current gratuity amount in cents.", "current_subtotal_cents": "Current subtotal in cents.", "current_tax_amount_cents": "Current tax amount in cents.", "current_total_cents": "Current total amount in cents.", "initial_discount_amount_cents": "Initial discount amount in cents.", "initial_fee_amount_cents": "Initial fee amount in cents.", "initial_gratuity_amount_cents": "Initial gratuity amount in cents.", "initial_subtotal_cents": "Initial subtotal in cents.", "initial_tax_amount_cents": "Initial tax amount in cents.", "initial_total_cents": "Initial total amount in cents.", "refund_amount_cents": "Total refund amount in cents." }, "updated_at": "The date and time when the order was last updated."}
Boulevard
Order
Event payload details and trigger documentation for Order data from Boulevard
{ "applied_vouchers": { "id": "Unique identifier for the order voucher.", "voucher": { "expires_on": "The date when the voucher expires.", "id": "Unique identifier for the voucher.", "redeemed_at": "When the Voucher was redeemed.", "services": { "category": { "id": "Unique identifier for the service category.", "name": "Name of the service category." }, "created_at": "The date and time when the service was created.", "description": "Description of the service.", "id": "Unique identifier for the service.", "is_active": "Whether the service is active.", "name": "Name of the service.", "updated_at": "The date and time when the service was last updated." } } }, "client": { "email_address": "Client's email address.", "first_name": "Client's first name.", "id": "Unique identifier for the client in the Boulevard system.", "last_name": "Client's last name.", "phone_number": "Client's mobile phone number." }, "closed_at": "The date and time when the order was closed.", "closed_by": { "email_address": "Email address of the staff member.", "first_name": "First name of the staff member.", "id": "Unique identifier for the staff member.", "last_name": "Last name of the staff member.", "phone_number": "Mobile phone number of the staff member.", "role_name": "Name of the staff member's role." }, "created_at": "The date and time when the order was created.", "fee_lines": { "absolute_amount_cents": "Absolute amount for the fee in cents. Null if percentage_amount is set.", "calculated_amount_cents": "Current calculated amount for the fee in cents.", "calculated_tax_amount_cents": "Current calculated tax amount for the fee in cents.", "id": "Unique identifier for the fee line.", "label": "Human-readable fee label.", "percentage_amount": "Percentage amount for the fee. Null if absolute_amount_cents is set.", "refunds": { "id": "Unique identifier for the fee line refund.", "order_refund_id": "ID of the order refund the fee was refunded on.", "refund_amount_cents": "Amount of the fee refunded in cents.", "refunded_at": "When the fee was refunded." }, "type": "Machine-readable fee type." }, "id": "Unique identifier for the order in the Boulevard system.", "line_groups": { "id": "Unique identifier for the line group.", "lines": { "current_discount_amount_cents": "Current discount amount in cents.", "current_price_cents": "Current price in cents.", "current_subtotal_cents": "Current subtotal in cents.", "discounts": { "description": "Description of the discount.", "discount_amount_cents": "Discount amount in cents.", "discount_percentage": "Discount percentage, if applicable.", "discount_reason": { "id": "Unique identifier for the discount reason.", "is_hidden": "Whether the discount reason is hidden.", "name": "Name of the discount reason." }, "id": "Unique identifier for the discount." }, "id": "Unique identifier for the order line.", "initial_discount_amount_cents": "Initial discount amount in cents.", "initial_price_cents": "Initial price in cents.", "initial_subtotal_cents": "Initial subtotal in cents.", "quantity": "Quantity of the item." } }, "location": { "address": { "city": "City of the Address", "country": "Country for the Address.", "line1": "Line 1 of the Address", "line2": "Line 2 of the Address", "province": "Province of the Address.", "state": "State of the Address.", "zip_code": "Zip (postal) code for the Address." }, "external_id": "External identifier for the location.", "id": "Unique identifier for the location.", "is_remote": "Indicates that the location is a remote location, and that appointments for this location are carried out remotely.", "name": "Name of the location.", "timezone": "Timezone associated with the location." }, "note": "An optional note tied to the order.", "number": "Unique order number for the business.", "payment_groups": { "id": "Unique identifier for the payment group.", "is_independent_merchant": "Whether this is an independent merchant.", "merchant_id": "ID of the merchant.", "merchant_name": "Name of the merchant.", "payments": { "id": "Unique identifier for the payment.", "merchant_id": "ID of the merchant.", "order_id": "ID of the order.", "paid_amount_cents": "Amount paid in cents.", "payment_method_label": "Human-readable label for the payment method.", "refund_amount_cents": "The total amount refunded, if any, in cents.", "refunds": { "id": "Unique identifier for the payment refund.", "is_full_refund": "Whether this is a full refund.", "refund_amount_cents": "Amount refunded in cents.", "refund_id": "ID of the refund.", "refunded_at": "When the refund was processed." } }, "total_cents": "Total amount for this payment group in cents.", "total_fees_cents": "Total fees for this payment group in cents.", "total_paid_cents": "Total paid for this payment group in cents.", "total_unpaid_cents": "Total unpaid for this payment group in cents." }, "refunds": { "closed_at": "When the refund was closed.", "closed_by": { "email_address": "Email address of the staff member.", "first_name": "First name of the staff member.", "id": "Unique identifier for the staff member.", "last_name": "Last name of the staff member.", "phone_number": "Mobile phone number of the staff member.", "role_name": "Name of the staff member's role." }, "created_at": "The date and time when the order refund was created.", "id": "Unique identifier for the order refund.", "number": "Refund number.", "payments": { "id": "Unique identifier for the refund payment.", "order_payment_id": "When this payment is one of the original payments on the order, this ID is present and can be used to read more information on the payment.", "refund_amount_cents": "Total amount to be refunded to this payment method, including any tax, in cents.", "refund_limit_cents": "Maximum amount that can be refunded to this payment method in cents." }, "refund_reason": "Value that describes why this refund was made. When the reason is OTHER, refund_reason_text should also be set.", "refund_reason_text": "Additional description, usually available when the refund reason is OTHER.", "status": "Closed status of the refund.", "summary": { "refund_amount_cents": "Total refund amount in cents.", "refund_tax_cents": "Refund tax amount in cents.", "refund_total_cents": "Total refund including tax in cents." }, "updated_at": "The date and time when the order refund was last updated." }, "summary": { "current_discount_amount_cents": "Current discount amount in cents.", "current_fee_amount_cents": "Current fee amount in cents.", "current_gratuity_amount_cents": "Current gratuity amount in cents.", "current_subtotal_cents": "Current subtotal in cents.", "current_tax_amount_cents": "Current tax amount in cents.", "current_total_cents": "Current total amount in cents.", "initial_discount_amount_cents": "Initial discount amount in cents.", "initial_fee_amount_cents": "Initial fee amount in cents.", "initial_gratuity_amount_cents": "Initial gratuity amount in cents.", "initial_subtotal_cents": "Initial subtotal in cents.", "initial_tax_amount_cents": "Initial tax amount in cents.", "initial_total_cents": "Initial total amount in cents.", "refund_amount_cents": "Total refund amount in cents." }, "updated_at": "The date and time when the order was last updated."}
Events
Triggering Webhook Types
The following event types are associated with the Order event payload from Boulevard.
{ "applied_vouchers": { "id": "Unique identifier for the order voucher.", "voucher": { "expires_on": "The date when the voucher expires.", "id": "Unique identifier for the voucher.", "redeemed_at": "When the Voucher was redeemed.", "services": { "category": { "id": "Unique identifier for the service category.", "name": "Name of the service category." }, "created_at": "The date and time when the service was created.", "description": "Description of the service.", "id": "Unique identifier for the service.", "is_active": "Whether the service is active.", "name": "Name of the service.", "updated_at": "The date and time when the service was last updated." } } }, "client": { "email_address": "Client's email address.", "first_name": "Client's first name.", "id": "Unique identifier for the client in the Boulevard system.", "last_name": "Client's last name.", "phone_number": "Client's mobile phone number." }, "closed_at": "The date and time when the order was closed.", "closed_by": { "email_address": "Email address of the staff member.", "first_name": "First name of the staff member.", "id": "Unique identifier for the staff member.", "last_name": "Last name of the staff member.", "phone_number": "Mobile phone number of the staff member.", "role_name": "Name of the staff member's role." }, "created_at": "The date and time when the order was created.", "fee_lines": { "absolute_amount_cents": "Absolute amount for the fee in cents. Null if percentage_amount is set.", "calculated_amount_cents": "Current calculated amount for the fee in cents.", "calculated_tax_amount_cents": "Current calculated tax amount for the fee in cents.", "id": "Unique identifier for the fee line.", "label": "Human-readable fee label.", "percentage_amount": "Percentage amount for the fee. Null if absolute_amount_cents is set.", "refunds": { "id": "Unique identifier for the fee line refund.", "order_refund_id": "ID of the order refund the fee was refunded on.", "refund_amount_cents": "Amount of the fee refunded in cents.", "refunded_at": "When the fee was refunded." }, "type": "Machine-readable fee type." }, "id": "Unique identifier for the order in the Boulevard system.", "line_groups": { "id": "Unique identifier for the line group.", "lines": { "current_discount_amount_cents": "Current discount amount in cents.", "current_price_cents": "Current price in cents.", "current_subtotal_cents": "Current subtotal in cents.", "discounts": { "description": "Description of the discount.", "discount_amount_cents": "Discount amount in cents.", "discount_percentage": "Discount percentage, if applicable.", "discount_reason": { "id": "Unique identifier for the discount reason.", "is_hidden": "Whether the discount reason is hidden.", "name": "Name of the discount reason." }, "id": "Unique identifier for the discount." }, "id": "Unique identifier for the order line.", "initial_discount_amount_cents": "Initial discount amount in cents.", "initial_price_cents": "Initial price in cents.", "initial_subtotal_cents": "Initial subtotal in cents.", "quantity": "Quantity of the item." } }, "location": { "address": { "city": "City of the Address", "country": "Country for the Address.", "line1": "Line 1 of the Address", "line2": "Line 2 of the Address", "province": "Province of the Address.", "state": "State of the Address.", "zip_code": "Zip (postal) code for the Address." }, "external_id": "External identifier for the location.", "id": "Unique identifier for the location.", "is_remote": "Indicates that the location is a remote location, and that appointments for this location are carried out remotely.", "name": "Name of the location.", "timezone": "Timezone associated with the location." }, "note": "An optional note tied to the order.", "number": "Unique order number for the business.", "payment_groups": { "id": "Unique identifier for the payment group.", "is_independent_merchant": "Whether this is an independent merchant.", "merchant_id": "ID of the merchant.", "merchant_name": "Name of the merchant.", "payments": { "id": "Unique identifier for the payment.", "merchant_id": "ID of the merchant.", "order_id": "ID of the order.", "paid_amount_cents": "Amount paid in cents.", "payment_method_label": "Human-readable label for the payment method.", "refund_amount_cents": "The total amount refunded, if any, in cents.", "refunds": { "id": "Unique identifier for the payment refund.", "is_full_refund": "Whether this is a full refund.", "refund_amount_cents": "Amount refunded in cents.", "refund_id": "ID of the refund.", "refunded_at": "When the refund was processed." } }, "total_cents": "Total amount for this payment group in cents.", "total_fees_cents": "Total fees for this payment group in cents.", "total_paid_cents": "Total paid for this payment group in cents.", "total_unpaid_cents": "Total unpaid for this payment group in cents." }, "refunds": { "closed_at": "When the refund was closed.", "closed_by": { "email_address": "Email address of the staff member.", "first_name": "First name of the staff member.", "id": "Unique identifier for the staff member.", "last_name": "Last name of the staff member.", "phone_number": "Mobile phone number of the staff member.", "role_name": "Name of the staff member's role." }, "created_at": "The date and time when the order refund was created.", "id": "Unique identifier for the order refund.", "number": "Refund number.", "payments": { "id": "Unique identifier for the refund payment.", "order_payment_id": "When this payment is one of the original payments on the order, this ID is present and can be used to read more information on the payment.", "refund_amount_cents": "Total amount to be refunded to this payment method, including any tax, in cents.", "refund_limit_cents": "Maximum amount that can be refunded to this payment method in cents." }, "refund_reason": "Value that describes why this refund was made. When the reason is OTHER, refund_reason_text should also be set.", "refund_reason_text": "Additional description, usually available when the refund reason is OTHER.", "status": "Closed status of the refund.", "summary": { "refund_amount_cents": "Total refund amount in cents.", "refund_tax_cents": "Refund tax amount in cents.", "refund_total_cents": "Total refund including tax in cents." }, "updated_at": "The date and time when the order refund was last updated." }, "summary": { "current_discount_amount_cents": "Current discount amount in cents.", "current_fee_amount_cents": "Current fee amount in cents.", "current_gratuity_amount_cents": "Current gratuity amount in cents.", "current_subtotal_cents": "Current subtotal in cents.", "current_tax_amount_cents": "Current tax amount in cents.", "current_total_cents": "Current total amount in cents.", "initial_discount_amount_cents": "Initial discount amount in cents.", "initial_fee_amount_cents": "Initial fee amount in cents.", "initial_gratuity_amount_cents": "Initial gratuity amount in cents.", "initial_subtotal_cents": "Initial subtotal in cents.", "initial_tax_amount_cents": "Initial tax amount in cents.", "initial_total_cents": "Initial total amount in cents.", "refund_amount_cents": "Total refund amount in cents." }, "updated_at": "The date and time when the order was last updated."}
Payload Field Details
Event Payload
Hide fields
string
required
ID Unique identifier for the order in the Boulevard system.