Square · Schema

BatchRetrieveInventoryChangesResponse

BookingLocationSquareRestaurantCatalogCheckoutCustomersDisputesE-CommerceFinancial TechnologyGift CardsInventoryInvoicingLaborLoyaltyMerchantsOrderPaymentsPoint-of-SaleRefundsRetailSubscriptionTeamWebhookPayment ProcessingPayment Terminals

Properties

Name Type Description
errors array Any errors that occurred during the request.
changes array The current calculated inventory changes for the requested objects and locations.
cursor string The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more in
View JSON Schema on GitHub

JSON Schema

square-batch-retrieve-inventory-changes-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/square/main/json-schema/square-batch-retrieve-inventory-changes-response-schema.json",
  "title": "BatchRetrieveInventoryChangesResponse",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/square-inventory-api-openapi.yml#/components/schemas/BatchRetrieveInventoryChangesResponse",
  "type": "object",
  "x-release-status": "PUBLIC",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Error"
      },
      "description": "Any errors that occurred during the request."
    },
    "changes": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/InventoryChange"
      },
      "description": "The current calculated inventory changes for the requested objects\nand locations."
    },
    "cursor": {
      "type": "string",
      "description": "The pagination cursor to be used in a subsequent request. If unset,\nthis is the final response.\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information."
    }
  },
  "$defs": {
    "CatalogMeasurementUnit": {
      "type": "object",
      "description": "Represents the unit used to measure a `CatalogItemVariation` and\nspecifies the precision for decimal quantities.",
      "x-release-status": "PUBLIC",
      "properties": {
        "measurement_unit": {
          "$ref": "#/$defs/MeasurementUnit",
          "description": "Indicates the unit used to measure the quantity of a catalog item variation."
        },
        "precision": {
          "type": [
            "integer",
            "null"
          ],
          "description": "An integer between 0 and 5 that represents the maximum number of\npositions allowed after the decimal in quantities measured with this unit.\nFor example:\n\n- if the precision is 0, the quantity can be 1, 2, 3, etc.\n- if the precision is 1, the quantity can be 0.1, 0.2, etc.\n- if the precision is 2, the quantity can be 0.01, 0.12, etc.\n\nDefault: 3"
        }
      }
    },
    "Currency": {
      "type": "string",
      "enum": [
        "UNKNOWN_CURRENCY",
        "AED",
        "AFN",
        "ALL",
        "AMD",
        "ANG",
        "AOA",
        "ARS",
        "AUD",
        "AWG",
        "AZN",
        "BAM",
        "BBD",
        "BDT",
        "BGN",
        "BHD",
        "BIF",
        "BMD",
        "BND",
        "BOB",
        "BOV",
        "BRL",
        "BSD",
        "BTN",
        "BWP",
        "BYR",
        "BZD",
        "CAD",
        "CDF",
        "CHE",
        "CHF",
        "CHW",
        "CLF",
        "CLP",
        "CNY",
        "COP",
        "COU",
        "CRC",
        "CUC",
        "CUP",
        "CVE",
        "CZK",
        "DJF",
        "DKK",
        "DOP",
        "DZD",
        "EGP",
        "ERN",
        "ETB",
        "EUR",
        "FJD",
        "FKP",
        "GBP",
        "GEL",
        "GHS",
        "GIP",
        "GMD",
        "GNF",
        "GTQ",
        "GYD",
        "HKD",
        "HNL",
        "HRK",
        "HTG",
        "HUF",
        "IDR",
        "ILS",
        "INR",
        "IQD",
        "IRR",
        "ISK",
        "JMD",
        "JOD",
        "JPY",
        "KES",
        "KGS",
        "KHR",
        "KMF",
        "KPW",
        "KRW",
        "KWD",
        "KYD",
        "KZT",
        "LAK",
        "LBP",
        "LKR",
        "LRD",
        "LSL",
        "LTL",
        "LVL",
        "LYD",
        "MAD",
        "MDL",
        "MGA",
        "MKD",
        "MMK",
        "MNT",
        "MOP",
        "MRO",
        "MUR",
        "MVR",
        "MWK",
        "MXN",
        "MXV",
        "MYR",
        "MZN",
        "NAD",
        "NGN",
        "NIO",
        "NOK",
        "NPR",
        "NZD",
        "OMR",
        "PAB",
        "PEN",
        "PGK",
        "PHP",
        "PKR",
        "PLN",
        "PYG",
        "QAR",
        "RON",
        "RSD",
        "RUB",
        "RWF",
        "SAR",
        "SBD",
        "SCR",
        "SDG",
        "SEK",
        "SGD",
        "SHP",
        "SLL",
        "SLE",
        "SOS",
        "SRD",
        "SSP",
        "STD",
        "SVC",
        "SYP",
        "SZL",
        "THB",
        "TJS",
        "TMT",
        "TND",
        "TOP",
        "TRY",
        "TTD",
        "TWD",
        "TZS",
        "UAH",
        "UGX",
        "USD",
        "USN",
        "USS",
        "UYI",
        "UYU",
        "UZS",
        "VEF",
        "VND",
        "VUV",
        "WST",
        "XAF",
        "XAG",
        "XAU",
        "XBA",
        "XBB",
        "XBC",
        "XBD",
        "XCD",
        "XDR",
        "XOF",
        "XPD",
        "XPF",
        "XPT",
        "XTS",
        "XXX",
        "YER",
        "ZAR",
        "ZMK",
        "ZMW",
        "BTC",
        "XUS"
      ],
      "x-enum-elements": [
        {
          "name": "UNKNOWN_CURRENCY",
          "description": "Unknown currency"
        },
        {
          "name": "AED",
          "description": "United Arab Emirates dirham"
        },
        {
          "name": "AFN",
          "description": "Afghan afghani"
        },
        {
          "name": "ALL",
          "description": "Albanian lek"
        },
        {
          "name": "AMD",
          "description": "Armenian dram"
        },
        {
          "name": "ANG",
          "description": "Netherlands Antillean guilder"
        },
        {
          "name": "AOA",
          "description": "Angolan kwanza"
        },
        {
          "name": "ARS",
          "description": "Argentine peso"
        },
        {
          "name": "AUD",
          "description": "Australian dollar"
        },
        {
          "name": "AWG",
          "description": "Aruban florin"
        },
        {
          "name": "AZN",
          "description": "Azerbaijani manat"
        },
        {
          "name": "BAM",
          "description": "Bosnia and Herzegovina convertible mark"
        },
        {
          "name": "BBD",
          "description": "Barbados dollar"
        },
        {
          "name": "BDT",
          "description": "Bangladeshi taka"
        },
        {
          "name": "BGN",
          "description": "Bulgarian lev"
        },
        {
          "name": "BHD",
          "description": "Bahraini dinar"
        },
        {
          "name": "BIF",
          "description": "Burundian franc"
        },
        {
          "name": "BMD",
          "description": "Bermudian dollar"
        },
        {
          "name": "BND",
          "description": "Brunei dollar"
        },
        {
          "name": "BOB",
          "description": "Boliviano"
        },
        {
          "name": "BOV",
          "description": "Bolivian Mvdol"
        },
        {
          "name": "BRL",
          "description": "Brazilian real"
        },
        {
          "name": "BSD",
          "description": "Bahamian dollar"
        },
        {
          "name": "BTN",
          "description": "Bhutanese ngultrum"
        },
        {
          "name": "BWP",
          "description": "Botswana pula"
        },
        {
          "name": "BYR",
          "description": "Belarusian ruble"
        },
        {
          "name": "BZD",
          "description": "Belize dollar"
        },
        {
          "name": "CAD",
          "description": "Canadian dollar"
        },
        {
          "name": "CDF",
          "description": "Congolese franc"
        },
        {
          "name": "CHE",
          "description": "WIR Euro"
        },
        {
          "name": "CHF",
          "description": "Swiss franc"
        },
        {
          "name": "CHW",
          "description": "WIR Franc"
        },
        {
          "name": "CLF",
          "description": "Unidad de Fomento"
        },
        {
          "name": "CLP",
          "description": "Chilean peso"
        },
        {
          "name": "CNY",
          "description": "Chinese yuan"
        },
        {
          "name": "COP",
          "description": "Colombian peso"
        },
        {
          "name": "COU",
          "description": "Unidad de Valor Real"
        },
        {
          "name": "CRC",
          "description": "Costa Rican colon"
        },
        {
          "name": "CUC",
          "description": "Cuban convertible peso"
        },
        {
          "name": "CUP",
          "description": "Cuban peso"
        },
        {
          "name": "CVE",
          "description": "Cape Verdean escudo"
        },
        {
          "name": "CZK",
          "description": "Czech koruna"
        },
        {
          "name": "DJF",
          "description": "Djiboutian franc"
        },
        {
          "name": "DKK",
          "description": "Danish krone"
        },
        {
          "name": "DOP",
          "description": "Dominican peso"
        },
        {
          "name": "DZD",
          "description": "Algerian dinar"
        },
        {
          "name": "EGP",
          "description": "Egyptian pound"
        },
        {
          "name": "ERN",
          "description": "Eritrean nakfa"
        },
        {
          "name": "ETB",
          "description": "Ethiopian birr"
        },
        {
          "name": "EUR",
          "description": "Euro"
        },
        {
          "name": "FJD",
          "description": "Fiji dollar"
        },
        {
          "name": "FKP",
          "description": "Falkland Islands pound"
        },
        {
          "name": "GBP",
          "description": "Pound sterling"
        },
        {
          "name": "GEL",
          "description": "Georgian lari"
        },
        {
          "name": "GHS",
          "description": "Ghanaian cedi"
        },
        {
          "name": "GIP",
          "description": "Gibraltar pound"
        },
        {
          "name": "GMD",
          "description": "Gambian dalasi"
        },
        {
          "name": "GNF",
          "description": "Guinean franc"
        },
        {
          "name": "GTQ",
          "description": "Guatemalan quetzal"
        },
        {
          "name": "GYD",
          "description": "Guyanese dollar"
        },
        {
          "name": "HKD",
          "description": "Hong Kong dollar"
        },
        {
          "name": "HNL",
          "description": "Honduran lempira"
        },
        {
          "name": "HRK",
          "description": "Croatian kuna"
        },
        {
          "name": "HTG",
          "description": "Haitian gourde"
        },
        {
          "name": "HUF",
          "description": "Hungarian forint"
        },
        {
          "name": "IDR",
          "description": "Indonesian rupiah"
        },
        {
          "name": "ILS",
          "description": "Israeli new shekel"
        },
        {
          "name": "INR",
          "description": "Indian rupee"
        },
        {
          "name": "IQD",
          "description": "Iraqi dinar"
        },
        {
          "name": "IRR",
          "description": "Iranian rial"
        },
        {
          "name": "ISK",
          "description": "Icelandic króna"
        },
        {
          "name": "JMD",
          "description": "Jamaican dollar"
        },
        {
          "name": "JOD",
          "description": "Jordanian dinar"
        },
        {
          "name": "JPY",
          "description": "Japanese yen"
        },
        {
          "name": "KES",
          "description": "Kenyan shilling"
        },
        {
          "name": "KGS",
          "description": "Kyrgyzstani som"
        },
        {
          "name": "KHR",
          "description": "Cambodian riel"
        },
        {
          "name": "KMF",
          "description": "Comoro franc"
        },
        {
          "name": "KPW",
          "description": "North Korean won"
        },
        {
          "name": "KRW",
          "description": "South Korean won"
        },
        {
          "name": "KWD",
          "description": "Kuwaiti dinar"
        },
        {
          "name": "KYD",
          "description": "Cayman Islands dollar"
        },
        {
          "name": "KZT",
          "description": "Kazakhstani tenge"
        },
        {
          "name": "LAK",
          "description": "Lao kip"
        },
        {
          "name": "LBP",
          "description": "Lebanese pound"
        },
        {
          "name": "LKR",
          "description": "Sri Lankan rupee"
        },
        {
          "name": "LRD",
          "description": "Liberian dollar"
        },
        {
          "name": "LSL",
          "description": "Lesotho loti"
        },
        {
          "name": "LTL",
          "description": "Lithuanian litas"
        },
        {
          "name": "LVL",
          "description": "Latvian lats"
        },
        {
          "name": "LYD",
          "description": "Libyan dinar"
        },
        {
          "name": "MAD",
          "description": "Moroccan dirham"
        },
        {
          "name": "MDL",
          "description": "Moldovan leu"
        },
        {
          "name": "MGA",
          "description": "Malagasy ariary"
        },
        {
          "name": "MKD",
          "description": "Macedonian denar"
        },
        {
          "name": "MMK",
          "description": "Myanmar kyat"
        },
        {
          "name": "MNT",
          "description": "Mongolian tögrög"
        },
        {
          "name": "MOP",
          "description": "Macanese pataca"
        },
        {
          "name": "MRO",
          "description": "Mauritanian ouguiya"
        },
        {
          "name": "MUR",
          "description": "Mauritian rupee"
        },
        {
          "name": "MVR",
          "description": "Maldivian rufiyaa"
        },
        {
          "name": "MWK",
          "description": "Malawian kwacha"
        },
        {
          "name": "MXN",
          "description": "Mexican peso"
        },
        {
          "name": "MXV",
          "description": "Mexican Unidad de Inversion"
        },
        {
          "name": "MYR",
          "description": "Malaysian ringgit"
        },
        {
          "name": "MZN",
          "description": "Mozambican metical"
        },
        {
          "name": "NAD",
          "description": "Namibian dollar"
        },
        {
          "name": "NGN",
          "description": "Nigerian naira"
        },
        {
          "name": "NIO",
          "description": "Nicaraguan córdoba"
        },
        {
          "name": "NOK",
          "description": "Norwegian krone"
        },
        {
          "name": "NPR",
          "description": "Nepalese rupee"
        },
        {
          "name": "NZD",
          "description": "New Zealand dollar"
        },
        {
          "name": "OMR",
          "description": "Omani rial"
        },
        {
          "name": "PAB",
          "description": "Panamanian balboa"
        },
        {
          "name": "PEN",
          "description": "Peruvian sol"
        },
        {
          "name": "PGK",
          "description": "Papua New Guinean kina"
        },
        {
          "name": "PHP",
          "description": "Philippine peso"
        },
        {
          "name": "PKR",
          "description": "Pakistani rupee"
        },
        {
          "name": "PLN",
          "description": "Polish zBoty"
        },
        {
          "name": "PYG",
          "description": "Paraguayan guaraní"
        },
        {
          "name": "QAR",
          "description": "Qatari riyal"
        },
        {
          "name": "RON",
          "description": "Romanian leu"
        },
        {
          "name": "RSD",
          "description": "Serbian dinar"
        },
        {
          "name": "RUB",
          "description": "Russian ruble"
        },
        {
          "name": "RWF",
          "description": "Rwandan franc"
        },
        {
          "name": "SAR",
          "description": "Saudi riyal"
        },
        {
          "name": "SBD",
          "description": "Solomon Islands dollar"
        },
        {
          "name": "SCR",
          "description": "Seychelles rupee"
        },
        {
          "name": "SDG",
          "description": "Sudanese pound"
        },
        {
          "name": "SEK",
          "description": "Swedish krona"
        },
        {
          "name": "SGD",
          "description": "Singapore dollar"
        },
        {
          "name": "SHP",
          "description": "Saint Helena pound"
        },
        {
          "name": "SLL",
          "description": "Sierra Leonean first leone"
        },
        {
          "name": "SLE",
          "description": "Sierra Leonean second leone"
        },
        {
          "name": "SOS",
          "description": "Somali shilling"
        },
        {
          "name": "SRD",
          "description": "Surinamese dollar"
        },
        {
          "name": "SSP",
          "description": "South Sudanese pound"
        },
        {
          "name": "STD",
          "description": "São Tomé and Príncipe dobra"
        },
        {
          "name": "SVC",
          "description": "Salvadoran colón"
        },
        {
          "name": "SYP",
          "description": "Syrian pound"
        },
        {
          "name": "SZL",
          "description": "Swazi lilangeni"
        },
        {
          "name": "THB",
          "description": "Thai baht"
        },
        {
          "name": "TJS",
          "description": "Tajikstani somoni"
        },
        {
          "name": "TMT",
          "description": "Turkmenistan manat"
        },
        {
          "name": "TND",
          "description": "Tunisian dinar"
        },
        {
          "name": "TOP",
          "description": "Tongan pa'anga"
        },
        {
          "name": "TRY",
          "description": "Turkish lira"
        },
        {
          "name": "TTD",
          "description": "Trinidad and Tobago dollar"
        },
        {
          "name": "TWD",
          "description": "New Taiwan dollar"
        },
        {
          "name": "TZS",
          "description": "Tanzanian shilling"
        },
        {
          "name": "UAH",
          "description": "Ukrainian hryvnia"
        },
        {
          "name": "UGX",
          "description": "Ugandan shilling"
        },
        {
          "name": "USD",
          "description": "United States dollar"
        },
        {
          "name": "USN",
          "description": "United States dollar (next day)"
        },
        {
          "name": "USS",
          "description": "United States dollar (same day)"
        },
        {
          "name": "UYI",
          "description": "Uruguay Peso en Unidedades Indexadas"
        },
        {
          "name": "UYU",
          "description": "Uruguyan peso"
        },
        {
          "name": "UZS",
          "description": "Uzbekistan som"
        },
        {
          "name": "VEF",
          "description": "Venezuelan bolívar soberano"
        },
        {
          "name": "VND",
          "description": "Vietnamese ’Óng"
        },
        {
          "name": "VUV",
          "description": "Vanuatu vatu"
        },
        {
          "name": "WST",
          "description": "Samoan tala"
        },
        {
          "name": "XAF",
          "description": "CFA franc BEAC"
        },
        {
          "name": "XAG",
          "description": "Silver"
        },
        {
          "name": "XAU",
          "description": "Gold"
        },
        {
          "name": "XBA",
          "description": "European Composite Unit"
        },
        {
          "name": "XBB",
          "description": "European Monetary Unit"
        },
        {
          "name": "XBC",
          "description": "European Unit of Account 9"
        },
        {
          "name": "XBD",
          "description": "European Unit of Account 17"
        },
        {
          "name": "XCD",
          "description": "East Caribbean dollar"
        },
        {
          "name": "XDR",
          "description": "Special drawing rights (International Monetary Fund)"
        },
        {
          "name": "XOF",
          "description": "CFA franc BCEAO"
        },
        {
          "name": "XPD",
          "description": "Palladium"
        },
        {
          "name": "XPF",
          "description": "CFP franc"
        },
        {
          "name": "XPT",
          "description": "Platinum"
        },
        {
          "name": "XTS",
          "description": "Code reserved for testing"
        },
        {
          "name": "XXX",
          "description": "No currency"
        },
        {
          "name": "YER",
          "description": "Yemeni rial"
        },
        {
          "name": "ZAR",
          "description": "South African rand"
        },
        {
          "name": "ZMK",
          "description": "Zambian kwacha"
        },
        {
          "name": "ZMW",
          "description": "Zambian kwacha"
        },
        {
          "name": "BTC",
          "description": "Bitcoin"
        },
        {
          "name": "XUS",
          "description": "USD Coin"
        }
      ],
      "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).",
      "x-release-status": "PUBLIC"
    },
    "Error": {
      "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.",
      "x-release-status": "PUBLIC",
      "required": [
        "category",
        "code"
      ],
      "properties": {
        "category": {
          "$ref": "#/$defs/ErrorCategory",
          "description": "The high-level category for the error.\nSee [ErrorCategory](#type-errorcategory) for possible values"
        },
        "code": {
          "$ref": "#/$defs/ErrorCode",
          "description": "The specific code of the error.\nSee [ErrorCode](#type-errorcode) for possible values"
        },
        "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."
        }
      }
    },
    "ErrorCategory": {
      "type": "string",
      "enum": [
        "API_ERROR",
        "AUTHENTICATION_ERROR",
        "INVALID_REQUEST_ERROR",
        "RATE_LIMIT_ERROR",
        "PAYMENT_METHOD_ERROR",
        "REFUND_ERROR",
        "MERCHANT_SUBSCRIPTION_ERROR",
        "EXTERNAL_VENDOR_ERROR"
      ],
      "x-enum-elements": [
        {
          "name": "API_ERROR",
          "description": "An error occurred with the Connect API itself."
        },
        {
          "name": "AUTHENTICATION_ERROR",
          "description": "An authentication error occurred. Most commonly, the request had\na missing, malformed, or otherwise invalid `Authorization` header."
        },
        {
          "name": "INVALID_REQUEST_ERROR",
          "description": "The request was invalid. Most commonly, a required parameter was\nmissing, or a provided parameter had an invalid value."
        },
        {
          "name": "RATE_LIMIT_ERROR",
          "description": "Your application reached the Square API rate limit. You might receive this error if your application sends a high number of requests\nto Square APIs in a short period of time.\n\nYour application should monitor responses for `429 RATE_LIMITED` errors and use a retry mechanism with an [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff)\nschedule to resend the requests at an increasingly slower rate. It is also a good practice to use a randomized delay (jitter) in your retry schedule."
        },
        {
          "name": "PAYMENT_METHOD_ERROR",
          "description": "An error occurred while processing a payment method. Most commonly,\nthe details of the payment method were invalid (such as a card's CVV\nor expiration date)."
        },
        {
          "name": "REFUND_ERROR",
          "description": "An error occurred while attempting to process a refund."
        },
        {
          "name": "MERCHANT_SUBSCRIPTION_ERROR",
          "description": "An error occurred when checking a merchant subscription status"
        },
        {
          "name": "EXTERNAL_VENDOR_ERROR",
          "description": "An error that is returned from an external vendor's API"
        }
      ],
      "description": "Indicates which high-level category of error has occurred during a\nrequest to the Connect API.",
      "x-release-status": "PUBLIC"
    },
    "ErrorCode": {
      "type": "string",
      "enum": [
        "INTERNAL_SERVER_ERROR",
        "UNAUTHORIZED",
        "ACCESS_TOKEN_EXPIRED",
        "ACCESS_TOKEN_REVOKED",
        "CLIENT_DISABLED",
        "FORBIDDEN",
        "INSUFFICIENT_SCOPES",
        "APPLICATION_DISABLED",
        "V1_APPLICATION",
        "V1_ACCESS_TOKEN",
        "CARD_PROCESSING_NOT_ENABLED",
        "MERCHANT_SUBSCRIPTION_NOT_FOUND",
        "BAD_REQUEST",
        "MISSING_REQUIRED_PARAMETER",
        "INCORRECT_TYPE",
        "INVALID_TIME",
        "INVALID_TIME_RANGE",
        "INVALID_VALUE",
        "INVALID_CURSOR",
        "UNKNOWN_QUERY_PARAMETER",
        "CONFLICTING_PARAMETERS",
        "EXPECTED_JSON_BODY",
        "INVALID_SORT_ORDER",
        "VALUE_REGEX_MISMATCH",
        "VALUE_TOO_SHORT",
        "VALUE_TOO_LONG",
        "VALUE_TOO_LOW",
        "VALUE_TOO_HIGH",
        "VALUE_EMPTY",
        "ARRAY_LENGTH_TOO_LONG",
        "ARRAY_LENGTH_TOO_SHORT",
        "ARRAY_EMPTY",
        "EXPECTED_BOOLEAN",
        "EXPECTED_INTEGER",
        "EXPECTED_FLOAT",
        "EXPECTED_STRING",
        "EXPECTED_OBJECT",
        "EXPECTED_ARRAY",
        "EXPECTED_MAP",
        "EXPECTED_BASE64_ENCODED_BYTE_ARRAY",
        "INVALID_ARRAY_VALUE",
        "INVALID_ENUM_VALUE",
        "INVALID_CONTENT_TYPE",
        "INVALID_FORM_VALUE",
        "CUSTOMER_NOT_FOUND",
        "ONE_INSTRUMENT_EXPECTED",
        "NO_FIELDS_SET",
        "TOO_MANY_MAP_ENTRIES",
        "MAP_KEY_LENGTH_TOO_SHORT",
        "MAP_KEY_LENGTH_TOO_LONG",
        "CUSTOMER_MISSING_NAME",
        "CUSTOMER_MISSING_EMAIL",
        "INVALID_PAUSE_LENGTH",
        "INVALID_DATE",
        "UNSUPPORTED_COUNTRY",
        "UNSUPPORTED_CURRENCY",
        "APPLE_TTP_PIN_TOKEN",
        "CARD_EXPIRED",
        "INVALID_EXPIRATION",
        "INVALID_EXPIRATION_YEAR",
        "INVALID_EXPIRATION_DATE",
        "UNSUPPORTED_CARD_BRAND",
        "UNSUPPORTED_ENTRY_METHOD",
        "INVALID_ENCRYPTED_CARD",
        "INVALID_CARD",
        "PAYMENT_AMOUNT_MISMATCH",
        "GENERIC_DECLINE",
        "CVV_FAILURE",
        "ADDRESS_VERIFICATION_FAILURE",
        "INVALID_ACCOUNT",
        "CURRENCY_MISMATCH",
        "INSUFFICIENT_FUNDS",
        "INSUFFICIENT_PERMISSIONS",
        "CARDHOLDER_INSUFFICIENT_PERMISSIONS",
        "INVALID_LOCATION",
        "TRANSACTION_LIMIT",
        "VOICE_FAILURE",
        "PAN_FAILURE",
        "EXPIRATION_FAILURE",
        "CARD_NOT_SUPPORTED",
        "INVALID_PIN",
        "MISSING_PIN",
        "MISSING_ACCOUNT_TYPE",
        "INVALID_POSTAL_CODE",
        "INVALID_FEES",
        "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED",
        "PAYMENT_LIMIT_EXCEEDED",
        "GIFT_CARD_AVAILABLE_AMOUNT",
        "ACCOUNT_UNUSABLE",
        "BUYER_REFUSED_PAYMENT",
        "DELAYED_TRANSACTION_EXPIRED",
        "DELAYED_TRANSACTION_CANCELED",
        "DELAYED_TRANSACTION_CAPTURED",
        "DELAYED_TRANSACTION_FAILED",
        "CARD_TOKEN_EXPIRED",
        "CARD_TOKEN_USED",
        "AMOUNT_TOO_HIGH",
        "UNSUPPORTED_INSTRUMENT_TYPE",
        "REFUND_AMOUNT_INVALID",
        "REFUND_ALREADY_PENDING",
        "PAYMENT_NOT_REFUNDABLE",
        "PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE",
        "REFUND_DECLINED",
        "INSUFFICIENT_PERMISSIONS_FOR_REFUND",
        "INVALID_CARD_DATA",
        "SOURCE_USED",
        "SOURCE_EXPIRED",
        "UNSUPPORTED_LOYALTY_REWARD_TIER",
        "LOCATION_MISMATCH",
        "IDEMPOTENCY_KEY_REUSED",
        "UNEXPECTED_VALUE",
        "SANDBOX_NOT_SUPPORTED",
        "INVALID_EMAIL_ADDRESS",
        "INVALID_PHONE_NUMBER",
        "CHECKOUT_EXPIRED",
        "BAD_CERTIFICATE",
        "INVALID_SQUARE_VERSION_FORMAT",
        "API_VERSION_INCOMPATIBLE",
        "CARD_PRESENCE_REQUIRED",
        "UNSUPPORTED_SOURCE_TYPE",
        "CARD_MISMATCH",
        "PLAID_ERROR",
        "PLAID_ERROR_ITEM_LOGIN_REQUIRED",
        "PLAID_ERROR_RATE_LIMIT",
        "CARD_DECLINED",
        "VERIFY_CVV_FAILURE",
        "VERIFY_AVS_FAILURE",
        "CARD_DECLINED_CALL_ISSUER",
        "CARD_DECLINED_VERIFICATION_REQUIRED",
        "BAD_EXPIRATION",
        "CHIP_INSERTION_REQUIRED",
        "ALLOWABLE_PIN_TRIES_EXCEEDED",
        "RESERVATION_DECLINED",
        "UNKNOWN_BODY_PARAMETER",
        "NOT_FOUND",
        "APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND",
        "METHOD_NOT_ALLOWED",
        "NOT_ACCEPTABLE",
        "REQUEST_TIMEOUT",
        "CONFLICT",
        "GONE",
        "REQUEST_ENTITY_TOO_LARGE",
        "UNSUPPORTED_MEDIA_TYPE",
        "UNPROCESSABLE_ENTITY",
        "RATE_LIMITED",
        "NOT_IMPLEMENTED",
        "BAD_GATEWAY",
        "SERVICE_UNAVAILABLE",
        "TEMPORARY_ERROR",
        "GATEWAY_TIMEOUT"
      ],
      "x-enum-elements": [
        {
          "name": "INTERNAL_SERVER_ERROR",
          "description": "A general server error occurred.",
          "error-category": "API_ERROR"
        },
        {
          "name": "UNAUTHORIZED",
          "description": "A general authorization error occurred.",
          "error-category": "AUTHENTICATION_ERROR"
        },
        {
          "name": "ACCESS_TOKEN_EXPIRED",
          "description": "The provided access token has expired.",
          "error-category": "AUTHENTICATION_ERROR"
        },
        {
          "name": "ACCESS_TOKEN_REVOKED",
          "description": "The provided access token has been revoked.",
          "error-category": "AUTHENTICATION_ERROR"
        },
        {
          "name": "CLIENT_DISABLED",
          "description": "The provided client has been disabled.",
          "error-category": "AUTHENTICATION_ERROR"
        },
        {
          "name": "FORBIDDEN",
          "description": "A general access error occurred.",
          "error-category": "AUTHENTICATION_ERROR"
        },
        {
          "name": "INSUFFICIENT_SCOPES",
          "description": "The provided access token does not have permission\nto execute the requested action.",
          "error-category": "AUTHENTICATION_ERROR"
        },
        {
          "name": "APPLICATION_DISABLED",
          "description": "The calling application was disabled.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "V1_APPLICATION",
          "description": "The calling application was created prior to\n2016-03-30 and is not compatible with v2 Square API calls.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "V1_ACCESS_TOKEN",
          "description": "The calling application is using an access token\ncreated prior to 2016-03-30 and is not compatible with v2 Square API\ncalls.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "CARD_PROCESSING_NOT_ENABLED",
          "description": "The location provided in the API call is not\nenabled for credit card processing.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "MERCHANT_SUBSCRIPTION_NOT_FOUND",
          "description": "A required subscription was not found for the merchant",
          "error-category": "MERCHANT_SUBSCRIPTION_ERROR"
        },
        {
          "name": "BAD_REQUEST",
          "description": "A general error occurred with the request.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "MISSING_REQUIRED_PARAMETER",
          "description": "The request is missing a required path, query, or\nbody parameter.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "INCORRECT_TYPE",
          "d

# --- truncated at 32 KB (97 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-batch-retrieve-inventory-changes-response-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/square-batch-retrieve-inventory-changes-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.