--- title: "CatalogInfo" method: GET path: "/v2/catalog/info" tags: ["Catalog"] --- # CatalogInfo `GET /v2/catalog/info` Retrieves information about the Square Catalog API, such as batch size limits that can be used by the `BatchUpsertCatalogObjects` endpoint. ## Response `200` Success - CatalogInfoResponse - `errors` Error[] — Any errors that occurred during the request. - `category` 'API_ERROR' | 'AUTHENTICATION_ERROR' | 'INVALID_REQUEST_ERROR' | 'RATE_LIMIT_ERROR' | 'PAYMENT_METHOD_ERROR' | 'REFUND_ERROR' | 'MERCHANT_SUBSCRIPTION_ERROR' | 'EXTERNAL_VENDOR_ERROR', required — Indicates which high-level category of error has occurred during a request to the Connect API. - `code` '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' | 'READER_DECLINED' | '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_ERROR_PAYMENT_NEEDS_COMPLETION' | 'REFUND_DECLINED' | 'INSUFFICIENT_PERMISSIONS_FOR_REFUND' | 'INVALID_CARD_DATA' | 'SOURCE_USED' | 'SOURCE_EXPIRED' | 'UNSUPPORTED_LOYALTY_REWARD_TIER' | 'LOCATION_MISMATCH' | 'ORDER_UNPAID_NOT_RETURNABLE' | 'PARTIAL_PAYMENT_DELAY_CAPTURE_NOT_SUPPORTED' | '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' | 'PAYMENT_SOURCE_NOT_ENABLED_FOR_TARGET' | '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', required — Indicates the specific error that occurred during a request to a Square API. - `detail` string — A human-readable description of the error for debugging purposes. - `field` string — The name of the field provided in the original request (if any) that the error pertains to. - `limits` CatalogInfoResponseLimits - `batch_upsert_max_objects_per_batch` integer, nullable — The maximum number of objects that may appear within a single batch in a `/v2/catalog/batch-upsert` request. - `batch_upsert_max_total_objects` integer, nullable — The maximum number of objects that may appear across all batches in a `/v2/catalog/batch-upsert` request. - `batch_retrieve_max_object_ids` integer, nullable — The maximum number of object IDs that may appear in a `/v2/catalog/batch-retrieve` request. - `search_max_page_limit` integer, nullable — The maximum number of results that may be returned in a page of a `/v2/catalog/search` response. - `batch_delete_max_object_ids` integer, nullable — The maximum number of object IDs that may be included in a single `/v2/catalog/batch-delete` request. - `update_item_taxes_max_item_ids` integer, nullable — The maximum number of item IDs that may be included in a single `/v2/catalog/update-item-taxes` request. - `update_item_taxes_max_taxes_to_enable` integer, nullable — The maximum number of tax IDs to be enabled that may be included in a single `/v2/catalog/update-item-taxes` request. - `update_item_taxes_max_taxes_to_disable` integer, nullable — The maximum number of tax IDs to be disabled that may be included in a single `/v2/catalog/update-item-taxes` request. - `update_item_modifier_lists_max_item_ids` integer, nullable — The maximum number of item IDs that may be included in a single `/v2/catalog/update-item-modifier-lists` request. - `update_item_modifier_lists_max_modifier_lists_to_enable` integer, nullable — The maximum number of modifier list IDs to be enabled that may be included in a single `/v2/catalog/update-item-modifier-lists` request. - `update_item_modifier_lists_max_modifier_lists_to_disable` integer, nullable — The maximum number of modifier list IDs to be disabled that may be included in a single `/v2/catalog/update-item-modifier-lists` request. - `standard_unit_description_group` StandardUnitDescriptionGroup — Group of standard measurement units. - `standard_unit_descriptions` StandardUnitDescription[], nullable — List of standard (non-custom) measurement units in this description group. - `unit` MeasurementUnit — Represents a unit of measurement to use with a quantity, such as ounces or inches. Exactly one of the following fields are required: `custom_unit`, `area_unit`, `length_unit`, `volume_unit`, and `weight_unit`. - `custom_unit` MeasurementUnitCustom — The information needed to define a custom unit, provided by the seller. - `name` string, required — The name of the custom unit, for example "bushel". - `abbreviation` string, required — The abbreviation of the custom unit, such as "bsh" (bushel). This appears in the cart for the Point of Sale app, and in reports. - `area_unit` 'IMPERIAL_ACRE' | 'IMPERIAL_SQUARE_INCH' | 'IMPERIAL_SQUARE_FOOT' | 'IMPERIAL_SQUARE_YARD' | 'IMPERIAL_SQUARE_MILE' | 'METRIC_SQUARE_CENTIMETER' | 'METRIC_SQUARE_METER' | 'METRIC_SQUARE_KILOMETER' — Unit of area used to measure a quantity. - `length_unit` 'IMPERIAL_INCH' | 'IMPERIAL_FOOT' | 'IMPERIAL_YARD' | 'IMPERIAL_MILE' | 'METRIC_MILLIMETER' | 'METRIC_CENTIMETER' | 'METRIC_METER' | 'METRIC_KILOMETER' — The unit of length used to measure a quantity. - `volume_unit` 'GENERIC_FLUID_OUNCE' | 'GENERIC_SHOT' | 'GENERIC_CUP' | 'GENERIC_PINT' | 'GENERIC_QUART' | 'GENERIC_GALLON' | 'IMPERIAL_CUBIC_INCH' | 'IMPERIAL_CUBIC_FOOT' | 'IMPERIAL_CUBIC_YARD' | 'METRIC_MILLILITER' | 'METRIC_LITER' — The unit of volume used to measure a quantity. - `weight_unit` 'IMPERIAL_WEIGHT_OUNCE' | 'IMPERIAL_POUND' | 'IMPERIAL_STONE' | 'METRIC_MILLIGRAM' | 'METRIC_GRAM' | 'METRIC_KILOGRAM' — Unit of weight used to measure a quantity. - `generic_unit` 'UNIT' - `time_unit` 'GENERIC_MILLISECOND' | 'GENERIC_SECOND' | 'GENERIC_MINUTE' | 'GENERIC_HOUR' | 'GENERIC_DAY' — Unit of time used to measure a quantity (a duration). - `type` 'TYPE_CUSTOM' | 'TYPE_AREA' | 'TYPE_LENGTH' | 'TYPE_VOLUME' | 'TYPE_WEIGHT' | 'TYPE_GENERIC' — Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum. - `name` string, nullable — UI display name of the measurement unit. For example, 'Pound'. - `abbreviation` string, nullable — UI display abbreviation for the measurement unit. For example, 'lb'. - `language_code` string, nullable — IETF language tag. --- [API](https://skmtc.net/square/apis/connect-api.md) · [All operations](https://skmtc.net/square/apis/connect-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/square/connect-api/versions/6a5164284e41/schema)