Sellers

With your Commerces and Products configured, it is time to add your Sellers.

Who are the sellers? Sellers in YOM are the ones who serve or visit the Commerces in the field.

They are represented by the Seller entity. A Seller contains the information needed to manage them, including identifiers, contacts, and supervisors.

Endpoint

GET /api/seller

FILE <fecha>_<hora>_seller.csv

Fields

Seller

The seller object contains information about the Seller. This includes identifiers, contact details, and additional data about the Seller's status or supervision.

Field	Type	Requirement	Description	Examples
`sellerId`	📝 Text	🟢 Required	Unique identifier of the Seller.	`"V001"`
`name`	📝 Text	🟢 Required	Name of the Seller.	`"Carlos García"`
`email`	📝 Text	⚪ Optional	Email address of the Seller.	`"[email protected]"`
`phone`	📝 Text	⚪ Optional	Phone number of the Seller.	`"+123456789"``
`governmentId`	📝 Text	⚪ Optional	RUT / CI of the Seller.	`“18888888-8”`
`supervisorIds`	🗂️ List of Texts	⚪ Optional	List of identifiers of the Seller's supervisors.
Supervisors	`["S001", "S002"]`
`isInactive`	🔘 Bool	⚪ Optional	Is the Seller deactivated?	`true`
`false`

Response

The Sellers endpoint response provides a JSON object containing the detailed information for each seller, including their supervisors and contact details.

Response Example

{
  "sellerId": "V001",
  "name": "Carlos García",
  "email": "[email protected]",
  "phone": "+123456789",
  "governmentId": "18888888-8",
  "supervisorIds": ["S001", "S002"],
  "isInactive": false
}

With this structure, you can manage and query seller information in YOM efficiently and in an organized way.

Previous steps

</aside>