Measurement Unit Ratios in the Trade Catalog: Overview of Methods

The measurement unit ratio indicates how a unit of product is accounted for. This allows for accurate quantity conversions during data exchanges.

The ratio object includes:

• id — the identifier of the measurement unit ratio
• productId — the identifier of the product to which the ratio pertains
• ratio — the numerical value of the measurement unit ratio
• isDefault — a flag indicating if this is the default ratio

Quick navigation: all methods

How to StartHow to Start

1. Retrieve the structure and field types using catalog.ratio.getFields
2. Obtain a list of ratios using catalog.ratio.list. If you need the primary ratio for a product, select the record with isDefault = Y
3. Get the data for a specific ratio by its id using catalog.ratio.get

Relationship with Other ObjectsRelationship with Other Objects

Product. The ratio is linked to the product through the productId field. Product identifiers can be obtained using the methods catalog.product.list and catalog.product.get.

Overview of MethodsOverview of Methods

Scope: catalog

Who can execute the methods: administrator

Method	Description
catalog.ratio.get	Returns the field values of the measurement unit ratio by identifier
catalog.ratio.list	Returns a list of measurement unit ratios
catalog.ratio.getFields	Returns the available fields of the measurement unit ratio