Avocado Order

This documentation covers the custom Avocado order workflow, explaining the different triggers and the payload structure.

Overview

The Avocado Order webhook is triggered when significant events occur in the unique Avocado ordering process within Selldone. Unlike typical orders, the Avocado form allows customers to create a list of items they wish to order by providing descriptions, links, and images without pre-set products in the store. Once the customer submits their list, the seller reviews the request, sets a price, and sends it back to the customer for payment. This webhook helps ensure real-time updates for each step in this custom order process.

Triggers

The following triggers are available for the Avocado Order webhook:

1. CheckoutOrder: Triggered when the Avocado order is submitted by the customer.

2. PaymentOrder: Triggered when the customer completes the payment after the seller has set the price.

3. CancelProduct: Triggered when an item in the Avocado order is canceled.

Payload Format

When one of these triggers is activated, a POST request is sent to your specified endpoint with a payload that includes essential details about the Avocado order, such as the shop, order (basket), user, and customer.

Payload Parameters:

• event: "AvocadoOrder" — Identifies the event type as related to Avocado 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 custom Avocado order, which includes details such as the items submitted by the customer, descriptions, and any images or links provided.

• user: Contains details about the user who submitted the Avocado 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

• Custom Order Workflow: The Avocado order system provides a flexible, customer-driven order submission process, enabling buyers to request personalized items.

• Real-time updates: Receive immediate notifications for order submission, price setting, payment, and cancellations.

• Comprehensive Data: Includes all necessary information to track and process Avocado orders efficiently.