YOM Docs

Loaned Equipment

YOM notifies the customer's system of every loaned equipment request that sellers record from the app or that commerces record from the B2B platform. Loaned equipment is a unit the customer lends to the commerce — a freezer, a refrigerator, a display cooler —, and the request is the form used to ask for that delivery.

When the request is recorded, and every time it is modified afterward, YOM sends an HTTP POST call to the customer's endpoint with the Commerce details and the form answers.

The same endpoint receives both new requests and modifications. Every message carries the request identifier in comodatoId, and the customer's system must treat it as an upsert: record the request if this is the first time it sees that identifier, or replace it if it already knows it.

<aside> ⚙️

The loaned equipment module is enabled per customer from YOM. To activate it, you must give YOM the receiving endpoint URL and the credentials YOM must use to authenticate against it. The general authentication and format requirements are in Technical requirements

</aside>

When YOM calls it

<aside> ⚠️

Requests that the customer itself bulk-loads into YOM do not trigger any call. Sending them back would duplicate in the ERP what the customer just submitted.

</aside>

<aside> ℹ️

The loaned equipment form is configurable per customer: the fields, their options, and whether they are required are defined in YOM. That is why the content of responses changes from one customer to another, and this document describes the shape of each answer, not the list of questions.

</aside>

Endpoint

POST <tu_dominio>/webhooks/yom/comodatos

Request body

{
  "eventType": "created",
  "comodatoId": "66f0a1b2c3d4e5f6a7b8c9d0",
  "externalId": "COM-000123",
  "commerce": { ... },
  "responses": [ ... ]
}

Fields

Loaned equipment request

The message body.

Field Type Requirement Description Examples
eventType 📝 Text 🟢 Required What triggered the call.
"created" → the request has just been recorded
"updated" → the answers of an already-sent request were modified "created"
comodatoId 📝 Text 🟢 Required Unique identifier of the Loaned equipment request in YOM. It is the upsert key: it never changes and is the same on creation and on every later modification. "66f0a1b2c3d4e5f6a7b8c9d0"
externalId 📝 Text ⚪ Optional Code of the Request in the customer's system. It is only sent for requests the customer itself loaded into YOM; those recorded by a seller or a commerce have none. "COM-000123"
commerce 📝 Object → Commerce 🟢 Required The complete Commerce that receives the equipment. Its code in the customer's system is in contact.externalId. See details below.
responses 🔡 List of Objects → Response 🟢 Required The form answers. See details below.

Response

Each answer in responses. The list arrives in the same order as the form on screen and contains only the visible fields that were answered: unanswered optional fields and those hidden by the form's conditional logic are not sent.

| --- | --- | --- | --- | --- |