Response Description

Response groups allow you to control the amount and type of information returned in an API response. By selecting a specific response group, you can tailor the payload to match your use case—whether you need only the essential fields or a more detailed dataset. This helps improve performance, reduce unnecessary data transfer, and ensure that applications receive only what they actually need.

We support several response group options, each designed to provide a different level of detail:

• small – Returns only the most essential fields, ideal for lightweight requests or high‑volume calls where minimal data is preferred.

• medium – Includes the standard set of commonly used fields, offering a balance between detail and efficiency.

• large – Provides the full set of available fields, suitable when complete product or item information is required.

• prices – Returns only pricing‑related information, useful for scenarios focused on cost, quotes, or price comparison.

• inventory – Returns only inventory‑specific fields, such as stock levels or availability status.

• none – Returns no additional grouped fields beyond the default response.

These response groups give you flexibility in shaping the API output to best support your application’s needs.

.