RetrieveInventoryTransfer

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "description": "Any errors that occurred during the request.",
      "items": {
        "type": "object",
        "description": "Represents an error encountered during a request to the Connect API.\n\nSee [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information.",
        "required": [
          "category",
          "code"
        ],
        "properties": {
          "category": {
            "type": "string",
            "description": "The high-level category for the error."
          },
          "code": {
            "type": "string",
            "description": "The specific code of the error."
          },
          "detail": {
            "type": "string",
            "description": "A human-readable description of the error for debugging purposes."
          },
          "field": {
            "type": "string",
            "description": "The name of the field provided in the original request (if any) that\nthe error pertains to."
          }
        }
      }
    },
    "transfer": {
      "type": "object",
      "description": "Represents the transfer of a quantity of product inventory at a\nparticular time from one location to another.",
      "properties": {
        "catalog_object_id": {
          "type": "string",
          "description": "The Square-generated ID of the\n[CatalogObject](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogObject) being tracked."
        },
        "catalog_object_type": {
          "type": "string",
          "description": "The [type](https://developer.squareup.com/reference/square_2021-08-18/enums/CatalogObjectType) of the\n[CatalogObject](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogObject) being tracked.Tracking is only\nsupported for the `ITEM_VARIATION` type."
        },
        "created_at": {
          "type": "string",
          "description": "An RFC 3339-formatted timestamp that indicates when Square\nreceived the transfer request."
        },
        "employee_id": {
          "type": "string",
          "description": "The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2021-08-18/objects/Employee) responsible for the\ninventory transfer."
        },
        "from_location_id": {
          "type": "string",
          "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2021-08-18/objects/Location) where the related\nquantity of items was tracked before the transfer."
        },
        "id": {
          "type": "string",
          "description": "A unique ID generated by Square for the\n`InventoryTransfer`."
        },
        "occurred_at": {
          "type": "string",
          "description": "A client-generated RFC 3339-formatted timestamp that indicates when\nthe transfer took place. For write actions, the `occurred_at` timestamp\ncannot be older than 24 hours or in the future relative to the time of the\nrequest."
        },
        "quantity": {
          "type": "string",
          "description": "The number of items affected by the transfer as a decimal string.\nCan support up to 5 digits after the decimal point."
        },
        "reference_id": {
          "type": "string",
          "description": "An optional ID provided by the application to tie the\n`InventoryTransfer` to an external system."
        },
        "source": {
          "type": "object",
          "description": "Provides information about the application used to generate a change.",
          "properties": {
            "application_id": {
              "type": "string",
              "description": "Read-only Square ID assigned to the application. Only used for\n[Product](https://developer.squareup.com/reference/square_2021-08-18/enums/Product) type `EXTERNAL_API`."
            },
            "name": {
              "type": "string",
              "description": "Read-only display name assigned to the application\n(e.g. `\"Custom Application\"`, `\"Square POS 4.74 for Android\"`)."
            },
            "product": {
              "type": "string",
              "description": "Read-only [Product](https://developer.squareup.com/reference/square_2021-08-18/enums/Product) type for the application."
            }
          }
        },
        "state": {
          "type": "string",
          "description": "The [inventory state](https://developer.squareup.com/reference/square_2021-08-18/enums/InventoryState) for the quantity of\nitems being transferred."
        },
        "to_location_id": {
          "type": "string",
          "description": "The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2021-08-18/objects/Location) where the related\nquantity of items was tracked after the transfer."
        }
      }
    }
  }
}