action squareup_retrieve_inventory_adjustment {
  label: "RetrieveInventoryAdjustment"
  description: "Returns the [InventoryAdjustment](https://developer.squareup.com/reference/square_2021-08-18/objects/InventoryAdjustment) object\nwith the provided `adjustment_id`."
  provider: squareup
  method: GET
  path: "/v2/inventory/adjustments/{adjustment_id}"
  encoding: json
  input: {
    type: "object"
    properties: {
      adjustment_id: {
        type: "string"
      }
    }
    required: ["adjustment_id"]
    additionalProperties: false
  }
  output: {
    type: "object"
    properties: {
      adjustment: {
        type: "object"
        description: "Represents a change in state or quantity of product inventory at a\nparticular time and location."
        properties: {
          adjustment_group: {
            type: "object"
            properties: {
              from_state: {
                type: "string"
                description: "Representative `from_state` for adjustments within the group. For example, for a group adjustment from `IN_STOCK` to `SOLD`,\nthere can be two component adjustments in the group: one from `IN_STOCK`to `COMPOSED` and the other one from `COMPOSED` to `SOLD`.\nHere, the representative `from_state` for the `InventoryAdjustmentGroup` is `IN_STOCK`."
              }
              id: {
                type: "string"
                description: "A unique ID generated by Square for the\n`InventoryAdjustmentGroup`."
              }
              root_adjustment_id: {
                type: "string"
                description: "The inventory adjustment of the composed variation."
              }
              to_state: {
                type: "string"
                description: "Representative `to_state` for adjustments within group. For example, for a group adjustment from `IN_STOCK` to `SOLD`,\nthe two component adjustments in the group can be from `IN_STOCK` to `COMPOSED` and from `COMPOSED` to `SOLD`. \nHere, the representative `to_state` of the `InventoryAdjustmentGroup` is `SOLD`."
              }
            }
          }
          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 the inventory adjustment is received."
          }
          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 adjustment."
          }
          from_state: {
            type: "string"
            description: "The [inventory state](https://developer.squareup.com/reference/square_2021-08-18/enums/InventoryState) of the related quantity\nof items before the adjustment."
          }
          goods_receipt_id: {
            type: "string"
            description: "The Square-generated ID of the goods receipt that caused the\nadjustment. Only relevant for state transitions from the Square for Retail\napp."
          }
          id: {
            type: "string"
            description: "A unique ID generated by Square for the\n`InventoryAdjustment`."
          }
          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 is being tracked."
          }
          occurred_at: {
            type: "string"
            description: "A client-generated RFC 3339-formatted timestamp that indicates when\nthe inventory adjustment took place. For inventory adjustment updates, the `occurred_at`\ntimestamp cannot be older than 24 hours or in the future relative to the\ntime of the request."
          }
          purchase_order_id: {
            type: "string"
            description: "The Square-generated ID of the purchase order that caused the\nadjustment. Only relevant for state transitions from the Square for Retail\napp."
          }
          quantity: {
            type: "string"
            description: "The number of items affected by the adjustment 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`InventoryAdjustment` to an external\nsystem."
          }
          refund_id: {
            type: "string"
            description: "The Square-generated ID of the [Refund][#type-refund] that\ncaused the adjustment. Only relevant for refund-related state\ntransitions."
          }
          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."
              }
            }
          }
          to_state: {
            type: "string"
            description: "The [inventory state](https://developer.squareup.com/reference/square_2021-08-18/enums/InventoryState) of the related quantity\nof items after the adjustment."
          }
          total_price_money: {
            type: "object"
            description: "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information."
            properties: {
              amount: {
                type: "integer"
                format: "int64"
                description: "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case."
              }
              currency: {
                type: "string"
                description: "The type of currency, in __ISO 4217 format__. For example, the currency\ncode for US dollars is `USD`.\n\nSee [Currency](https://developer.squareup.com/reference/square_2021-08-18/enums/Currency) for possible values."
              }
            }
          }
          transaction_id: {
            type: "string"
            description: "The Square-generated ID of the [Transaction][#type-transaction] that\ncaused the adjustment. Only relevant for payment-related state\ntransitions."
          }
        }
      }
      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."
            }
          }
        }
      }
    }
  }
}