Server : ApacheSystem : Linux host.digitalbabaji.in 4.18.0-513.11.1.el8_9.x86_64 #1 SMP Wed Jan 17 02:00:40 EST 2024 x86_64 User : addictionfreeind ( 1003) PHP Version : 7.2.34 Disable Function : exec,passthru,shell_exec,system Directory : /home/addictionfreeind/www/admin1/vendor/square/square/doc/models/ |
Upload File : |
# Inventory Change
Represents a single physical count, inventory, adjustment, or transfer
that is part of the history of inventory changes for a particular
[CatalogObject](/doc/models/catalog-object.md) instance.
## Structure
`InventoryChange`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `type` | [`?string (InventoryChangeType)`](/doc/models/inventory-change-type.md) | Optional | Indicates how the inventory change was applied to a tracked product quantity. | getType(): ?string | setType(?string type): void |
| `physicalCount` | [`?InventoryPhysicalCount`](/doc/models/inventory-physical-count.md) | Optional | Represents the quantity of an item variation that is physically present<br>at a specific location, verified by a seller or a seller's employee. For example,<br>a physical count might come from an employee counting the item variations on<br>hand or from syncing with an external system. | getPhysicalCount(): ?InventoryPhysicalCount | setPhysicalCount(?InventoryPhysicalCount physicalCount): void |
| `adjustment` | [`?InventoryAdjustment`](/doc/models/inventory-adjustment.md) | Optional | Represents a change in state or quantity of product inventory at a<br>particular time and location. | getAdjustment(): ?InventoryAdjustment | setAdjustment(?InventoryAdjustment adjustment): void |
| `transfer` | [`?InventoryTransfer`](/doc/models/inventory-transfer.md) | Optional | Represents the transfer of a quantity of product inventory at a<br>particular time from one location to another. | getTransfer(): ?InventoryTransfer | setTransfer(?InventoryTransfer transfer): void |
| `measurementUnit` | [`?CatalogMeasurementUnit`](/doc/models/catalog-measurement-unit.md) | Optional | Represents the unit used to measure a `CatalogItemVariation` and<br>specifies the precision for decimal quantities. | getMeasurementUnit(): ?CatalogMeasurementUnit | setMeasurementUnit(?CatalogMeasurementUnit measurementUnit): void |
| `measurementUnitId` | `?string` | Optional | The ID of the [CatalogMeasurementUnit](/doc/models/catalog-measurement-unit.md) object representing the catalog measurement unit associated with the inventory change. | getMeasurementUnitId(): ?string | setMeasurementUnitId(?string measurementUnitId): void |
## Example (as JSON)
```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
}
}
```