YOM Docs

• Integration guides
  • Integration methods
    • API integration
    • File integration
  • Entities
    • Categories
    • Distribution Center
    • Commerces
    • Loaned Equipment
    • Delivery cost
    • Credit
    • Tax Documents
    • Discount limit
    • Payments
    • Products
    • Promotions
    • Segments
    • Overrides
    • Stock
    • Supervisors
    • Transactions
    • Sellers
  • Webhooks
    • Technical requirements
    • Customer-to-YOM Webhooks
      • Order modification
      • Bulk stock upload
      • Bulk order modification
    • YOM-to-customer Webhooks
      • Orders
      • Payments
      • Minimum order
      • Delivery price
      • Returns
      • Loaned Equipment
      • Commerce creation
  • Changelog
  • Recommendations Extraction API
    • Authentication
    • Recommendations
    • Best practices
• Settings

Available YOM-to-Customer Events

This section describes the calls that YOM sends to the customer's systems. Unlike the previous section, here it is YOM that initiates the communication: every time a relevant event occurs on the platform, YOM makes an HTTP POST request to the endpoint that the customer exposes.

The events currently notified are order.created, order.updated, payment.created, and payment.updated, along with the return requests and loaned equipment requests submitted by sellers and commerces. In addition, YOM can query the customer synchronously to validate the minimum order and to calculate the delivery cost before creating an order.

<aside> ⚙️

The receiving endpoint, authentication, data format, and retry policy are described in Technical requirements

</aside>

Pages

• Orders — structure of the Order entity and the order.created and order.updated events.
• Payments — structure of the Payment entity and the payment.created and payment.updated events.
• Minimum order — synchronous validation of an order's minimum amount before creating it.
• Delivery price — synchronous calculation of an order's delivery cost.
• ‣ — structure of the Return request, how it is sent to the customer's system, and the webhook with the review result.
• ‣ — structure of the Loaned equipment request and how it is sent to the customer's system, both on creation and on each modification.

Previous steps

<aside> <img src="/icons/arrow-left_gray.svg" alt="/icons/arrow-left_gray.svg" width="40px" />

Bulk order modification

</aside>

Next steps

<aside> <img src="/icons/arrow-right_gray.svg" alt="/icons/arrow-right_gray.svg" width="40px" />

Orders

</aside>

Table of contents