POS Order

This documentation explains the POS Order webhook.

Overview

The POS Order webhook is designed to notify your system whenever key events occur during in-person (Point of Sale) orders. This webhook helps keep your systems synchronized by sending real-time updates about various actions such as order checkout, payment, and product cancellations for orders placed via POS.

Triggers

The following triggers are available for the POS Order webhook:

1. CheckoutOrder: Triggered when an in-person order is checked out.

2. PaymentOrder: Triggered when the payment for a POS order is successfully processed.

3. CancelProduct: Triggered when a product in a POS order is canceled.

Payload Format

When a trigger is activated, a payload is sent to your configured endpoint. The payload includes critical details about the event, such as information about the shop, the order (basket), the user, and the customer involved in the transaction.

Payload Parameters:

• event: "PosOrder" — Identifies the event type as related to POS orders.

• action: Defines the specific action that triggered the webhook (e.g., CheckoutOrder, PaymentOrder, CancelProduct).

• shop: Contains details about the shop where the event occurred:

  • id: The unique ID of the shop.

  • name: The name of the shop.

  • title: The title or brand of the shop.

  • domain: The shop's domain or URL.

• basket: Provides information about the order basket, which includes details of the products, quantities, and pricing.

• user: Contains details about the user making the POS order, including:

  • id: The user’s ID.

  • name: The user’s name.

  • email: The user's email (or null if not available).

  • phone: The user’s phone number (or null if not available).

• customer: Contains details about the customer associated with the order. This can either be an object or null, depending on the availability of customer data.

Benefits

• Real-time synchronization: Ensures your systems are updated immediately when significant events occur during POS orders.

• Detailed data: Provides comprehensive data about the shop, order, user, and customer to help automate workflows and streamline POS management.