Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 2.16 KB

catalog-stock-conversion.md

File metadata and controls

29 lines (20 loc) · 2.16 KB

Catalog Stock Conversion

Represents the rule of conversion between a stockable CatalogItemVariation and a non-stockable sell-by or receive-by CatalogItemVariation that share the same underlying stock.

Structure

Catalog Stock Conversion

Fields

Name Type Tags Description
stockable_item_variation_id str Required References to the stockable CatalogItemVariation
for this stock conversion. Selling, receiving or recounting the non-stockable CatalogItemVariation
defined with a stock conversion results in adjustments of this stockable CatalogItemVariation.
This immutable field must reference a stockable CatalogItemVariation
that shares the parent CatalogItem of the converted CatalogItemVariation.
Constraints: Minimum Length: 1
stockable_quantity str Required The quantity of the stockable item variation (as identified by stockable_item_variation_id)
equivalent to the non-stockable item variation quantity (as specified in nonstockable_quantity)
as defined by this stock conversion. It accepts a decimal number in a string format that can take
up to 10 digits before the decimal point and up to 5 digits after the decimal point.
Constraints: Minimum Length: 1, Maximum Length: 16
nonstockable_quantity str Required The converted equivalent quantity of the non-stockable CatalogItemVariation
in its measurement unit. The stockable_quantity value and this nonstockable_quantity value together
define the conversion ratio between stockable item variation and the non-stockable item variation.
It accepts a decimal number in a string format that can take up to 10 digits before the decimal point
and up to 5 digits after the decimal point.
Constraints: Minimum Length: 1, Maximum Length: 16

Example (as JSON)

{
  "stockable_item_variation_id": "stockable_item_variation_id2",
  "stockable_quantity": "stockable_quantity0",
  "nonstockable_quantity": "nonstockable_quantity2"
}