Segments

Once your Commerces are uploaded, you can segment them.

What is a Segment?

A Segment is the priority definition for each Commerce.

Segments let you categorize Commerces and define priorities for applying prices and other associated benefits. The Segments entity contains key information about each Segment, including its name, the external identifier of the Commerce, and its priority.

Endpoint

GET /api/segment

FILE <fecha>_<hora>_segment.csv

Fields

Field	Type	Requirement	Description	Examples
`segmentId`	📝 Text	🟢 Required	Unique identifier of the Segment.	`“SEG001”`
`name`	📝 Text	🟢 Required	Name of the Segment.	`"Segmento VIP"`
`commerceIds`	🔠 Text list	🟢 Required	External identifier of the Commerce.
Must match the userId field in the upload of
Commerces	`"EXT001"`
`priority`	🔢 Number	🟢 Required	Segment priority; used to define the priority of all associated prices.
If a Commerce* has more than one Segment, the one with the lowest priority number prevails (`1`>`2`).
If the Segments* are linked to different products, both will be applied to the corresponding product.
⚠️ A segment's priority must be unique across all commerces; that is, if I have segment SEG001, it must ALWAYS have the same priority for all commerces.	`1`

Response

The Segments endpoint response provides a JSON containing detailed information about each segment, enabling effective and organized management.

Response example

{
  "segmentId": "SEG001",
  "name": "Segmento VIP",
  "commerceId": "EXT001",
  "priority": 1
}

This structure lets you manage and query segment information in YOM efficiently.

Previous steps

Promotions

</aside>

Next steps

</aside>