YOM Docs

The first step to start working with YOM is to register your commerces.

Who are the commerces? The customers in YOM are the commerces to whom you offer your products.

These commerces are represented by the Commerce entity. A Commerce holds the information for each commerce, its associated users, and its sales logic. Commerces in YOM represent a business entity you interact with for various operations, such as orders and product management.

Endpoint

The Commerces endpoint lets YOM access detailed information about each registered commerce.

GET /api/commerces

FILE <fecha>_<hora>_commerce.csv

Fields

The following table defines the base integration model for the Commerce entity. This model is the base contract.

Commerce

Field Type Requirement Description Examples
commerceId 📝 Text 🟢 Required Unique identifier of the Commerce. “12345”
globalCommerceId 📝 Text ⚪ Optional RUT / CI of the Commerce. "76.345.678-9"
name 📝 Text 🟢 Required Name of the Commerce. "Panadería Don Carlos"
email 📝 Text ⚪ Optional Email address of the Commerce "[email protected]"
phone 📝 Text ⚪ Optional Phone number of the Commerce “+5691231233”
class 📝 Text 🟢 Required Category of the Commerce. “Panadería”
locations 🔠 List of Objects → Commerces 🟢 Required Locations of the Commerce. [{"address": "Avenida Apoquindo 123, Departamento 456, Las Condes", "commune": "Las Condes", "city": "Santiago", "region": "Región Metropolitana","country": "Chile"}]
createdDate 📅 Date 🟢 Required Creation date of the Commerce.
*\*The date must be in ISO 8601 format.
*It is the date on which the Commerce began working with the customer, *not the date on which it is uploaded to YOM. “2023-04-27”
“2018-10-22T00:00:00.000Z”
isInactive 🔘 Bool 🟢 Required Is the Commerce deactivated? true
false
channel 📝 Text 🟢 Required Channel through which the Commerce is served. “Canal Tradicional”
subChannel 📝 Text 🟢 Required Subchannel through which the Commerce is served. “Canal almacenes”
nextVisitDate 📅 Date ⚪ Optional Date of the next Seller visit to the Commerce. If this date is sent, it is used; otherwise it is calculated based on visitPlan
*\The date must be in ISO 8601 format. “2023-04-27”
“2018-10-22T00:00:00.000Z”
nextDeliveryDate 📅 Date ⚪ Optional Date of the next merchandise delivery for the Commerce.
*\The date must be in ISO 8601 format. “2023-04-27”
“2018-10-22T00:00:00.000Z”
visitPlan 📝 Text ⚪ Optional Weekly visit plan for the Commerce.
*\Must be the days of the week of the visit “monday,friday”
visitRoute 📝 Text ⚪ Optional List of “<week of month>-<day of week><source channel>”
*\*Source channel can be *C: Call center, V: Seller. “1-2C,1-5V,2-1V,2-5V,3-5C”
routeIndex 🔢 Number ⚪ Optional Order in which the commerce will appear in routes. If the number is 1, it will appear in position 1; if it is 10, it will appear in position 10. 0
distributionCenterIds 🔠 List of texts → Distribution Center ⚪ Optional List of Ids of the Distribution Centers ["32", "2"]
deliveryDateBydistributionCenter 🔠 Object → { distributionCenterId: [delivery dates]} ⚪ Optional List of delivery dates by Distribution Center {"1": ["2026-05-05", "2026-05-07", "2026-05-09"],"2": ["2026-05-06", "2026-05-08"]}
sellerIds 🔠 List of texts → Sellers 🟢 Required List of Ids of the seller or sellers assigned to the commerce ["1234", "7876"]
paymentDescription 📝 Text ⚪ Optional Description of the commerce's payment terms Cheque a 15 días
configuration 📝 Object → Configuration ⚪ Optional Specific business configuration for the Commerce. {"minimumOrderTotal": 15000}
additionalInfo 📝 Object ⚪ Optional Key-value object with additional attributes of the Commerce. {"salesZone": "Zona Oriente", "priceList": "LP-04"}

Location

The location object in a Commerce contains the location information for the Commerce. It groups the fields related to the address and geographic location of the Commerce.

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

Coordinates

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

Example

{
    "address": "Avenida Apoquindo 123, Departamento 456, Las Condes",
    "commune": "Las Condes",
    "city": "Santiago",
    "region": "Región Metropolitana",
    "country": "Chile",
    "locality": "San Carlos de Apoquindo",
    "coodinates": {
	    "latitude": "40.7128",
	    "longitude": "-74.0060"
    }
}

Configuration

The configuration object in a Commerce groups the Commerce-specific business configuration. The values reported in this object take priority over the general configuration defined for the customer.

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

Example

{
    "minimumOrderTotal": 15000
}

Response

The Commerces endpoint response returns a JSON object containing the detailed information for each commerce registered in YOM, including contact details, addresses, available credit, and visit days, among others.

Response Example