Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 3.23 KB

inventory-transfer.md

File metadata and controls

40 lines (31 loc) · 3.23 KB
Raw

Inventory Transfer

Represents the transfer of a quantity of product inventory at a particular time from one location to another.

Structure

InventoryTransfer

Fields

Name Type Tags Description
Id string Optional A unique ID generated by Square for the
InventoryTransfer.
Constraints: Maximum Length: 100
ReferenceId string Optional An optional ID provided by the application to tie the
InventoryTransfer to an external system.
Constraints: Maximum Length: 255
State string Optional Indicates the state of a tracked item quantity in the lifecycle of goods.
FromLocationId string Optional The Square-generated ID of the Location where the related
quantity of items was tracked before the transfer.
Constraints: Maximum Length: 100
ToLocationId string Optional The Square-generated ID of the Location where the related
quantity of items was tracked after the transfer.
Constraints: Maximum Length: 100
CatalogObjectId string Optional The Square-generated ID of the
CatalogObject being tracked.
Constraints: Maximum Length: 100
CatalogObjectType string Optional The type of the CatalogObject being tracked.

The Inventory API supports setting and reading the "catalog_object_type": "ITEM_VARIATION" field value.
In addition, it can also read the "catalog_object_type": "ITEM" field value that is set by the Square Restaurants app.
Constraints: Maximum Length: 14
Quantity string Optional The number of items affected by the transfer as a decimal string.
Can support up to 5 digits after the decimal point.
Constraints: Maximum Length: 26
OccurredAt string Optional A client-generated RFC 3339-formatted timestamp that indicates when
the transfer took place. For write actions, the occurred_at timestamp
cannot be older than 24 hours or in the future relative to the time of the
request.
Constraints: Maximum Length: 34
CreatedAt string Optional An RFC 3339-formatted timestamp that indicates when Square
received the transfer request.
Constraints: Maximum Length: 34
Source Models.SourceApplication Optional Provides information about the application used to generate a change.
EmployeeId string Optional The Square-generated ID of the Employee responsible for the
inventory transfer.
Constraints: Maximum Length: 100
TeamMemberId string Optional The Square-generated ID of the Team Member responsible for the
inventory transfer.
Constraints: Maximum Length: 100

Example (as JSON)

{
  "id": "id0",
  "reference_id": "reference_id2",
  "state": "SUPPORTED_BY_NEWER_VERSION",
  "from_location_id": "from_location_id2",
  "to_location_id": "to_location_id8"
}