Skip to content

Latest commit

 

History

History
64 lines (55 loc) · 2.64 KB

inventory-change.md

File metadata and controls

64 lines (55 loc) · 2.64 KB

Inventory Change

Represents a single physical count, inventory, adjustment, or transfer that is part of the history of inventory changes for a particular CatalogObject instance.

Structure

Inventory Change

Fields

Name Type Tags Description
type str (Inventory Change Type) Optional Indicates how the inventory change was applied to a tracked quantity of items.
physical_count Inventory Physical Count Optional Represents the quantity of an item variation that is physically present
at a specific location, verified by a seller or a seller's employee. For example,
a physical count might come from an employee counting the item variations on
hand or from syncing with an external system.
adjustment Inventory Adjustment Optional Represents a change in state or quantity of product inventory at a
particular time and location.
transfer Inventory Transfer Optional Represents the transfer of a quantity of product inventory at a
particular time from one location to another.
measurement_unit Catalog Measurement Unit Optional Represents the unit used to measure a CatalogItemVariation and
specifies the precision for decimal quantities.
measurement_unit_id string Optional The ID of the CatalogMeasurementUnit object representing the catalog measurement unit associated with the inventory change.

Example (as JSON)

{
  "type": "TRANSFER",
  "physical_count": {
    "id": "id2",
    "reference_id": "reference_id0",
    "catalog_object_id": "catalog_object_id6",
    "catalog_object_type": "catalog_object_type6",
    "state": "RETURNED_BY_CUSTOMER"
  },
  "adjustment": {
    "id": "id4",
    "reference_id": "reference_id2",
    "from_state": "WASTE",
    "to_state": "DECOMPOSED",
    "location_id": "location_id8"
  },
  "transfer": {
    "id": "id8",
    "reference_id": "reference_id6",
    "state": "RESERVED_FOR_SALE",
    "from_location_id": "from_location_id0",
    "to_location_id": "to_location_id0"
  },
  "measurement_unit": {
    "measurement_unit": {
      "custom_unit": {
        "name": "name2",
        "abbreviation": "abbreviation4"
      },
      "area_unit": "IMPERIAL_SQUARE_MILE",
      "length_unit": "METRIC_MILLIMETER",
      "volume_unit": "GENERIC_CUP",
      "weight_unit": "IMPERIAL_STONE"
    },
    "precision": 184
  }
}