{ "info": { "_postman_id": "fc8aa9c3-3f38-47ac-93ff-4103848affd1", "name": "Square ApplePay Catalog API", "description": "Supercharge Square for sellers of every size. Our entire connected commerce platform from elegant hardware to a rich suite of Square APIs is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen. \n\nContact Support:\n Name: Square Developer Platform\n Email: developers@squareup.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "lastUpdatedBy": "35240", "uid": "35240-fc8aa9c3-3f38-47ac-93ff-4103848affd1" }, "item": [ { "name": "v2", "item": [ { "name": "catalog", "item": [ { "name": "batch-delete", "item": [ { "name": "Square Batch Delete Catalog Objects", "id": "e10f8ae7-8bbd-4863-b10a-2e4248ad4862", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"object_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/catalog/batch-delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "batch-delete" ] }, "description": "Deletes a set of [CatalogItem](entity:CatalogItem)s based on the\nprovided list of target IDs and returns a set of successfully deleted IDs in\nthe response. Deletion is a cascading event such that all children of the\ntargeted object are also deleted. For example, deleting a CatalogItem will\nalso delete all of its [CatalogItemVariation](entity:CatalogItemVariation)\nchildren.\n\n`BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted\nIDs can be deleted. The response will only include IDs that were\nactually deleted.\n\nTo ensure consistency, only one delete request is processed at a time per seller account.\nWhile one (batch or non-batch) delete request is being processed, other (batched and non-batched)\ndelete requests are rejected with the `429` error code." }, "response": [ { "id": "31a91520-978f-4396-9934-338a02a0079c", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"object_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/catalog/batch-delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "batch-delete" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"ARRAY_EMPTY\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"UNSUPPORTED_INSTRUMENT_TYPE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"deleted_object_ids\": [\n \"\",\n \"\"\n ],\n \"deleted_at\": \"\"\n}", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-31a91520-978f-4396-9934-338a02a0079c" } ], "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-e10f8ae7-8bbd-4863-b10a-2e4248ad4862" } ], "id": "9d356aaa-4e2d-4831-8ddd-21d86077d054", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-9d356aaa-4e2d-4831-8ddd-21d86077d054" }, { "name": "batch-retrieve", "item": [ { "name": "Square Batch Retrieve Catalog Objects", "id": "1af7a818-baf9-459b-9c28-a3364e9d3950", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"object_ids\": [\n \"\",\n \"\"\n ],\n \"include_related_objects\": \"\",\n \"catalog_version\": \"\",\n \"include_deleted_objects\": \"\",\n \"include_category_path_to_root\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/catalog/batch-retrieve", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "batch-retrieve" ] }, "description": "Returns a set of objects based on the provided ID.\nEach [CatalogItem](entity:CatalogItem) returned in the set includes all of its\nchild information including: all of its\n[CatalogItemVariation](entity:CatalogItemVariation) objects, references to\nits [CatalogModifierList](entity:CatalogModifierList) objects, and the ids of\nany [CatalogTax](entity:CatalogTax) objects that apply to it." }, "response": [ { "id": "c2200084-1c42-415f-89cc-16763760b144", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"object_ids\": [\n \"\",\n \"\"\n ],\n \"include_related_objects\": \"\",\n \"catalog_version\": \"\",\n \"include_deleted_objects\": \"\",\n \"include_category_path_to_root\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/catalog/batch-retrieve", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "batch-retrieve" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"INVALID_FORM_VALUE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"objects\": [\n {\n \"type\": \"IMAGE\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"is_deleted\": \"\",\n \"custom_attribute_values\": {\n \"pariatur660\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"SELECTION\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"eu_fce\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"SELECTION\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"fugiatf8\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"BOOLEAN\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n }\n },\n \"catalog_v1_ids\": [\n {\n \"catalog_v1_id\": \"\",\n \"location_id\": \"\"\n }\n ],\n \"present_at_all_locations\": \"\",\n \"present_at_location_ids\": [\n \"\"\n ],\n \"absent_at_location_ids\": [\n \"\"\n ],\n \"item_data\": {\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"label_color\": \"\",\n \"is_taxable\": \"\",\n \"category_id\": \"\",\n \"tax_ids\": [\n \"\"\n ],\n \"modifier_list_info\": [\n {\n \"modifier_list_id\": \"\",\n \"modifier_overrides\": [\n {\n \"modifier_id\": \"\",\n \"on_by_default\": \"\"\n }\n ],\n \"min_selected_modifiers\": \"\",\n \"max_selected_modifiers\": \"\",\n \"enabled\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"product_type\": \"FOOD_AND_BEV\",\n \"skip_modifier_screen\": \"\",\n \"item_options\": [\n {\n \"item_option_id\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"sort_name\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"description_html\": \"\",\n \"description_plaintext\": \"\",\n \"channels\": [\n \"\"\n ],\n \"is_archived\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"food_and_beverage_details\": {\n \"calorie_count\": \"\",\n \"dietary_preferences\": [\n {\n \"type\": \"CUSTOM\",\n \"standard_name\": \"VEGETARIAN\",\n \"custom_name\": \"\"\n }\n ],\n \"ingredients\": [\n {\n \"type\": \"STANDARD\",\n \"standard_name\": \"GLUTEN\",\n \"custom_name\": \"\"\n }\n ]\n },\n \"reporting_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n },\n \"category_data\": {\n \"name\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"category_type\": \"REGULAR_CATEGORY\",\n \"parent_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n },\n \"is_top_level\": \"\",\n \"channels\": [\n \"\"\n ],\n \"availability_period_ids\": [\n \"\"\n ],\n \"online_visibility\": \"\",\n \"root_category\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"path_to_root\": [\n {\n \"category_id\": \"\",\n \"category_name\": \"\"\n }\n ]\n },\n \"item_variation_data\": {\n \"item_id\": \"\",\n \"name\": \"\",\n \"sku\": \"\",\n \"upc\": \"\",\n \"ordinal\": \"\",\n \"pricing_type\": \"VARIABLE_PRICING\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"JPY\"\n },\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"MVR\"\n },\n \"pricing_type\": \"VARIABLE_PRICING\",\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"LOW_QUANTITY\",\n \"inventory_alert_threshold\": \"\",\n \"sold_out\": \"\",\n \"sold_out_valid_until\": \"\"\n }\n ],\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"NONE\",\n \"inventory_alert_threshold\": \"\",\n \"user_data\": \"\",\n \"service_duration\": \"\",\n \"available_for_booking\": \"\",\n \"item_option_values\": [\n {\n \"item_option_id\": \"\",\n \"item_option_value_id\": \"\"\n }\n ],\n \"measurement_unit_id\": \"\",\n \"sellable\": \"\",\n \"stockable\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"team_member_ids\": [\n \"\"\n ],\n \"stockable_conversion\": {\n \"stockable_item_variation_id\": \"\",\n \"stockable_quantity\": \"\",\n \"nonstockable_quantity\": \"\"\n }\n },\n \"tax_data\": {\n \"name\": \"\",\n \"calculation_phase\": \"TAX_SUBTOTAL_PHASE\",\n \"inclusion_type\": \"INCLUSIVE\",\n \"percentage\": \"\",\n \"applies_to_custom_amounts\": \"\",\n \"enabled\": \"\",\n \"applies_to_product_set_id\": \"\"\n },\n \"discount_data\": {\n \"name\": \"\",\n \"discount_type\": \"VARIABLE_PERCENTAGE\",\n \"percentage\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"SEK\"\n },\n \"pin_required\": \"\",\n \"label_color\": \"\",\n \"modify_tax_basis\": \"MODIFY_TAX_BASIS\",\n \"maximum_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"AWG\"\n }\n },\n \"modifier_list_data\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"selection_type\": \"MULTIPLE\",\n \"modifiers\": [\n {\n \"value\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"modifier_type\": \"TEXT\",\n \"max_length\": \"\",\n \"text_required\": \"\",\n \"internal_name\": \"\"\n },\n \"modifier_data\": {\n \"name\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"DKK\"\n },\n \"ordinal\": \"\",\n \"modifier_list_id\": \"\",\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"EUR\"\n },\n \"sold_out\": \"\"\n }\n ],\n \"image_id\": \"\"\n },\n \"time_period_data\": {\n \"event\": \"\"\n },\n \"product_set_data\": {\n \"name\": \"\",\n \"product_ids_any\": [\n \"\"\n ],\n \"product_ids_all\": [\n \"\"\n ],\n \"quantity_exact\": \"\",\n \"quantity_min\": \"\",\n \"quantity_max\": \"\",\n \"all_products\": \"\"\n },\n \"pricing_rule_data\": {\n \"name\": \"\",\n \"time_period_ids\": [\n \"\"\n ],\n \"discount_id\": \"\",\n \"match_products_id\": \"\",\n \"apply_products_id\": \"\",\n \"exclude_products_id\": \"\",\n \"valid_from_date\": \"\",\n \"valid_from_local_time\": \"\",\n \"valid_until_date\": \"\",\n \"valid_until_local_time\": \"\",\n \"exclude_strategy\": \"MOST_EXPENSIVE\",\n \"minimum_order_subtotal_money\": {\n \"amount\": \"\",\n \"currency\": \"MVR\"\n },\n \"customer_group_ids_any\": [\n \"\"\n ]\n },\n \"image_data\": {\n \"name\": \"\",\n \"url\": \"\",\n \"caption\": \"\",\n \"photo_studio_order_id\": \"\"\n },\n \"measurement_unit_data\": {\n \"measurement_unit\": {\n \"custom_unit\": {\n \"name\": \"\",\n \"abbreviation\": \"\"\n },\n \"area_unit\": \"IMPERIAL_SQUARE_INCH\",\n \"length_unit\": \"METRIC_CENTIMETER\",\n \"volume_unit\": \"IMPERIAL_CUBIC_INCH\",\n \"weight_unit\": \"IMPERIAL_WEIGHT_OUNCE\",\n \"generic_unit\": \"UNIT\",\n \"time_unit\": \"GENERIC_MINUTE\",\n \"type\": \"TYPE_LENGTH\"\n },\n \"precision\": \"\"\n },\n \"subscription_plan_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"SIXTY_DAYS\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"BDT\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"STATIC\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"NAD\"\n }\n }\n }\n ],\n \"subscription_plan_variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"eligible_item_ids\": [\n \"\"\n ],\n \"eligible_category_ids\": [\n \"\"\n ],\n \"all_items\": \"\"\n },\n \"item_option_data\": {\n \"name\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"show_colors\": \"\",\n \"values\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"item_option_value_data\": {\n \"item_option_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"color\": \"\",\n \"ordinal\": \"\"\n },\n \"custom_attribute_definition_data\": {\n \"type\": \"STRING\",\n \"name\": \"\",\n \"allowed_object_types\": [\n \"TAX\"\n ],\n \"description\": \"\",\n \"source_application\": {\n \"product\": \"BILLING\",\n \"application_id\": \"\",\n \"name\": \"\"\n },\n \"seller_visibility\": \"SELLER_VISIBILITY_READ_WRITE_VALUES\",\n \"app_visibility\": \"APP_VISIBILITY_READ_WRITE_VALUES\",\n \"string_config\": {\n \"enforce_uniqueness\": \"\"\n },\n \"number_config\": {\n \"precision\": \"\"\n },\n \"selection_config\": {\n \"max_allowed_selections\": \"\",\n \"allowed_selections\": [\n {\n \"name\": \"\",\n \"uid\": \"\"\n }\n ]\n },\n \"custom_attribute_usage_count\": \"\",\n \"key\": \"MD\"\n },\n \"quick_amounts_settings_data\": {\n \"option\": \"DISABLED\",\n \"eligible_for_auto_amounts\": \"\",\n \"amounts\": [\n {\n \"type\": \"QUICK_AMOUNT_TYPE_MANUAL\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"OMR\"\n },\n \"score\": \"\",\n \"ordinal\": \"\"\n }\n ]\n },\n \"subscription_plan_variation_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"NINETY_DAYS\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"TMT\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"STATIC\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"BIF\"\n }\n }\n }\n ],\n \"subscription_plan_id\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"can_prorate\": \"\",\n \"successor_plan_variation_id\": \"\"\n },\n \"availability_period_data\": {\n \"start_local_time\": \"\",\n \"end_local_time\": \"\",\n \"day_of_week\": \"TUE\"\n }\n }\n ],\n \"related_objects\": [\n {\n \"type\": \"IMAGE\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"is_deleted\": \"\",\n \"custom_attribute_values\": {\n \"sunt4\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"NUMBER\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"temporc\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"NUMBER\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"eud5\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"STRING\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n }\n },\n \"catalog_v1_ids\": [\n {\n \"catalog_v1_id\": \"\",\n \"location_id\": \"\"\n }\n ],\n \"present_at_all_locations\": \"\",\n \"present_at_location_ids\": [\n \"\"\n ],\n \"absent_at_location_ids\": [\n \"\"\n ],\n \"item_data\": {\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"label_color\": \"\",\n \"is_taxable\": \"\",\n \"category_id\": \"\",\n \"tax_ids\": [\n \"\"\n ],\n \"modifier_list_info\": [\n {\n \"modifier_list_id\": \"\",\n \"modifier_overrides\": [\n {\n \"modifier_id\": \"\",\n \"on_by_default\": \"\"\n }\n ],\n \"min_selected_modifiers\": \"\",\n \"max_selected_modifiers\": \"\",\n \"enabled\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"product_type\": \"EVENT\",\n \"skip_modifier_screen\": \"\",\n \"item_options\": [\n {\n \"item_option_id\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"sort_name\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"description_html\": \"\",\n \"description_plaintext\": \"\",\n \"channels\": [\n \"\"\n ],\n \"is_archived\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"food_and_beverage_details\": {\n \"calorie_count\": \"\",\n \"dietary_preferences\": [\n {\n \"type\": \"CUSTOM\",\n \"standard_name\": \"HALAL\",\n \"custom_name\": \"\"\n }\n ],\n \"ingredients\": [\n {\n \"type\": \"CUSTOM\",\n \"standard_name\": \"MUSTARD\",\n \"custom_name\": \"\"\n }\n ]\n },\n \"reporting_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n },\n \"category_data\": {\n \"name\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"category_type\": \"KITCHEN_CATEGORY\",\n \"parent_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n },\n \"is_top_level\": \"\",\n \"channels\": [\n \"\"\n ],\n \"availability_period_ids\": [\n \"\"\n ],\n \"online_visibility\": \"\",\n \"root_category\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"path_to_root\": [\n {\n \"category_id\": \"\",\n \"category_name\": \"\"\n }\n ]\n },\n \"item_variation_data\": {\n \"item_id\": \"\",\n \"name\": \"\",\n \"sku\": \"\",\n \"upc\": \"\",\n \"ordinal\": \"\",\n \"pricing_type\": \"FIXED_PRICING\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"ISK\"\n },\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"RWF\"\n },\n \"pricing_type\": \"FIXED_PRICING\",\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"LOW_QUANTITY\",\n \"inventory_alert_threshold\": \"\",\n \"sold_out\": \"\",\n \"sold_out_valid_until\": \"\"\n }\n ],\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"LOW_QUANTITY\",\n \"inventory_alert_threshold\": \"\",\n \"user_data\": \"\",\n \"service_duration\": \"\",\n \"available_for_booking\": \"\",\n \"item_option_values\": [\n {\n \"item_option_id\": \"\",\n \"item_option_value_id\": \"\"\n }\n ],\n \"measurement_unit_id\": \"\",\n \"sellable\": \"\",\n \"stockable\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"team_member_ids\": [\n \"\"\n ],\n \"stockable_conversion\": {\n \"stockable_item_variation_id\": \"\",\n \"stockable_quantity\": \"\",\n \"nonstockable_quantity\": \"\"\n }\n },\n \"tax_data\": {\n \"name\": \"\",\n \"calculation_phase\": \"TAX_SUBTOTAL_PHASE\",\n \"inclusion_type\": \"ADDITIVE\",\n \"percentage\": \"\",\n \"applies_to_custom_amounts\": \"\",\n \"enabled\": \"\",\n \"applies_to_product_set_id\": \"\"\n },\n \"discount_data\": {\n \"name\": \"\",\n \"discount_type\": \"FIXED_AMOUNT\",\n \"percentage\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"SCR\"\n },\n \"pin_required\": \"\",\n \"label_color\": \"\",\n \"modify_tax_basis\": \"MODIFY_TAX_BASIS\",\n \"maximum_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"SHP\"\n }\n },\n \"modifier_list_data\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"selection_type\": \"SINGLE\",\n \"modifiers\": [\n {\n \"value\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"modifier_type\": \"TEXT\",\n \"max_length\": \"\",\n \"text_required\": \"\",\n \"internal_name\": \"\"\n },\n \"modifier_data\": {\n \"name\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"BTC\"\n },\n \"ordinal\": \"\",\n \"modifier_list_id\": \"\",\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"AFN\"\n },\n \"sold_out\": \"\"\n }\n ],\n \"image_id\": \"\"\n },\n \"time_period_data\": {\n \"event\": \"\"\n },\n \"product_set_data\": {\n \"name\": \"\",\n \"product_ids_any\": [\n \"\"\n ],\n \"product_ids_all\": [\n \"\"\n ],\n \"quantity_exact\": \"\",\n \"quantity_min\": \"\",\n \"quantity_max\": \"\",\n \"all_products\": \"\"\n },\n \"pricing_rule_data\": {\n \"name\": \"\",\n \"time_period_ids\": [\n \"\"\n ],\n \"discount_id\": \"\",\n \"match_products_id\": \"\",\n \"apply_products_id\": \"\",\n \"exclude_products_id\": \"\",\n \"valid_from_date\": \"\",\n \"valid_from_local_time\": \"\",\n \"valid_until_date\": \"\",\n \"valid_until_local_time\": \"\",\n \"exclude_strategy\": \"MOST_EXPENSIVE\",\n \"minimum_order_subtotal_money\": {\n \"amount\": \"\",\n \"currency\": \"MMK\"\n },\n \"customer_group_ids_any\": [\n \"\"\n ]\n },\n \"image_data\": {\n \"name\": \"\",\n \"url\": \"\",\n \"caption\": \"\",\n \"photo_studio_order_id\": \"\"\n },\n \"measurement_unit_data\": {\n \"measurement_unit\": {\n \"custom_unit\": {\n \"name\": \"\",\n \"abbreviation\": \"\"\n },\n \"area_unit\": \"IMPERIAL_SQUARE_MILE\",\n \"length_unit\": \"IMPERIAL_FOOT\",\n \"volume_unit\": \"GENERIC_PINT\",\n \"weight_unit\": \"METRIC_KILOGRAM\",\n \"generic_unit\": \"UNIT\",\n \"time_unit\": \"GENERIC_MINUTE\",\n \"type\": \"TYPE_LENGTH\"\n },\n \"precision\": \"\"\n },\n \"subscription_plan_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"EVERY_TWO_YEARS\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"VND\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"RELATIVE\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"XBC\"\n }\n }\n }\n ],\n \"subscription_plan_variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"eligible_item_ids\": [\n \"\"\n ],\n \"eligible_category_ids\": [\n \"\"\n ],\n \"all_items\": \"\"\n },\n \"item_option_data\": {\n \"name\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"show_colors\": \"\",\n \"values\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"item_option_value_data\": {\n \"item_option_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"color\": \"\",\n \"ordinal\": \"\"\n },\n \"custom_attribute_definition_data\": {\n \"type\": \"NUMBER\",\n \"name\": \"\",\n \"allowed_object_types\": [\n \"AVAILABILITY_PERIOD\"\n ],\n \"description\": \"\",\n \"source_application\": {\n \"product\": \"SQUARE_POS\",\n \"application_id\": \"\",\n \"name\": \"\"\n },\n \"seller_visibility\": \"SELLER_VISIBILITY_READ_WRITE_VALUES\",\n \"app_visibility\": \"APP_VISIBILITY_READ_WRITE_VALUES\",\n \"string_config\": {\n \"enforce_uniqueness\": \"\"\n },\n \"number_config\": {\n \"precision\": \"\"\n },\n \"selection_config\": {\n \"max_allowed_selections\": \"\",\n \"allowed_selections\": [\n {\n \"name\": \"\",\n \"uid\": \"\"\n }\n ]\n },\n \"custom_attribute_usage_count\": \"\",\n \"key\": \"Ge\"\n },\n \"quick_amounts_settings_data\": {\n \"option\": \"AUTO\",\n \"eligible_for_auto_amounts\": \"\",\n \"amounts\": [\n {\n \"type\": \"QUICK_AMOUNT_TYPE_AUTO\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"ILS\"\n },\n \"score\": \"\",\n \"ordinal\": \"\"\n }\n ]\n },\n \"subscription_plan_variation_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"EVERY_TWO_MONTHS\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"XBB\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"STATIC\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"BTC\"\n }\n }\n }\n ],\n \"subscription_plan_id\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"can_prorate\": \"\",\n \"successor_plan_variation_id\": \"\"\n },\n \"availability_period_data\": {\n \"start_local_time\": \"\",\n \"end_local_time\": \"\",\n \"day_of_week\": \"WED\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-c2200084-1c42-415f-89cc-16763760b144" } ], "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-1af7a818-baf9-459b-9c28-a3364e9d3950" } ], "id": "da131f61-a859-4bbd-9973-d6b3630b0d10", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-da131f61-a859-4bbd-9973-d6b3630b0d10" }, { "name": "batch-upsert", "item": [ { "name": "Square Batch Upsert Catalog Objects", "id": "b5341873-b5e5-465e-b9af-2b589f1719dc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"batches\": [\n {\n \"objects\": [\n {\n \"type\": \"PRODUCT_SET\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"is_deleted\": \"\",\n \"custom_attribute_values\": {\n \"aliquip7_\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"SELECTION\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"nostrud1a4\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"STRING\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n }\n },\n \"catalog_v1_ids\": [\n {\n \"catalog_v1_id\": \"\",\n \"location_id\": \"\"\n }\n ],\n \"present_at_all_locations\": \"\",\n \"present_at_location_ids\": [\n \"\"\n ],\n \"absent_at_location_ids\": [\n \"\"\n ],\n \"item_data\": {\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"label_color\": \"\",\n \"is_taxable\": \"\",\n \"category_id\": \"\",\n \"tax_ids\": [\n \"\"\n ],\n \"modifier_list_info\": [\n {\n \"modifier_list_id\": \"\",\n \"modifier_overrides\": [\n {\n \"modifier_id\": \"\",\n \"on_by_default\": \"\"\n }\n ],\n \"min_selected_modifiers\": \"\",\n \"max_selected_modifiers\": \"\",\n \"enabled\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"product_type\": \"DONATION\",\n \"skip_modifier_screen\": \"\",\n \"item_options\": [\n {\n \"item_option_id\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"sort_name\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"description_html\": \"\",\n \"description_plaintext\": \"\",\n \"channels\": [\n \"\"\n ],\n \"is_archived\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"food_and_beverage_details\": {\n \"calorie_count\": \"\",\n \"dietary_preferences\": [\n {\n \"type\": \"STANDARD\",\n \"standard_name\": \"GLUTEN_FREE\",\n \"custom_name\": \"\"\n }\n ],\n \"ingredients\": [\n {\n \"type\": \"CUSTOM\",\n \"standard_name\": \"LUPIN\",\n \"custom_name\": \"\"\n }\n ]\n },\n \"reporting_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n },\n \"category_data\": {\n \"name\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"category_type\": \"KITCHEN_CATEGORY\",\n \"parent_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n },\n \"is_top_level\": \"\",\n \"channels\": [\n \"\"\n ],\n \"availability_period_ids\": [\n \"\"\n ],\n \"online_visibility\": \"\",\n \"root_category\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"path_to_root\": [\n {\n \"category_id\": \"\",\n \"category_name\": \"\"\n }\n ]\n },\n \"item_variation_data\": {\n \"item_id\": \"\",\n \"name\": \"\",\n \"sku\": \"\",\n \"upc\": \"\",\n \"ordinal\": \"\",\n \"pricing_type\": \"VARIABLE_PRICING\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"TOP\"\n },\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"KYD\"\n },\n \"pricing_type\": \"FIXED_PRICING\",\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"NONE\",\n \"inventory_alert_threshold\": \"\",\n \"sold_out\": \"\",\n \"sold_out_valid_until\": \"\"\n }\n ],\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"NONE\",\n \"inventory_alert_threshold\": \"\",\n \"user_data\": \"\",\n \"service_duration\": \"\",\n \"available_for_booking\": \"\",\n \"item_option_values\": [\n {\n \"item_option_id\": \"\",\n \"item_option_value_id\": \"\"\n }\n ],\n \"measurement_unit_id\": \"\",\n \"sellable\": \"\",\n \"stockable\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"team_member_ids\": [\n \"\"\n ],\n \"stockable_conversion\": {\n \"stockable_item_variation_id\": \"\",\n \"stockable_quantity\": \"\",\n \"nonstockable_quantity\": \"\"\n }\n },\n \"tax_data\": {\n \"name\": \"\",\n \"calculation_phase\": \"TAX_TOTAL_PHASE\",\n \"inclusion_type\": \"ADDITIVE\",\n \"percentage\": \"\",\n \"applies_to_custom_amounts\": \"\",\n \"enabled\": \"\",\n \"applies_to_product_set_id\": \"\"\n },\n \"discount_data\": {\n \"name\": \"\",\n \"discount_type\": \"VARIABLE_AMOUNT\",\n \"percentage\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"SDG\"\n },\n \"pin_required\": \"\",\n \"label_color\": \"\",\n \"modify_tax_basis\": \"DO_NOT_MODIFY_TAX_BASIS\",\n \"maximum_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"NZD\"\n }\n },\n \"modifier_list_data\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"selection_type\": \"SINGLE\",\n \"modifiers\": [\n {\n \"value\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"modifier_type\": \"LIST\",\n \"max_length\": \"\",\n \"text_required\": \"\",\n \"internal_name\": \"\"\n },\n \"modifier_data\": {\n \"name\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"BSD\"\n },\n \"ordinal\": \"\",\n \"modifier_list_id\": \"\",\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"TOP\"\n },\n \"sold_out\": \"\"\n }\n ],\n \"image_id\": \"\"\n },\n \"time_period_data\": {\n \"event\": \"\"\n },\n \"product_set_data\": {\n \"name\": \"\",\n \"product_ids_any\": [\n \"\"\n ],\n \"product_ids_all\": [\n \"\"\n ],\n \"quantity_exact\": \"\",\n \"quantity_min\": \"\",\n \"quantity_max\": \"\",\n \"all_products\": \"\"\n },\n \"pricing_rule_data\": {\n \"name\": \"\",\n \"time_period_ids\": [\n \"\"\n ],\n \"discount_id\": \"\",\n \"match_products_id\": \"\",\n \"apply_products_id\": \"\",\n \"exclude_products_id\": \"\",\n \"valid_from_date\": \"\",\n \"valid_from_local_time\": \"\",\n \"valid_until_date\": \"\",\n \"valid_until_local_time\": \"\",\n \"exclude_strategy\": \"MOST_EXPENSIVE\",\n \"minimum_order_subtotal_money\": {\n \"amount\": \"\",\n \"currency\": \"UGX\"\n },\n \"customer_group_ids_any\": [\n \"\"\n ]\n },\n \"image_data\": {\n \"name\": \"\",\n \"url\": \"\",\n \"caption\": \"\",\n \"photo_studio_order_id\": \"\"\n },\n \"measurement_unit_data\": {\n \"measurement_unit\": {\n \"custom_unit\": {\n \"name\": \"\",\n \"abbreviation\": \"\"\n },\n \"area_unit\": \"METRIC_SQUARE_METER\",\n \"length_unit\": \"METRIC_CENTIMETER\",\n \"volume_unit\": \"IMPERIAL_CUBIC_INCH\",\n \"weight_unit\": \"METRIC_GRAM\",\n \"generic_unit\": \"UNIT\",\n \"time_unit\": \"GENERIC_MINUTE\",\n \"type\": \"TYPE_GENERIC\"\n },\n \"precision\": \"\"\n },\n \"subscription_plan_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"QUARTERLY\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"TTD\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"RELATIVE\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"ARS\"\n }\n }\n }\n ],\n \"subscription_plan_variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"eligible_item_ids\": [\n \"\"\n ],\n \"eligible_category_ids\": [\n \"\"\n ],\n \"all_items\": \"\"\n },\n \"item_option_data\": {\n \"name\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"show_colors\": \"\",\n \"values\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"item_option_value_data\": {\n \"item_option_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"color\": \"\",\n \"ordinal\": \"\"\n },\n \"custom_attribute_definition_data\": {\n \"type\": \"SELECTION\",\n \"name\": \"\",\n \"allowed_object_types\": [\n \"TIME_PERIOD\"\n ],\n \"description\": \"\",\n \"source_application\": {\n \"product\": \"ITEM_LIBRARY_IMPORT\",\n \"application_id\": \"\",\n \"name\": \"\"\n },\n \"seller_visibility\": \"SELLER_VISIBILITY_HIDDEN\",\n \"app_visibility\": \"APP_VISIBILITY_READ_ONLY\",\n \"string_config\": {\n \"enforce_uniqueness\": \"\"\n },\n \"number_config\": {\n \"precision\": \"\"\n },\n \"selection_config\": {\n \"max_allowed_selections\": \"\",\n \"allowed_selections\": [\n {\n \"name\": \"\",\n \"uid\": \"\"\n }\n ]\n },\n \"custom_attribute_usage_count\": \"\",\n \"key\": \"huV9\"\n },\n \"quick_amounts_settings_data\": {\n \"option\": \"MANUAL\",\n \"eligible_for_auto_amounts\": \"\",\n \"amounts\": [\n {\n \"type\": \"QUICK_AMOUNT_TYPE_AUTO\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"XDR\"\n },\n \"score\": \"\",\n \"ordinal\": \"\"\n }\n ]\n },\n \"subscription_plan_variation_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"THIRTY_DAYS\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"THB\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"STATIC\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"XCD\"\n }\n }\n }\n ],\n \"subscription_plan_id\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"can_prorate\": \"\",\n \"successor_plan_variation_id\": \"\"\n },\n \"availability_period_data\": {\n \"start_local_time\": \"\",\n \"end_local_time\": \"\",\n \"day_of_week\": \"WED\"\n }\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/catalog/batch-upsert", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "batch-upsert" ] }, "description": "Creates or updates up to 10,000 target objects based on the provided\nlist of objects. The target objects are grouped into batches and each batch is\ninserted/updated in an all-or-nothing manner. If an object within a batch is\nmalformed in some way, or violates a database constraint, the entire batch\ncontaining that item will be disregarded. However, other batches in the same\nrequest may still succeed. Each batch may contain up to 1,000 objects, and\nbatches will be processed in order as long as the total object count for the\nrequest (items, variations, modifier lists, discounts, and taxes) is no more\nthan 10,000.\n\nTo ensure consistency, only one update request is processed at a time per seller account.\nWhile one (batch or non-batch) update request is being processed, other (batched and non-batched)\nupdate requests are rejected with the `429` error code." }, "response": [ { "id": "09f7c458-34c1-4d31-af1f-5d0c78dfa549", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"batches\": [\n {\n \"objects\": [\n {\n \"type\": \"PRODUCT_SET\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"is_deleted\": \"\",\n \"custom_attribute_values\": {\n \"aliquip7_\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"SELECTION\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"nostrud1a4\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"STRING\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n }\n },\n \"catalog_v1_ids\": [\n {\n \"catalog_v1_id\": \"\",\n \"location_id\": \"\"\n }\n ],\n \"present_at_all_locations\": \"\",\n \"present_at_location_ids\": [\n \"\"\n ],\n \"absent_at_location_ids\": [\n \"\"\n ],\n \"item_data\": {\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"label_color\": \"\",\n \"is_taxable\": \"\",\n \"category_id\": \"\",\n \"tax_ids\": [\n \"\"\n ],\n \"modifier_list_info\": [\n {\n \"modifier_list_id\": \"\",\n \"modifier_overrides\": [\n {\n \"modifier_id\": \"\",\n \"on_by_default\": \"\"\n }\n ],\n \"min_selected_modifiers\": \"\",\n \"max_selected_modifiers\": \"\",\n \"enabled\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"product_type\": \"DONATION\",\n \"skip_modifier_screen\": \"\",\n \"item_options\": [\n {\n \"item_option_id\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"sort_name\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"description_html\": \"\",\n \"description_plaintext\": \"\",\n \"channels\": [\n \"\"\n ],\n \"is_archived\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"food_and_beverage_details\": {\n \"calorie_count\": \"\",\n \"dietary_preferences\": [\n {\n \"type\": \"STANDARD\",\n \"standard_name\": \"GLUTEN_FREE\",\n \"custom_name\": \"\"\n }\n ],\n \"ingredients\": [\n {\n \"type\": \"CUSTOM\",\n \"standard_name\": \"LUPIN\",\n \"custom_name\": \"\"\n }\n ]\n },\n \"reporting_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n },\n \"category_data\": {\n \"name\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"category_type\": \"KITCHEN_CATEGORY\",\n \"parent_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n },\n \"is_top_level\": \"\",\n \"channels\": [\n \"\"\n ],\n \"availability_period_ids\": [\n \"\"\n ],\n \"online_visibility\": \"\",\n \"root_category\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"path_to_root\": [\n {\n \"category_id\": \"\",\n \"category_name\": \"\"\n }\n ]\n },\n \"item_variation_data\": {\n \"item_id\": \"\",\n \"name\": \"\",\n \"sku\": \"\",\n \"upc\": \"\",\n \"ordinal\": \"\",\n \"pricing_type\": \"VARIABLE_PRICING\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"TOP\"\n },\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"KYD\"\n },\n \"pricing_type\": \"FIXED_PRICING\",\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"NONE\",\n \"inventory_alert_threshold\": \"\",\n \"sold_out\": \"\",\n \"sold_out_valid_until\": \"\"\n }\n ],\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"NONE\",\n \"inventory_alert_threshold\": \"\",\n \"user_data\": \"\",\n \"service_duration\": \"\",\n \"available_for_booking\": \"\",\n \"item_option_values\": [\n {\n \"item_option_id\": \"\",\n \"item_option_value_id\": \"\"\n }\n ],\n \"measurement_unit_id\": \"\",\n \"sellable\": \"\",\n \"stockable\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"team_member_ids\": [\n \"\"\n ],\n \"stockable_conversion\": {\n \"stockable_item_variation_id\": \"\",\n \"stockable_quantity\": \"\",\n \"nonstockable_quantity\": \"\"\n }\n },\n \"tax_data\": {\n \"name\": \"\",\n \"calculation_phase\": \"TAX_TOTAL_PHASE\",\n \"inclusion_type\": \"ADDITIVE\",\n \"percentage\": \"\",\n \"applies_to_custom_amounts\": \"\",\n \"enabled\": \"\",\n \"applies_to_product_set_id\": \"\"\n },\n \"discount_data\": {\n \"name\": \"\",\n \"discount_type\": \"VARIABLE_AMOUNT\",\n \"percentage\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"SDG\"\n },\n \"pin_required\": \"\",\n \"label_color\": \"\",\n \"modify_tax_basis\": \"DO_NOT_MODIFY_TAX_BASIS\",\n \"maximum_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"NZD\"\n }\n },\n \"modifier_list_data\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"selection_type\": \"SINGLE\",\n \"modifiers\": [\n {\n \"value\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"modifier_type\": \"LIST\",\n \"max_length\": \"\",\n \"text_required\": \"\",\n \"internal_name\": \"\"\n },\n \"modifier_data\": {\n \"name\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"BSD\"\n },\n \"ordinal\": \"\",\n \"modifier_list_id\": \"\",\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"TOP\"\n },\n \"sold_out\": \"\"\n }\n ],\n \"image_id\": \"\"\n },\n \"time_period_data\": {\n \"event\": \"\"\n },\n \"product_set_data\": {\n \"name\": \"\",\n \"product_ids_any\": [\n \"\"\n ],\n \"product_ids_all\": [\n \"\"\n ],\n \"quantity_exact\": \"\",\n \"quantity_min\": \"\",\n \"quantity_max\": \"\",\n \"all_products\": \"\"\n },\n \"pricing_rule_data\": {\n \"name\": \"\",\n \"time_period_ids\": [\n \"\"\n ],\n \"discount_id\": \"\",\n \"match_products_id\": \"\",\n \"apply_products_id\": \"\",\n \"exclude_products_id\": \"\",\n \"valid_from_date\": \"\",\n \"valid_from_local_time\": \"\",\n \"valid_until_date\": \"\",\n \"valid_until_local_time\": \"\",\n \"exclude_strategy\": \"MOST_EXPENSIVE\",\n \"minimum_order_subtotal_money\": {\n \"amount\": \"\",\n \"currency\": \"UGX\"\n },\n \"customer_group_ids_any\": [\n \"\"\n ]\n },\n \"image_data\": {\n \"name\": \"\",\n \"url\": \"\",\n \"caption\": \"\",\n \"photo_studio_order_id\": \"\"\n },\n \"measurement_unit_data\": {\n \"measurement_unit\": {\n \"custom_unit\": {\n \"name\": \"\",\n \"abbreviation\": \"\"\n },\n \"area_unit\": \"METRIC_SQUARE_METER\",\n \"length_unit\": \"METRIC_CENTIMETER\",\n \"volume_unit\": \"IMPERIAL_CUBIC_INCH\",\n \"weight_unit\": \"METRIC_GRAM\",\n \"generic_unit\": \"UNIT\",\n \"time_unit\": \"GENERIC_MINUTE\",\n \"type\": \"TYPE_GENERIC\"\n },\n \"precision\": \"\"\n },\n \"subscription_plan_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"QUARTERLY\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"TTD\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"RELATIVE\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"ARS\"\n }\n }\n }\n ],\n \"subscription_plan_variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"eligible_item_ids\": [\n \"\"\n ],\n \"eligible_category_ids\": [\n \"\"\n ],\n \"all_items\": \"\"\n },\n \"item_option_data\": {\n \"name\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"show_colors\": \"\",\n \"values\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"item_option_value_data\": {\n \"item_option_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"color\": \"\",\n \"ordinal\": \"\"\n },\n \"custom_attribute_definition_data\": {\n \"type\": \"SELECTION\",\n \"name\": \"\",\n \"allowed_object_types\": [\n \"TIME_PERIOD\"\n ],\n \"description\": \"\",\n \"source_application\": {\n \"product\": \"ITEM_LIBRARY_IMPORT\",\n \"application_id\": \"\",\n \"name\": \"\"\n },\n \"seller_visibility\": \"SELLER_VISIBILITY_HIDDEN\",\n \"app_visibility\": \"APP_VISIBILITY_READ_ONLY\",\n \"string_config\": {\n \"enforce_uniqueness\": \"\"\n },\n \"number_config\": {\n \"precision\": \"\"\n },\n \"selection_config\": {\n \"max_allowed_selections\": \"\",\n \"allowed_selections\": [\n {\n \"name\": \"\",\n \"uid\": \"\"\n }\n ]\n },\n \"custom_attribute_usage_count\": \"\",\n \"key\": \"huV9\"\n },\n \"quick_amounts_settings_data\": {\n \"option\": \"MANUAL\",\n \"eligible_for_auto_amounts\": \"\",\n \"amounts\": [\n {\n \"type\": \"QUICK_AMOUNT_TYPE_AUTO\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"XDR\"\n },\n \"score\": \"\",\n \"ordinal\": \"\"\n }\n ]\n },\n \"subscription_plan_variation_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"THIRTY_DAYS\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"THB\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"STATIC\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"XCD\"\n }\n }\n }\n ],\n \"subscription_plan_id\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"can_prorate\": \"\",\n \"successor_plan_variation_id\": \"\"\n },\n \"availability_period_data\": {\n \"start_local_time\": \"\",\n \"end_local_time\": \"\",\n \"day_of_week\": \"WED\"\n }\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/catalog/batch-upsert", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "batch-upsert" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"CHECKOUT_EXPIRED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"objects\": [\n {\n \"type\": \"CUSTOM_ATTRIBUTE_DEFINITION\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"is_deleted\": \"\",\n \"custom_attribute_values\": {\n \"Ut_ac0\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"NUMBER\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"sint_e1\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"STRING\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"Duis3f_\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"BOOLEAN\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n }\n },\n \"catalog_v1_ids\": [\n {\n \"catalog_v1_id\": \"\",\n \"location_id\": \"\"\n }\n ],\n \"present_at_all_locations\": \"\",\n \"present_at_location_ids\": [\n \"\"\n ],\n \"absent_at_location_ids\": [\n \"\"\n ],\n \"item_data\": {\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"label_color\": \"\",\n \"is_taxable\": \"\",\n \"category_id\": \"\",\n \"tax_ids\": [\n \"\"\n ],\n \"modifier_list_info\": [\n {\n \"modifier_list_id\": \"\",\n \"modifier_overrides\": [\n {\n \"modifier_id\": \"\",\n \"on_by_default\": \"\"\n }\n ],\n \"min_selected_modifiers\": \"\",\n \"max_selected_modifiers\": \"\",\n \"enabled\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"product_type\": \"EVENT\",\n \"skip_modifier_screen\": \"\",\n \"item_options\": [\n {\n \"item_option_id\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"sort_name\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"description_html\": \"\",\n \"description_plaintext\": \"\",\n \"channels\": [\n \"\"\n ],\n \"is_archived\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"food_and_beverage_details\": {\n \"calorie_count\": \"\",\n \"dietary_preferences\": [\n {\n \"type\": \"CUSTOM\",\n \"standard_name\": \"GLUTEN_FREE\",\n \"custom_name\": \"\"\n }\n ],\n \"ingredients\": [\n {\n \"type\": \"STANDARD\",\n \"standard_name\": \"LUPIN\",\n \"custom_name\": \"\"\n }\n ]\n },\n \"reporting_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n },\n \"category_data\": {\n \"name\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"category_type\": \"REGULAR_CATEGORY\",\n \"parent_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n },\n \"is_top_level\": \"\",\n \"channels\": [\n \"\"\n ],\n \"availability_period_ids\": [\n \"\"\n ],\n \"online_visibility\": \"\",\n \"root_category\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"path_to_root\": [\n {\n \"category_id\": \"\",\n \"category_name\": \"\"\n }\n ]\n },\n \"item_variation_data\": {\n \"item_id\": \"\",\n \"name\": \"\",\n \"sku\": \"\",\n \"upc\": \"\",\n \"ordinal\": \"\",\n \"pricing_type\": \"VARIABLE_PRICING\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"XBA\"\n },\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"XAU\"\n },\n \"pricing_type\": \"VARIABLE_PRICING\",\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"NONE\",\n \"inventory_alert_threshold\": \"\",\n \"sold_out\": \"\",\n \"sold_out_valid_until\": \"\"\n }\n ],\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"LOW_QUANTITY\",\n \"inventory_alert_threshold\": \"\",\n \"user_data\": \"\",\n \"service_duration\": \"\",\n \"available_for_booking\": \"\",\n \"item_option_values\": [\n {\n \"item_option_id\": \"\",\n \"item_option_value_id\": \"\"\n }\n ],\n \"measurement_unit_id\": \"\",\n \"sellable\": \"\",\n \"stockable\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"team_member_ids\": [\n \"\"\n ],\n \"stockable_conversion\": {\n \"stockable_item_variation_id\": \"\",\n \"stockable_quantity\": \"\",\n \"nonstockable_quantity\": \"\"\n }\n },\n \"tax_data\": {\n \"name\": \"\",\n \"calculation_phase\": \"TAX_SUBTOTAL_PHASE\",\n \"inclusion_type\": \"ADDITIVE\",\n \"percentage\": \"\",\n \"applies_to_custom_amounts\": \"\",\n \"enabled\": \"\",\n \"applies_to_product_set_id\": \"\"\n },\n \"discount_data\": {\n \"name\": \"\",\n \"discount_type\": \"VARIABLE_PERCENTAGE\",\n \"percentage\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"JOD\"\n },\n \"pin_required\": \"\",\n \"label_color\": \"\",\n \"modify_tax_basis\": \"MODIFY_TAX_BASIS\",\n \"maximum_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"TRY\"\n }\n },\n \"modifier_list_data\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"selection_type\": \"SINGLE\",\n \"modifiers\": [\n {\n \"value\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"modifier_type\": \"TEXT\",\n \"max_length\": \"\",\n \"text_required\": \"\",\n \"internal_name\": \"\"\n },\n \"modifier_data\": {\n \"name\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"XXX\"\n },\n \"ordinal\": \"\",\n \"modifier_list_id\": \"\",\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"IRR\"\n },\n \"sold_out\": \"\"\n }\n ],\n \"image_id\": \"\"\n },\n \"time_period_data\": {\n \"event\": \"\"\n },\n \"product_set_data\": {\n \"name\": \"\",\n \"product_ids_any\": [\n \"\"\n ],\n \"product_ids_all\": [\n \"\"\n ],\n \"quantity_exact\": \"\",\n \"quantity_min\": \"\",\n \"quantity_max\": \"\",\n \"all_products\": \"\"\n },\n \"pricing_rule_data\": {\n \"name\": \"\",\n \"time_period_ids\": [\n \"\"\n ],\n \"discount_id\": \"\",\n \"match_products_id\": \"\",\n \"apply_products_id\": \"\",\n \"exclude_products_id\": \"\",\n \"valid_from_date\": \"\",\n \"valid_from_local_time\": \"\",\n \"valid_until_date\": \"\",\n \"valid_until_local_time\": \"\",\n \"exclude_strategy\": \"LEAST_EXPENSIVE\",\n \"minimum_order_subtotal_money\": {\n \"amount\": \"\",\n \"currency\": \"RON\"\n },\n \"customer_group_ids_any\": [\n \"\"\n ]\n },\n \"image_data\": {\n \"name\": \"\",\n \"url\": \"\",\n \"caption\": \"\",\n \"photo_studio_order_id\": \"\"\n },\n \"measurement_unit_data\": {\n \"measurement_unit\": {\n \"custom_unit\": {\n \"name\": \"\",\n \"abbreviation\": \"\"\n },\n \"area_unit\": \"IMPERIAL_SQUARE_YARD\",\n \"length_unit\": \"METRIC_KILOMETER\",\n \"volume_unit\": \"GENERIC_CUP\",\n \"weight_unit\": \"IMPERIAL_WEIGHT_OUNCE\",\n \"generic_unit\": \"UNIT\",\n \"time_unit\": \"GENERIC_HOUR\",\n \"type\": \"TYPE_WEIGHT\"\n },\n \"precision\": \"\"\n },\n \"subscription_plan_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"DAILY\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"DZD\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"STATIC\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"MRO\"\n }\n }\n }\n ],\n \"subscription_plan_variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"eligible_item_ids\": [\n \"\"\n ],\n \"eligible_category_ids\": [\n \"\"\n ],\n \"all_items\": \"\"\n },\n \"item_option_data\": {\n \"name\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"show_colors\": \"\",\n \"values\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"item_option_value_data\": {\n \"item_option_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"color\": \"\",\n \"ordinal\": \"\"\n },\n \"custom_attribute_definition_data\": {\n \"type\": \"NUMBER\",\n \"name\": \"\",\n \"allowed_object_types\": [\n \"MODIFIER_LIST\"\n ],\n \"description\": \"\",\n \"source_application\": {\n \"product\": \"OTHER\",\n \"application_id\": \"\",\n \"name\": \"\"\n },\n \"seller_visibility\": \"SELLER_VISIBILITY_READ_WRITE_VALUES\",\n \"app_visibility\": \"APP_VISIBILITY_READ_ONLY\",\n \"string_config\": {\n \"enforce_uniqueness\": \"\"\n },\n \"number_config\": {\n \"precision\": \"\"\n },\n \"selection_config\": {\n \"max_allowed_selections\": \"\",\n \"allowed_selections\": [\n {\n \"name\": \"\",\n \"uid\": \"\"\n }\n ]\n },\n \"custom_attribute_usage_count\": \"\",\n \"key\": \"1T7\"\n },\n \"quick_amounts_settings_data\": {\n \"option\": \"DISABLED\",\n \"eligible_for_auto_amounts\": \"\",\n \"amounts\": [\n {\n \"type\": \"QUICK_AMOUNT_TYPE_AUTO\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"ETB\"\n },\n \"score\": \"\",\n \"ordinal\": \"\"\n }\n ]\n },\n \"subscription_plan_variation_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"THIRTY_DAYS\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"SGD\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"RELATIVE\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"NIO\"\n }\n }\n }\n ],\n \"subscription_plan_id\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"can_prorate\": \"\",\n \"successor_plan_variation_id\": \"\"\n },\n \"availability_period_data\": {\n \"start_local_time\": \"\",\n \"end_local_time\": \"\",\n \"day_of_week\": \"TUE\"\n }\n }\n ],\n \"updated_at\": \"\",\n \"id_mappings\": [\n {\n \"client_object_id\": \"\",\n \"object_id\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-09f7c458-34c1-4d31-af1f-5d0c78dfa549" } ], "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-b5341873-b5e5-465e-b9af-2b589f1719dc" } ], "id": "e2816744-dd95-4ffb-89d1-ff6a2ac33884", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-e2816744-dd95-4ffb-89d1-ff6a2ac33884" }, { "name": "images", "item": [ { "name": "{image_id}", "item": [ { "name": "Square Update Catalog Image", "id": "9354d48e-cf01-402f-96b0-8a257aeb5d3e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "request", "value": "[object Object]", "type": "text", "contentType": "application/json; charset=utf-8" }, { "key": "image_file", "type": "file", "contentType": "image/jpeg", "value": null } ] }, "url": { "raw": "{{baseUrl}}/v2/catalog/images/:image_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "images", ":image_id" ], "variable": [ { "id": "ad31abef-f4b1-416c-a1cf-81f1f8ecd22a", "key": "image_id", "value": "", "description": "(Required) The ID of the `CatalogImage` object to update the encapsulated image file." } ] }, "description": "Uploads a new image file to replace the existing one in the specified [CatalogImage](entity:CatalogImage) object.\n\nThis `UpdateCatalogImage` endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in\nJPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB." }, "response": [ { "id": "7849bceb-5b8d-4cf9-bdb8-d20c04a04463", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "request", "value": "[object Object]", "type": "text", "contentType": "application/json; charset=utf-8" }, { "key": "image_file", "type": "file", "contentType": "image/jpeg" } ] }, "url": { "raw": "{{baseUrl}}/v2/catalog/images/:image_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "images", ":image_id" ], "variable": [ { "key": "image_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"CARD_PRESENCE_REQUIRED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"image\": {\n \"type\": \"SUBSCRIPTION_PLAN\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"is_deleted\": \"\",\n \"custom_attribute_values\": {\n \"deserunt_3c\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"STRING\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n }\n },\n \"catalog_v1_ids\": [\n {\n \"catalog_v1_id\": \"\",\n \"location_id\": \"\"\n }\n ],\n \"present_at_all_locations\": \"\",\n \"present_at_location_ids\": [\n \"\"\n ],\n \"absent_at_location_ids\": [\n \"\"\n ],\n \"item_data\": {\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"label_color\": \"\",\n \"is_taxable\": \"\",\n \"category_id\": \"\",\n \"tax_ids\": [\n \"\"\n ],\n \"modifier_list_info\": [\n {\n \"modifier_list_id\": \"\",\n \"modifier_overrides\": [\n {\n \"modifier_id\": \"\",\n \"on_by_default\": \"\"\n }\n ],\n \"min_selected_modifiers\": \"\",\n \"max_selected_modifiers\": \"\",\n \"enabled\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"product_type\": \"GIFT_CARD\",\n \"skip_modifier_screen\": \"\",\n \"item_options\": [\n {\n \"item_option_id\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"sort_name\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"description_html\": \"\",\n \"description_plaintext\": \"\",\n \"channels\": [\n \"\"\n ],\n \"is_archived\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"food_and_beverage_details\": {\n \"calorie_count\": \"\",\n \"dietary_preferences\": [\n {\n \"type\": \"STANDARD\",\n \"standard_name\": \"NUT_FREE\",\n \"custom_name\": \"\"\n }\n ],\n \"ingredients\": [\n {\n \"type\": \"CUSTOM\",\n \"standard_name\": \"MOLLUSCS\",\n \"custom_name\": \"\"\n }\n ]\n },\n \"reporting_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n },\n \"category_data\": {\n \"name\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"category_type\": \"REGULAR_CATEGORY\",\n \"parent_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n },\n \"is_top_level\": \"\",\n \"channels\": [\n \"\"\n ],\n \"availability_period_ids\": [\n \"\"\n ],\n \"online_visibility\": \"\",\n \"root_category\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"path_to_root\": [\n {\n \"category_id\": \"\",\n \"category_name\": \"\"\n }\n ]\n },\n \"item_variation_data\": {\n \"item_id\": \"\",\n \"name\": \"\",\n \"sku\": \"\",\n \"upc\": \"\",\n \"ordinal\": \"\",\n \"pricing_type\": \"VARIABLE_PRICING\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"WST\"\n },\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"RSD\"\n },\n \"pricing_type\": \"VARIABLE_PRICING\",\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"LOW_QUANTITY\",\n \"inventory_alert_threshold\": \"\",\n \"sold_out\": \"\",\n \"sold_out_valid_until\": \"\"\n }\n ],\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"NONE\",\n \"inventory_alert_threshold\": \"\",\n \"user_data\": \"\",\n \"service_duration\": \"\",\n \"available_for_booking\": \"\",\n \"item_option_values\": [\n {\n \"item_option_id\": \"\",\n \"item_option_value_id\": \"\"\n }\n ],\n \"measurement_unit_id\": \"\",\n \"sellable\": \"\",\n \"stockable\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"team_member_ids\": [\n \"\"\n ],\n \"stockable_conversion\": {\n \"stockable_item_variation_id\": \"\",\n \"stockable_quantity\": \"\",\n \"nonstockable_quantity\": \"\"\n }\n },\n \"tax_data\": {\n \"name\": \"\",\n \"calculation_phase\": \"TAX_TOTAL_PHASE\",\n \"inclusion_type\": \"ADDITIVE\",\n \"percentage\": \"\",\n \"applies_to_custom_amounts\": \"\",\n \"enabled\": \"\",\n \"applies_to_product_set_id\": \"\"\n },\n \"discount_data\": {\n \"name\": \"\",\n \"discount_type\": \"FIXED_PERCENTAGE\",\n \"percentage\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"PAB\"\n },\n \"pin_required\": \"\",\n \"label_color\": \"\",\n \"modify_tax_basis\": \"DO_NOT_MODIFY_TAX_BASIS\",\n \"maximum_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"ANG\"\n }\n },\n \"modifier_list_data\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"selection_type\": \"SINGLE\",\n \"modifiers\": [\n {\n \"value\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"modifier_type\": \"TEXT\",\n \"max_length\": \"\",\n \"text_required\": \"\",\n \"internal_name\": \"\"\n },\n \"modifier_data\": {\n \"name\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"AZN\"\n },\n \"ordinal\": \"\",\n \"modifier_list_id\": \"\",\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"KPW\"\n },\n \"sold_out\": \"\"\n }\n ],\n \"image_id\": \"\"\n },\n \"time_period_data\": {\n \"event\": \"\"\n },\n \"product_set_data\": {\n \"name\": \"\",\n \"product_ids_any\": [\n \"\"\n ],\n \"product_ids_all\": [\n \"\"\n ],\n \"quantity_exact\": \"\",\n \"quantity_min\": \"\",\n \"quantity_max\": \"\",\n \"all_products\": \"\"\n },\n \"pricing_rule_data\": {\n \"name\": \"\",\n \"time_period_ids\": [\n \"\"\n ],\n \"discount_id\": \"\",\n \"match_products_id\": \"\",\n \"apply_products_id\": \"\",\n \"exclude_products_id\": \"\",\n \"valid_from_date\": \"\",\n \"valid_from_local_time\": \"\",\n \"valid_until_date\": \"\",\n \"valid_until_local_time\": \"\",\n \"exclude_strategy\": \"MOST_EXPENSIVE\",\n \"minimum_order_subtotal_money\": {\n \"amount\": \"\",\n \"currency\": \"MDL\"\n },\n \"customer_group_ids_any\": [\n \"\"\n ]\n },\n \"image_data\": {\n \"name\": \"\",\n \"url\": \"\",\n \"caption\": \"\",\n \"photo_studio_order_id\": \"\"\n },\n \"measurement_unit_data\": {\n \"measurement_unit\": {\n \"custom_unit\": {\n \"name\": \"\",\n \"abbreviation\": \"\"\n },\n \"area_unit\": \"METRIC_SQUARE_CENTIMETER\",\n \"length_unit\": \"IMPERIAL_INCH\",\n \"volume_unit\": \"IMPERIAL_CUBIC_FOOT\",\n \"weight_unit\": \"METRIC_MILLIGRAM\",\n \"generic_unit\": \"UNIT\",\n \"time_unit\": \"GENERIC_DAY\",\n \"type\": \"TYPE_VOLUME\"\n },\n \"precision\": \"\"\n },\n \"subscription_plan_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"EVERY_SIX_MONTHS\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"PLN\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"RELATIVE\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"PEN\"\n }\n }\n }\n ],\n \"subscription_plan_variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"eligible_item_ids\": [\n \"\"\n ],\n \"eligible_category_ids\": [\n \"\"\n ],\n \"all_items\": \"\"\n },\n \"item_option_data\": {\n \"name\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"show_colors\": \"\",\n \"values\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"item_option_value_data\": {\n \"item_option_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"color\": \"\",\n \"ordinal\": \"\"\n },\n \"custom_attribute_definition_data\": {\n \"type\": \"BOOLEAN\",\n \"name\": \"\",\n \"allowed_object_types\": [\n \"ITEM_OPTION\"\n ],\n \"description\": \"\",\n \"source_application\": {\n \"product\": \"ITEM_LIBRARY_IMPORT\",\n \"application_id\": \"\",\n \"name\": \"\"\n },\n \"seller_visibility\": \"SELLER_VISIBILITY_READ_WRITE_VALUES\",\n \"app_visibility\": \"APP_VISIBILITY_READ_ONLY\",\n \"string_config\": {\n \"enforce_uniqueness\": \"\"\n },\n \"number_config\": {\n \"precision\": \"\"\n },\n \"selection_config\": {\n \"max_allowed_selections\": \"\",\n \"allowed_selections\": [\n {\n \"name\": \"\",\n \"uid\": \"\"\n }\n ]\n },\n \"custom_attribute_usage_count\": \"\",\n \"key\": \"B5kAbwGB\"\n },\n \"quick_amounts_settings_data\": {\n \"option\": \"AUTO\",\n \"eligible_for_auto_amounts\": \"\",\n \"amounts\": [\n {\n \"type\": \"QUICK_AMOUNT_TYPE_AUTO\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"MXV\"\n },\n \"score\": \"\",\n \"ordinal\": \"\"\n }\n ]\n },\n \"subscription_plan_variation_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"SIXTY_DAYS\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"GEL\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"RELATIVE\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"GHS\"\n }\n }\n }\n ],\n \"subscription_plan_id\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"can_prorate\": \"\",\n \"successor_plan_variation_id\": \"\"\n },\n \"availability_period_data\": {\n \"start_local_time\": \"\",\n \"end_local_time\": \"\",\n \"day_of_week\": \"MON\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-7849bceb-5b8d-4cf9-bdb8-d20c04a04463" } ], "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-9354d48e-cf01-402f-96b0-8a257aeb5d3e" } ], "id": "ded48a13-a4d9-4841-bb50-b9ce863895a6", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-ded48a13-a4d9-4841-bb50-b9ce863895a6" }, { "name": "Square Create Catalog Image", "id": "1d131e39-ea7a-4e12-8e0f-cb34428cb129", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "request", "value": "[object Object]", "type": "text", "contentType": "application/json; charset=utf-8" }, { "key": "image_file", "type": "file", "contentType": "image/jpeg", "value": null } ] }, "url": { "raw": "{{baseUrl}}/v2/catalog/images", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "images" ] }, "description": "Uploads an image file to be represented by a [CatalogImage](entity:CatalogImage) object that can be linked to an existing\n[CatalogObject](entity:CatalogObject) instance. The resulting `CatalogImage` is unattached to any `CatalogObject` if the `object_id`\nis not specified.\n\nThis `CreateCatalogImage` endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in\nJPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB." }, "response": [ { "id": "0d96efd4-c345-48b5-b1a4-0a0d508bf48e", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "request", "value": "[object Object]", "type": "text", "contentType": "application/json; charset=utf-8" }, { "key": "image_file", "type": "file", "contentType": "image/jpeg" } ] }, "url": { "raw": "{{baseUrl}}/v2/catalog/images", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "images" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"REFUND_ERROR\",\n \"code\": \"MISSING_PIN\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"image\": {\n \"type\": \"CUSTOM_ATTRIBUTE_DEFINITION\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"is_deleted\": \"\",\n \"custom_attribute_values\": {\n \"dolor49\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"BOOLEAN\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"nisi_73\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"BOOLEAN\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"nisid01\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"STRING\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n }\n },\n \"catalog_v1_ids\": [\n {\n \"catalog_v1_id\": \"\",\n \"location_id\": \"\"\n }\n ],\n \"present_at_all_locations\": \"\",\n \"present_at_location_ids\": [\n \"\"\n ],\n \"absent_at_location_ids\": [\n \"\"\n ],\n \"item_data\": {\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"label_color\": \"\",\n \"is_taxable\": \"\",\n \"category_id\": \"\",\n \"tax_ids\": [\n \"\"\n ],\n \"modifier_list_info\": [\n {\n \"modifier_list_id\": \"\",\n \"modifier_overrides\": [\n {\n \"modifier_id\": \"\",\n \"on_by_default\": \"\"\n }\n ],\n \"min_selected_modifiers\": \"\",\n \"max_selected_modifiers\": \"\",\n \"enabled\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"product_type\": \"LEGACY_SQUARE_ONLINE_MEMBERSHIP\",\n \"skip_modifier_screen\": \"\",\n \"item_options\": [\n {\n \"item_option_id\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"sort_name\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"description_html\": \"\",\n \"description_plaintext\": \"\",\n \"channels\": [\n \"\"\n ],\n \"is_archived\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"food_and_beverage_details\": {\n \"calorie_count\": \"\",\n \"dietary_preferences\": [\n {\n \"type\": \"STANDARD\",\n \"standard_name\": \"KOSHER\",\n \"custom_name\": \"\"\n }\n ],\n \"ingredients\": [\n {\n \"type\": \"STANDARD\",\n \"standard_name\": \"PEANUTS\",\n \"custom_name\": \"\"\n }\n ]\n },\n \"reporting_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n },\n \"category_data\": {\n \"name\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"category_type\": \"KITCHEN_CATEGORY\",\n \"parent_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n },\n \"is_top_level\": \"\",\n \"channels\": [\n \"\"\n ],\n \"availability_period_ids\": [\n \"\"\n ],\n \"online_visibility\": \"\",\n \"root_category\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"path_to_root\": [\n {\n \"category_id\": \"\",\n \"category_name\": \"\"\n }\n ]\n },\n \"item_variation_data\": {\n \"item_id\": \"\",\n \"name\": \"\",\n \"sku\": \"\",\n \"upc\": \"\",\n \"ordinal\": \"\",\n \"pricing_type\": \"VARIABLE_PRICING\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"DOP\"\n },\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"SLL\"\n },\n \"pricing_type\": \"FIXED_PRICING\",\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"LOW_QUANTITY\",\n \"inventory_alert_threshold\": \"\",\n \"sold_out\": \"\",\n \"sold_out_valid_until\": \"\"\n }\n ],\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"NONE\",\n \"inventory_alert_threshold\": \"\",\n \"user_data\": \"\",\n \"service_duration\": \"\",\n \"available_for_booking\": \"\",\n \"item_option_values\": [\n {\n \"item_option_id\": \"\",\n \"item_option_value_id\": \"\"\n }\n ],\n \"measurement_unit_id\": \"\",\n \"sellable\": \"\",\n \"stockable\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"team_member_ids\": [\n \"\"\n ],\n \"stockable_conversion\": {\n \"stockable_item_variation_id\": \"\",\n \"stockable_quantity\": \"\",\n \"nonstockable_quantity\": \"\"\n }\n },\n \"tax_data\": {\n \"name\": \"\",\n \"calculation_phase\": \"TAX_SUBTOTAL_PHASE\",\n \"inclusion_type\": \"INCLUSIVE\",\n \"percentage\": \"\",\n \"applies_to_custom_amounts\": \"\",\n \"enabled\": \"\",\n \"applies_to_product_set_id\": \"\"\n },\n \"discount_data\": {\n \"name\": \"\",\n \"discount_type\": \"VARIABLE_AMOUNT\",\n \"percentage\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"BIF\"\n },\n \"pin_required\": \"\",\n \"label_color\": \"\",\n \"modify_tax_basis\": \"DO_NOT_MODIFY_TAX_BASIS\",\n \"maximum_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"PLN\"\n }\n },\n \"modifier_list_data\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"selection_type\": \"SINGLE\",\n \"modifiers\": [\n {\n \"value\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"modifier_type\": \"TEXT\",\n \"max_length\": \"\",\n \"text_required\": \"\",\n \"internal_name\": \"\"\n },\n \"modifier_data\": {\n \"name\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"CRC\"\n },\n \"ordinal\": \"\",\n \"modifier_list_id\": \"\",\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"NOK\"\n },\n \"sold_out\": \"\"\n }\n ],\n \"image_id\": \"\"\n },\n \"time_period_data\": {\n \"event\": \"\"\n },\n \"product_set_data\": {\n \"name\": \"\",\n \"product_ids_any\": [\n \"\"\n ],\n \"product_ids_all\": [\n \"\"\n ],\n \"quantity_exact\": \"\",\n \"quantity_min\": \"\",\n \"quantity_max\": \"\",\n \"all_products\": \"\"\n },\n \"pricing_rule_data\": {\n \"name\": \"\",\n \"time_period_ids\": [\n \"\"\n ],\n \"discount_id\": \"\",\n \"match_products_id\": \"\",\n \"apply_products_id\": \"\",\n \"exclude_products_id\": \"\",\n \"valid_from_date\": \"\",\n \"valid_from_local_time\": \"\",\n \"valid_until_date\": \"\",\n \"valid_until_local_time\": \"\",\n \"exclude_strategy\": \"LEAST_EXPENSIVE\",\n \"minimum_order_subtotal_money\": {\n \"amount\": \"\",\n \"currency\": \"RWF\"\n },\n \"customer_group_ids_any\": [\n \"\"\n ]\n },\n \"image_data\": {\n \"name\": \"\",\n \"url\": \"\",\n \"caption\": \"\",\n \"photo_studio_order_id\": \"\"\n },\n \"measurement_unit_data\": {\n \"measurement_unit\": {\n \"custom_unit\": {\n \"name\": \"\",\n \"abbreviation\": \"\"\n },\n \"area_unit\": \"IMPERIAL_SQUARE_INCH\",\n \"length_unit\": \"IMPERIAL_YARD\",\n \"volume_unit\": \"METRIC_MILLILITER\",\n \"weight_unit\": \"METRIC_KILOGRAM\",\n \"generic_unit\": \"UNIT\",\n \"time_unit\": \"GENERIC_DAY\",\n \"type\": \"TYPE_LENGTH\"\n },\n \"precision\": \"\"\n },\n \"subscription_plan_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"DAILY\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"KGS\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"STATIC\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"EGP\"\n }\n }\n }\n ],\n \"subscription_plan_variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"eligible_item_ids\": [\n \"\"\n ],\n \"eligible_category_ids\": [\n \"\"\n ],\n \"all_items\": \"\"\n },\n \"item_option_data\": {\n \"name\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"show_colors\": \"\",\n \"values\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"item_option_value_data\": {\n \"item_option_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"color\": \"\",\n \"ordinal\": \"\"\n },\n \"custom_attribute_definition_data\": {\n \"type\": \"STRING\",\n \"name\": \"\",\n \"allowed_object_types\": [\n \"CATEGORY\"\n ],\n \"description\": \"\",\n \"source_application\": {\n \"product\": \"EXTERNAL_API\",\n \"application_id\": \"\",\n \"name\": \"\"\n },\n \"seller_visibility\": \"SELLER_VISIBILITY_READ_WRITE_VALUES\",\n \"app_visibility\": \"APP_VISIBILITY_READ_WRITE_VALUES\",\n \"string_config\": {\n \"enforce_uniqueness\": \"\"\n },\n \"number_config\": {\n \"precision\": \"\"\n },\n \"selection_config\": {\n \"max_allowed_selections\": \"\",\n \"allowed_selections\": [\n {\n \"name\": \"\",\n \"uid\": \"\"\n }\n ]\n },\n \"custom_attribute_usage_count\": \"\",\n \"key\": \" \"\n },\n \"quick_amounts_settings_data\": {\n \"option\": \"MANUAL\",\n \"eligible_for_auto_amounts\": \"\",\n \"amounts\": [\n {\n \"type\": \"QUICK_AMOUNT_TYPE_MANUAL\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"LBP\"\n },\n \"score\": \"\",\n \"ordinal\": \"\"\n }\n ]\n },\n \"subscription_plan_variation_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"WEEKLY\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"KHR\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"STATIC\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"BHD\"\n }\n }\n }\n ],\n \"subscription_plan_id\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"can_prorate\": \"\",\n \"successor_plan_variation_id\": \"\"\n },\n \"availability_period_data\": {\n \"start_local_time\": \"\",\n \"end_local_time\": \"\",\n \"day_of_week\": \"SAT\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-0d96efd4-c345-48b5-b1a4-0a0d508bf48e" } ], "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-1d131e39-ea7a-4e12-8e0f-cb34428cb129" } ], "id": "6329987c-6ea2-47a2-b580-f16d9748cf22", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-6329987c-6ea2-47a2-b580-f16d9748cf22" }, { "name": "info", "item": [ { "name": "Square Catalog Info", "id": "a26091f6-bd63-4921-a9c1-3c31bfeab2dd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/catalog/info", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "info" ] }, "description": "Retrieves information about the Square Catalog API, such as batch size\nlimits that can be used by the `BatchUpsertCatalogObjects` endpoint." }, "response": [ { "id": "54356558-28b2-462f-b05f-c21f8bf0b61c", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/catalog/info", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "info" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"CUSTOMER_MISSING_NAME\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"REFUND_ERROR\",\n \"code\": \"MAP_KEY_LENGTH_TOO_SHORT\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"limits\": {\n \"batch_upsert_max_objects_per_batch\": \"\",\n \"batch_upsert_max_total_objects\": \"\",\n \"batch_retrieve_max_object_ids\": \"\",\n \"search_max_page_limit\": \"\",\n \"batch_delete_max_object_ids\": \"\",\n \"update_item_taxes_max_item_ids\": \"\",\n \"update_item_taxes_max_taxes_to_enable\": \"\",\n \"update_item_taxes_max_taxes_to_disable\": \"\",\n \"update_item_modifier_lists_max_item_ids\": \"\",\n \"update_item_modifier_lists_max_modifier_lists_to_enable\": \"\",\n \"update_item_modifier_lists_max_modifier_lists_to_disable\": \"\"\n },\n \"standard_unit_description_group\": {\n \"standard_unit_descriptions\": [\n {\n \"unit\": {\n \"custom_unit\": {\n \"name\": \"\",\n \"abbreviation\": \"\"\n },\n \"area_unit\": \"METRIC_SQUARE_METER\",\n \"length_unit\": \"IMPERIAL_INCH\",\n \"volume_unit\": \"GENERIC_PINT\",\n \"weight_unit\": \"METRIC_MILLIGRAM\",\n \"generic_unit\": \"UNIT\",\n \"time_unit\": \"GENERIC_DAY\",\n \"type\": \"TYPE_AREA\"\n },\n \"name\": \"\",\n \"abbreviation\": \"\"\n },\n {\n \"unit\": {\n \"custom_unit\": {\n \"name\": \"\",\n \"abbreviation\": \"\"\n },\n \"area_unit\": \"IMPERIAL_ACRE\",\n \"length_unit\": \"IMPERIAL_FOOT\",\n \"volume_unit\": \"GENERIC_CUP\",\n \"weight_unit\": \"IMPERIAL_WEIGHT_OUNCE\",\n \"generic_unit\": \"UNIT\",\n \"time_unit\": \"GENERIC_HOUR\",\n \"type\": \"TYPE_LENGTH\"\n },\n \"name\": \"\",\n \"abbreviation\": \"\"\n }\n ],\n \"language_code\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-54356558-28b2-462f-b05f-c21f8bf0b61c" } ], "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-a26091f6-bd63-4921-a9c1-3c31bfeab2dd" } ], "id": "d9832481-c952-42b8-a06e-ef337d73e2a0", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-d9832481-c952-42b8-a06e-ef337d73e2a0" }, { "name": "list", "item": [ { "name": "Square List Catalog", "id": "c24a1ea7-d952-46b1-80b2-c21637a40c9d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/catalog/list?cursor=&types=&catalog_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "list" ], "query": [ { "description": "The pagination cursor returned in the previous response. Leave unset for an initial request.\nThe page size is currently set to be 100.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.", "key": "cursor", "value": "" }, { "description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](entity:CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.", "key": "types", "value": "" }, { "description": "The specific version of the catalog objects to be included in the response.\nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](entity:CatalogObject)s' `version` attribute. If not included, results will be from the\ncurrent version of the catalog.", "key": "catalog_version", "value": "" } ] }, "description": "Returns a list of all [CatalogObject](entity:CatalogObject)s of the specified types in the catalog.\n\nThe `types` parameter is specified as a comma-separated list of the [CatalogObjectType](entity:CatalogObjectType) values,\nfor example, \"`ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`\".\n\n__Important:__ ListCatalog does not return deleted catalog items. To retrieve\ndeleted catalog items, use [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects)\nand set the `include_deleted_objects` attribute value to `true`." }, "response": [ { "id": "5087dd6b-ef24-4e3d-ad29-59c6554a9018", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/catalog/list?cursor=&types=&catalog_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "list" ], "query": [ { "description": "The pagination cursor returned in the previous response. Leave unset for an initial request.\nThe page size is currently set to be 100.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.", "key": "cursor", "value": "" }, { "description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](entity:CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.", "key": "types", "value": "" }, { "description": "The specific version of the catalog objects to be included in the response.\nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](entity:CatalogObject)s' `version` attribute. If not included, results will be from the\ncurrent version of the catalog.", "key": "catalog_version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"API_ERROR\",\n \"code\": \"INVALID_FEES\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"cursor\": \"\",\n \"objects\": [\n {\n \"type\": \"ITEM\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"is_deleted\": \"\",\n \"custom_attribute_values\": {\n \"pariatur_7ee\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"SELECTION\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"velite\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"BOOLEAN\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n }\n },\n \"catalog_v1_ids\": [\n {\n \"catalog_v1_id\": \"\",\n \"location_id\": \"\"\n }\n ],\n \"present_at_all_locations\": \"\",\n \"present_at_location_ids\": [\n \"\"\n ],\n \"absent_at_location_ids\": [\n \"\"\n ],\n \"item_data\": {\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"label_color\": \"\",\n \"is_taxable\": \"\",\n \"category_id\": \"\",\n \"tax_ids\": [\n \"\"\n ],\n \"modifier_list_info\": [\n {\n \"modifier_list_id\": \"\",\n \"modifier_overrides\": [\n {\n \"modifier_id\": \"\",\n \"on_by_default\": \"\"\n }\n ],\n \"min_selected_modifiers\": \"\",\n \"max_selected_modifiers\": \"\",\n \"enabled\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"product_type\": \"GIFT_CARD\",\n \"skip_modifier_screen\": \"\",\n \"item_options\": [\n {\n \"item_option_id\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"sort_name\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"description_html\": \"\",\n \"description_plaintext\": \"\",\n \"channels\": [\n \"\"\n ],\n \"is_archived\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"food_and_beverage_details\": {\n \"calorie_count\": \"\",\n \"dietary_preferences\": [\n {\n \"type\": \"STANDARD\",\n \"standard_name\": \"DAIRY_FREE\",\n \"custom_name\": \"\"\n }\n ],\n \"ingredients\": [\n {\n \"type\": \"STANDARD\",\n \"standard_name\": \"MOLLUSCS\",\n \"custom_name\": \"\"\n }\n ]\n },\n \"reporting_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n },\n \"category_data\": {\n \"name\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"category_type\": \"REGULAR_CATEGORY\",\n \"parent_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n },\n \"is_top_level\": \"\",\n \"channels\": [\n \"\"\n ],\n \"availability_period_ids\": [\n \"\"\n ],\n \"online_visibility\": \"\",\n \"root_category\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"path_to_root\": [\n {\n \"category_id\": \"\",\n \"category_name\": \"\"\n }\n ]\n },\n \"item_variation_data\": {\n \"item_id\": \"\",\n \"name\": \"\",\n \"sku\": \"\",\n \"upc\": \"\",\n \"ordinal\": \"\",\n \"pricing_type\": \"VARIABLE_PRICING\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"KRW\"\n },\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"USD\"\n },\n \"pricing_type\": \"FIXED_PRICING\",\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"NONE\",\n \"inventory_alert_threshold\": \"\",\n \"sold_out\": \"\",\n \"sold_out_valid_until\": \"\"\n }\n ],\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"LOW_QUANTITY\",\n \"inventory_alert_threshold\": \"\",\n \"user_data\": \"\",\n \"service_duration\": \"\",\n \"available_for_booking\": \"\",\n \"item_option_values\": [\n {\n \"item_option_id\": \"\",\n \"item_option_value_id\": \"\"\n }\n ],\n \"measurement_unit_id\": \"\",\n \"sellable\": \"\",\n \"stockable\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"team_member_ids\": [\n \"\"\n ],\n \"stockable_conversion\": {\n \"stockable_item_variation_id\": \"\",\n \"stockable_quantity\": \"\",\n \"nonstockable_quantity\": \"\"\n }\n },\n \"tax_data\": {\n \"name\": \"\",\n \"calculation_phase\": \"TAX_SUBTOTAL_PHASE\",\n \"inclusion_type\": \"ADDITIVE\",\n \"percentage\": \"\",\n \"applies_to_custom_amounts\": \"\",\n \"enabled\": \"\",\n \"applies_to_product_set_id\": \"\"\n },\n \"discount_data\": {\n \"name\": \"\",\n \"discount_type\": \"FIXED_AMOUNT\",\n \"percentage\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"GTQ\"\n },\n \"pin_required\": \"\",\n \"label_color\": \"\",\n \"modify_tax_basis\": \"MODIFY_TAX_BASIS\",\n \"maximum_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"UZS\"\n }\n },\n \"modifier_list_data\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"selection_type\": \"MULTIPLE\",\n \"modifiers\": [\n {\n \"value\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"modifier_type\": \"TEXT\",\n \"max_length\": \"\",\n \"text_required\": \"\",\n \"internal_name\": \"\"\n },\n \"modifier_data\": {\n \"name\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"MWK\"\n },\n \"ordinal\": \"\",\n \"modifier_list_id\": \"\",\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"LSL\"\n },\n \"sold_out\": \"\"\n }\n ],\n \"image_id\": \"\"\n },\n \"time_period_data\": {\n \"event\": \"\"\n },\n \"product_set_data\": {\n \"name\": \"\",\n \"product_ids_any\": [\n \"\"\n ],\n \"product_ids_all\": [\n \"\"\n ],\n \"quantity_exact\": \"\",\n \"quantity_min\": \"\",\n \"quantity_max\": \"\",\n \"all_products\": \"\"\n },\n \"pricing_rule_data\": {\n \"name\": \"\",\n \"time_period_ids\": [\n \"\"\n ],\n \"discount_id\": \"\",\n \"match_products_id\": \"\",\n \"apply_products_id\": \"\",\n \"exclude_products_id\": \"\",\n \"valid_from_date\": \"\",\n \"valid_from_local_time\": \"\",\n \"valid_until_date\": \"\",\n \"valid_until_local_time\": \"\",\n \"exclude_strategy\": \"LEAST_EXPENSIVE\",\n \"minimum_order_subtotal_money\": {\n \"amount\": \"\",\n \"currency\": \"NAD\"\n },\n \"customer_group_ids_any\": [\n \"\"\n ]\n },\n \"image_data\": {\n \"name\": \"\",\n \"url\": \"\",\n \"caption\": \"\",\n \"photo_studio_order_id\": \"\"\n },\n \"measurement_unit_data\": {\n \"measurement_unit\": {\n \"custom_unit\": {\n \"name\": \"\",\n \"abbreviation\": \"\"\n },\n \"area_unit\": \"METRIC_SQUARE_CENTIMETER\",\n \"length_unit\": \"METRIC_KILOMETER\",\n \"volume_unit\": \"GENERIC_QUART\",\n \"weight_unit\": \"METRIC_MILLIGRAM\",\n \"generic_unit\": \"UNIT\",\n \"time_unit\": \"GENERIC_SECOND\",\n \"type\": \"TYPE_LENGTH\"\n },\n \"precision\": \"\"\n },\n \"subscription_plan_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"EVERY_TWO_YEARS\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"BOV\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"RELATIVE\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"KZT\"\n }\n }\n }\n ],\n \"subscription_plan_variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"eligible_item_ids\": [\n \"\"\n ],\n \"eligible_category_ids\": [\n \"\"\n ],\n \"all_items\": \"\"\n },\n \"item_option_data\": {\n \"name\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"show_colors\": \"\",\n \"values\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"item_option_value_data\": {\n \"item_option_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"color\": \"\",\n \"ordinal\": \"\"\n },\n \"custom_attribute_definition_data\": {\n \"type\": \"BOOLEAN\",\n \"name\": \"\",\n \"allowed_object_types\": [\n \"ITEM\"\n ],\n \"description\": \"\",\n \"source_application\": {\n \"product\": \"INVOICES\",\n \"application_id\": \"\",\n \"name\": \"\"\n },\n \"seller_visibility\": \"SELLER_VISIBILITY_READ_WRITE_VALUES\",\n \"app_visibility\": \"APP_VISIBILITY_READ_WRITE_VALUES\",\n \"string_config\": {\n \"enforce_uniqueness\": \"\"\n },\n \"number_config\": {\n \"precision\": \"\"\n },\n \"selection_config\": {\n \"max_allowed_selections\": \"\",\n \"allowed_selections\": [\n {\n \"name\": \"\",\n \"uid\": \"\"\n }\n ]\n },\n \"custom_attribute_usage_count\": \"\",\n \"key\": \"N\"\n },\n \"quick_amounts_settings_data\": {\n \"option\": \"AUTO\",\n \"eligible_for_auto_amounts\": \"\",\n \"amounts\": [\n {\n \"type\": \"QUICK_AMOUNT_TYPE_MANUAL\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"PEN\"\n },\n \"score\": \"\",\n \"ordinal\": \"\"\n }\n ]\n },\n \"subscription_plan_variation_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"QUARTERLY\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"VEF\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"STATIC\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"AOA\"\n }\n }\n }\n ],\n \"subscription_plan_id\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"can_prorate\": \"\",\n \"successor_plan_variation_id\": \"\"\n },\n \"availability_period_data\": {\n \"start_local_time\": \"\",\n \"end_local_time\": \"\",\n \"day_of_week\": \"WED\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-5087dd6b-ef24-4e3d-ad29-59c6554a9018" } ], "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-c24a1ea7-d952-46b1-80b2-c21637a40c9d" } ], "id": "94b32932-544a-4c82-8599-43b0906c62ca", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-94b32932-544a-4c82-8599-43b0906c62ca" }, { "name": "object", "item": [ { "name": "{object_id}", "item": [ { "name": "Square Delete Catalog Object", "id": "4e8353b1-eab0-420f-a4ce-8d99348102bc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/catalog/object/:object_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "object", ":object_id" ], "variable": [ { "id": "9dbb1e50-4696-4c84-951d-4105560506d3", "key": "object_id", "value": "", "description": "(Required) The ID of the catalog object to be deleted. When an object is deleted, other\nobjects in the graph that depend on that object will be deleted as well (for example, deleting a\ncatalog item will delete its catalog item variations)." } ] }, "description": "Deletes a single [CatalogObject](entity:CatalogObject) based on the\nprovided ID and returns the set of successfully deleted IDs in the response.\nDeletion is a cascading event such that all children of the targeted object\nare also deleted. For example, deleting a [CatalogItem](entity:CatalogItem)\nwill also delete all of its\n[CatalogItemVariation](entity:CatalogItemVariation) children.\n\nTo ensure consistency, only one delete request is processed at a time per seller account.\nWhile one (batch or non-batch) delete request is being processed, other (batched and non-batched)\ndelete requests are rejected with the `429` error code." }, "response": [ { "id": "e7297384-a201-421f-80a1-56ac5ebfd0ab", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/catalog/object/:object_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "object", ":object_id" ], "variable": [ { "key": "object_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"GENERIC_DECLINE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"EXTERNAL_VENDOR_ERROR\",\n \"code\": \"MISSING_PIN\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"deleted_object_ids\": [\n \"\",\n \"\"\n ],\n \"deleted_at\": \"\"\n}", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-e7297384-a201-421f-80a1-56ac5ebfd0ab" } ], "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-4e8353b1-eab0-420f-a4ce-8d99348102bc" }, { "name": "Square Retrieve Catalog Object", "id": "b0f59abf-1783-49ee-89a1-7f97f3bc57e3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/catalog/object/:object_id?include_related_objects=false&catalog_version=&include_category_path_to_root=false", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "object", ":object_id" ], "query": [ { "description": "If `true`, the response will include additional objects that are related to the\nrequested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field\nof the response. These objects are put in the `related_objects` field. Setting this to `true` is\nhelpful when the objects are needed for immediate display to a user.\nThis process only goes one level deep. Objects referenced by the related objects will not be included. For example,\n\nif the `objects` field of the response contains a CatalogItem, its associated\nCatalogCategory objects, CatalogTax objects, CatalogImage objects and\nCatalogModifierLists will be returned in the `related_objects` field of the\nresponse. If the `objects` field of the response contains a CatalogItemVariation,\nits parent CatalogItem will be returned in the `related_objects` field of\nthe response.\n\nDefault value: `false`", "key": "include_related_objects", "value": "false" }, { "description": "Requests objects as of a specific version of the catalog. This allows you to retrieve historical\nversions of objects. The value to retrieve a specific version of an object can be found\nin the version field of [CatalogObject](entity:CatalogObject)s. If not included, results will\nbe from the current version of the catalog.", "key": "catalog_version", "value": "" }, { "description": "Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists\nof `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category\nand ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned\nin the response payload.", "key": "include_category_path_to_root", "value": "false" } ], "variable": [ { "id": "f33a17c9-803f-46b7-a929-9d5419909d0c", "key": "object_id", "value": "", "description": "(Required) The object ID of any type of catalog objects to be retrieved." } ] }, "description": "Returns a single [CatalogItem](entity:CatalogItem) as a\n[CatalogObject](entity:CatalogObject) based on the provided ID. The returned\nobject includes all of the relevant [CatalogItem](entity:CatalogItem)\ninformation including: [CatalogItemVariation](entity:CatalogItemVariation)\nchildren, references to its\n[CatalogModifierList](entity:CatalogModifierList) objects, and the ids of\nany [CatalogTax](entity:CatalogTax) objects that apply to it." }, "response": [ { "id": "4129b2c1-19ac-4520-80c6-df1fdcadf256", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/catalog/object/:object_id?include_related_objects=false&catalog_version=&include_category_path_to_root=false", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "object", ":object_id" ], "query": [ { "description": "If `true`, the response will include additional objects that are related to the\nrequested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field\nof the response. These objects are put in the `related_objects` field. Setting this to `true` is\nhelpful when the objects are needed for immediate display to a user.\nThis process only goes one level deep. Objects referenced by the related objects will not be included. For example,\n\nif the `objects` field of the response contains a CatalogItem, its associated\nCatalogCategory objects, CatalogTax objects, CatalogImage objects and\nCatalogModifierLists will be returned in the `related_objects` field of the\nresponse. If the `objects` field of the response contains a CatalogItemVariation,\nits parent CatalogItem will be returned in the `related_objects` field of\nthe response.\n\nDefault value: `false`", "key": "include_related_objects", "value": "false" }, { "description": "Requests objects as of a specific version of the catalog. This allows you to retrieve historical\nversions of objects. The value to retrieve a specific version of an object can be found\nin the version field of [CatalogObject](entity:CatalogObject)s. If not included, results will\nbe from the current version of the catalog.", "key": "catalog_version", "value": "" }, { "description": "Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists\nof `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category\nand ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned\nin the response payload.", "key": "include_category_path_to_root", "value": "false" } ], "variable": [ { "key": "object_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"RATE_LIMITED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"object\": {\n \"type\": \"PRICING_RULE\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"is_deleted\": \"\",\n \"custom_attribute_values\": {\n \"deseruntb\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"BOOLEAN\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"eab\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"NUMBER\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"nonc\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"SELECTION\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"officia_f\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"NUMBER\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n }\n },\n \"catalog_v1_ids\": [\n {\n \"catalog_v1_id\": \"\",\n \"location_id\": \"\"\n }\n ],\n \"present_at_all_locations\": \"\",\n \"present_at_location_ids\": [\n \"\"\n ],\n \"absent_at_location_ids\": [\n \"\"\n ],\n \"item_data\": {\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"label_color\": \"\",\n \"is_taxable\": \"\",\n \"category_id\": \"\",\n \"tax_ids\": [\n \"\"\n ],\n \"modifier_list_info\": [\n {\n \"modifier_list_id\": \"\",\n \"modifier_overrides\": [\n {\n \"modifier_id\": \"\",\n \"on_by_default\": \"\"\n }\n ],\n \"min_selected_modifiers\": \"\",\n \"max_selected_modifiers\": \"\",\n \"enabled\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"product_type\": \"DONATION\",\n \"skip_modifier_screen\": \"\",\n \"item_options\": [\n {\n \"item_option_id\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"sort_name\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"description_html\": \"\",\n \"description_plaintext\": \"\",\n \"channels\": [\n \"\"\n ],\n \"is_archived\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"food_and_beverage_details\": {\n \"calorie_count\": \"\",\n \"dietary_preferences\": [\n {\n \"type\": \"STANDARD\",\n \"standard_name\": \"GLUTEN_FREE\",\n \"custom_name\": \"\"\n }\n ],\n \"ingredients\": [\n {\n \"type\": \"STANDARD\",\n \"standard_name\": \"CELERY\",\n \"custom_name\": \"\"\n }\n ]\n },\n \"reporting_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n },\n \"category_data\": {\n \"name\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"category_type\": \"KITCHEN_CATEGORY\",\n \"parent_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n },\n \"is_top_level\": \"\",\n \"channels\": [\n \"\"\n ],\n \"availability_period_ids\": [\n \"\"\n ],\n \"online_visibility\": \"\",\n \"root_category\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"path_to_root\": [\n {\n \"category_id\": \"\",\n \"category_name\": \"\"\n }\n ]\n },\n \"item_variation_data\": {\n \"item_id\": \"\",\n \"name\": \"\",\n \"sku\": \"\",\n \"upc\": \"\",\n \"ordinal\": \"\",\n \"pricing_type\": \"VARIABLE_PRICING\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"CUP\"\n },\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"BND\"\n },\n \"pricing_type\": \"VARIABLE_PRICING\",\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"LOW_QUANTITY\",\n \"inventory_alert_threshold\": \"\",\n \"sold_out\": \"\",\n \"sold_out_valid_until\": \"\"\n }\n ],\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"NONE\",\n \"inventory_alert_threshold\": \"\",\n \"user_data\": \"\",\n \"service_duration\": \"\",\n \"available_for_booking\": \"\",\n \"item_option_values\": [\n {\n \"item_option_id\": \"\",\n \"item_option_value_id\": \"\"\n }\n ],\n \"measurement_unit_id\": \"\",\n \"sellable\": \"\",\n \"stockable\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"team_member_ids\": [\n \"\"\n ],\n \"stockable_conversion\": {\n \"stockable_item_variation_id\": \"\",\n \"stockable_quantity\": \"\",\n \"nonstockable_quantity\": \"\"\n }\n },\n \"tax_data\": {\n \"name\": \"\",\n \"calculation_phase\": \"TAX_TOTAL_PHASE\",\n \"inclusion_type\": \"INCLUSIVE\",\n \"percentage\": \"\",\n \"applies_to_custom_amounts\": \"\",\n \"enabled\": \"\",\n \"applies_to_product_set_id\": \"\"\n },\n \"discount_data\": {\n \"name\": \"\",\n \"discount_type\": \"FIXED_AMOUNT\",\n \"percentage\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"XPF\"\n },\n \"pin_required\": \"\",\n \"label_color\": \"\",\n \"modify_tax_basis\": \"MODIFY_TAX_BASIS\",\n \"maximum_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"XBD\"\n }\n },\n \"modifier_list_data\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"selection_type\": \"MULTIPLE\",\n \"modifiers\": [\n {\n \"value\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"modifier_type\": \"LIST\",\n \"max_length\": \"\",\n \"text_required\": \"\",\n \"internal_name\": \"\"\n },\n \"modifier_data\": {\n \"name\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"BND\"\n },\n \"ordinal\": \"\",\n \"modifier_list_id\": \"\",\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"XAU\"\n },\n \"sold_out\": \"\"\n }\n ],\n \"image_id\": \"\"\n },\n \"time_period_data\": {\n \"event\": \"\"\n },\n \"product_set_data\": {\n \"name\": \"\",\n \"product_ids_any\": [\n \"\"\n ],\n \"product_ids_all\": [\n \"\"\n ],\n \"quantity_exact\": \"\",\n \"quantity_min\": \"\",\n \"quantity_max\": \"\",\n \"all_products\": \"\"\n },\n \"pricing_rule_data\": {\n \"name\": \"\",\n \"time_period_ids\": [\n \"\"\n ],\n \"discount_id\": \"\",\n \"match_products_id\": \"\",\n \"apply_products_id\": \"\",\n \"exclude_products_id\": \"\",\n \"valid_from_date\": \"\",\n \"valid_from_local_time\": \"\",\n \"valid_until_date\": \"\",\n \"valid_until_local_time\": \"\",\n \"exclude_strategy\": \"LEAST_EXPENSIVE\",\n \"minimum_order_subtotal_money\": {\n \"amount\": \"\",\n \"currency\": \"XXX\"\n },\n \"customer_group_ids_any\": [\n \"\"\n ]\n },\n \"image_data\": {\n \"name\": \"\",\n \"url\": \"\",\n \"caption\": \"\",\n \"photo_studio_order_id\": \"\"\n },\n \"measurement_unit_data\": {\n \"measurement_unit\": {\n \"custom_unit\": {\n \"name\": \"\",\n \"abbreviation\": \"\"\n },\n \"area_unit\": \"IMPERIAL_ACRE\",\n \"length_unit\": \"IMPERIAL_MILE\",\n \"volume_unit\": \"GENERIC_SHOT\",\n \"weight_unit\": \"METRIC_GRAM\",\n \"generic_unit\": \"UNIT\",\n \"time_unit\": \"GENERIC_HOUR\",\n \"type\": \"TYPE_GENERIC\"\n },\n \"precision\": \"\"\n },\n \"subscription_plan_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"NINETY_DAYS\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"EUR\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"RELATIVE\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"HRK\"\n }\n }\n }\n ],\n \"subscription_plan_variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"eligible_item_ids\": [\n \"\"\n ],\n \"eligible_category_ids\": [\n \"\"\n ],\n \"all_items\": \"\"\n },\n \"item_option_data\": {\n \"name\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"show_colors\": \"\",\n \"values\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"item_option_value_data\": {\n \"item_option_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"color\": \"\",\n \"ordinal\": \"\"\n },\n \"custom_attribute_definition_data\": {\n \"type\": \"NUMBER\",\n \"name\": \"\",\n \"allowed_object_types\": [\n \"MODIFIER\"\n ],\n \"description\": \"\",\n \"source_application\": {\n \"product\": \"EXTERNAL_API\",\n \"application_id\": \"\",\n \"name\": \"\"\n },\n \"seller_visibility\": \"SELLER_VISIBILITY_HIDDEN\",\n \"app_visibility\": \"APP_VISIBILITY_READ_ONLY\",\n \"string_config\": {\n \"enforce_uniqueness\": \"\"\n },\n \"number_config\": {\n \"precision\": \"\"\n },\n \"selection_config\": {\n \"max_allowed_selections\": \"\",\n \"allowed_selections\": [\n {\n \"name\": \"\",\n \"uid\": \"\"\n }\n ]\n },\n \"custom_attribute_usage_count\": \"\",\n \"key\": \"dZ7rWC\"\n },\n \"quick_amounts_settings_data\": {\n \"option\": \"MANUAL\",\n \"eligible_for_auto_amounts\": \"\",\n \"amounts\": [\n {\n \"type\": \"QUICK_AMOUNT_TYPE_AUTO\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"SAR\"\n },\n \"score\": \"\",\n \"ordinal\": \"\"\n }\n ]\n },\n \"subscription_plan_variation_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"QUARTERLY\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"RUB\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"STATIC\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"AZN\"\n }\n }\n }\n ],\n \"subscription_plan_id\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"can_prorate\": \"\",\n \"successor_plan_variation_id\": \"\"\n },\n \"availability_period_data\": {\n \"start_local_time\": \"\",\n \"end_local_time\": \"\",\n \"day_of_week\": \"WED\"\n }\n },\n \"related_objects\": [\n {\n \"type\": \"ITEM\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"is_deleted\": \"\",\n \"custom_attribute_values\": {\n \"anim46\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"STRING\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"reprehenderit3_8\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"NUMBER\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n }\n },\n \"catalog_v1_ids\": [\n {\n \"catalog_v1_id\": \"\",\n \"location_id\": \"\"\n }\n ],\n \"present_at_all_locations\": \"\",\n \"present_at_location_ids\": [\n \"\"\n ],\n \"absent_at_location_ids\": [\n \"\"\n ],\n \"item_data\": {\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"label_color\": \"\",\n \"is_taxable\": \"\",\n \"category_id\": \"\",\n \"tax_ids\": [\n \"\"\n ],\n \"modifier_list_info\": [\n {\n \"modifier_list_id\": \"\",\n \"modifier_overrides\": [\n {\n \"modifier_id\": \"\",\n \"on_by_default\": \"\"\n }\n ],\n \"min_selected_modifiers\": \"\",\n \"max_selected_modifiers\": \"\",\n \"enabled\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"product_type\": \"DIGITAL\",\n \"skip_modifier_screen\": \"\",\n \"item_options\": [\n {\n \"item_option_id\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"sort_name\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"description_html\": \"\",\n \"description_plaintext\": \"\",\n \"channels\": [\n \"\"\n ],\n \"is_archived\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"food_and_beverage_details\": {\n \"calorie_count\": \"\",\n \"dietary_preferences\": [\n {\n \"type\": \"STANDARD\",\n \"standard_name\": \"NUT_FREE\",\n \"custom_name\": \"\"\n }\n ],\n \"ingredients\": [\n {\n \"type\": \"STANDARD\",\n \"standard_name\": \"FISH\",\n \"custom_name\": \"\"\n }\n ]\n },\n \"reporting_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n },\n \"category_data\": {\n \"name\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"category_type\": \"REGULAR_CATEGORY\",\n \"parent_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n },\n \"is_top_level\": \"\",\n \"channels\": [\n \"\"\n ],\n \"availability_period_ids\": [\n \"\"\n ],\n \"online_visibility\": \"\",\n \"root_category\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"path_to_root\": [\n {\n \"category_id\": \"\",\n \"category_name\": \"\"\n }\n ]\n },\n \"item_variation_data\": {\n \"item_id\": \"\",\n \"name\": \"\",\n \"sku\": \"\",\n \"upc\": \"\",\n \"ordinal\": \"\",\n \"pricing_type\": \"VARIABLE_PRICING\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"DOP\"\n },\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"RWF\"\n },\n \"pricing_type\": \"FIXED_PRICING\",\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"LOW_QUANTITY\",\n \"inventory_alert_threshold\": \"\",\n \"sold_out\": \"\",\n \"sold_out_valid_until\": \"\"\n }\n ],\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"LOW_QUANTITY\",\n \"inventory_alert_threshold\": \"\",\n \"user_data\": \"\",\n \"service_duration\": \"\",\n \"available_for_booking\": \"\",\n \"item_option_values\": [\n {\n \"item_option_id\": \"\",\n \"item_option_value_id\": \"\"\n }\n ],\n \"measurement_unit_id\": \"\",\n \"sellable\": \"\",\n \"stockable\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"team_member_ids\": [\n \"\"\n ],\n \"stockable_conversion\": {\n \"stockable_item_variation_id\": \"\",\n \"stockable_quantity\": \"\",\n \"nonstockable_quantity\": \"\"\n }\n },\n \"tax_data\": {\n \"name\": \"\",\n \"calculation_phase\": \"TAX_SUBTOTAL_PHASE\",\n \"inclusion_type\": \"ADDITIVE\",\n \"percentage\": \"\",\n \"applies_to_custom_amounts\": \"\",\n \"enabled\": \"\",\n \"applies_to_product_set_id\": \"\"\n },\n \"discount_data\": {\n \"name\": \"\",\n \"discount_type\": \"VARIABLE_PERCENTAGE\",\n \"percentage\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"SEK\"\n },\n \"pin_required\": \"\",\n \"label_color\": \"\",\n \"modify_tax_basis\": \"MODIFY_TAX_BASIS\",\n \"maximum_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"CHE\"\n }\n },\n \"modifier_list_data\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"selection_type\": \"MULTIPLE\",\n \"modifiers\": [\n {\n \"value\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"modifier_type\": \"TEXT\",\n \"max_length\": \"\",\n \"text_required\": \"\",\n \"internal_name\": \"\"\n },\n \"modifier_data\": {\n \"name\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"TJS\"\n },\n \"ordinal\": \"\",\n \"modifier_list_id\": \"\",\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"GIP\"\n },\n \"sold_out\": \"\"\n }\n ],\n \"image_id\": \"\"\n },\n \"time_period_data\": {\n \"event\": \"\"\n },\n \"product_set_data\": {\n \"name\": \"\",\n \"product_ids_any\": [\n \"\"\n ],\n \"product_ids_all\": [\n \"\"\n ],\n \"quantity_exact\": \"\",\n \"quantity_min\": \"\",\n \"quantity_max\": \"\",\n \"all_products\": \"\"\n },\n \"pricing_rule_data\": {\n \"name\": \"\",\n \"time_period_ids\": [\n \"\"\n ],\n \"discount_id\": \"\",\n \"match_products_id\": \"\",\n \"apply_products_id\": \"\",\n \"exclude_products_id\": \"\",\n \"valid_from_date\": \"\",\n \"valid_from_local_time\": \"\",\n \"valid_until_date\": \"\",\n \"valid_until_local_time\": \"\",\n \"exclude_strategy\": \"MOST_EXPENSIVE\",\n \"minimum_order_subtotal_money\": {\n \"amount\": \"\",\n \"currency\": \"TRY\"\n },\n \"customer_group_ids_any\": [\n \"\"\n ]\n },\n \"image_data\": {\n \"name\": \"\",\n \"url\": \"\",\n \"caption\": \"\",\n \"photo_studio_order_id\": \"\"\n },\n \"measurement_unit_data\": {\n \"measurement_unit\": {\n \"custom_unit\": {\n \"name\": \"\",\n \"abbreviation\": \"\"\n },\n \"area_unit\": \"METRIC_SQUARE_CENTIMETER\",\n \"length_unit\": \"METRIC_CENTIMETER\",\n \"volume_unit\": \"GENERIC_QUART\",\n \"weight_unit\": \"IMPERIAL_POUND\",\n \"generic_unit\": \"UNIT\",\n \"time_unit\": \"GENERIC_MILLISECOND\",\n \"type\": \"TYPE_WEIGHT\"\n },\n \"precision\": \"\"\n },\n \"subscription_plan_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"QUARTERLY\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"ISK\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"STATIC\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"BBD\"\n }\n }\n }\n ],\n \"subscription_plan_variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"eligible_item_ids\": [\n \"\"\n ],\n \"eligible_category_ids\": [\n \"\"\n ],\n \"all_items\": \"\"\n },\n \"item_option_data\": {\n \"name\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"show_colors\": \"\",\n \"values\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"item_option_value_data\": {\n \"item_option_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"color\": \"\",\n \"ordinal\": \"\"\n },\n \"custom_attribute_definition_data\": {\n \"type\": \"STRING\",\n \"name\": \"\",\n \"allowed_object_types\": [\n \"SUBSCRIPTION_PLAN_VARIATION\"\n ],\n \"description\": \"\",\n \"source_application\": {\n \"product\": \"BILLING\",\n \"application_id\": \"\",\n \"name\": \"\"\n },\n \"seller_visibility\": \"SELLER_VISIBILITY_HIDDEN\",\n \"app_visibility\": \"APP_VISIBILITY_HIDDEN\",\n \"string_config\": {\n \"enforce_uniqueness\": \"\"\n },\n \"number_config\": {\n \"precision\": \"\"\n },\n \"selection_config\": {\n \"max_allowed_selections\": \"\",\n \"allowed_selections\": [\n {\n \"name\": \"\",\n \"uid\": \"\"\n }\n ]\n },\n \"custom_attribute_usage_count\": \"\",\n \"key\": \"-lQHRzVwCS\"\n },\n \"quick_amounts_settings_data\": {\n \"option\": \"MANUAL\",\n \"eligible_for_auto_amounts\": \"\",\n \"amounts\": [\n {\n \"type\": \"QUICK_AMOUNT_TYPE_MANUAL\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"GHS\"\n },\n \"score\": \"\",\n \"ordinal\": \"\"\n }\n ]\n },\n \"subscription_plan_variation_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"SIXTY_DAYS\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"BRL\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"STATIC\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"MVR\"\n }\n }\n }\n ],\n \"subscription_plan_id\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"can_prorate\": \"\",\n \"successor_plan_variation_id\": \"\"\n },\n \"availability_period_data\": {\n \"start_local_time\": \"\",\n \"end_local_time\": \"\",\n \"day_of_week\": \"MON\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-4129b2c1-19ac-4520-80c6-df1fdcadf256" } ], "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-b0f59abf-1783-49ee-89a1-7f97f3bc57e3" } ], "id": "ace7a49a-d465-4724-a8e0-d9ee8ad6e3e5", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-ace7a49a-d465-4724-a8e0-d9ee8ad6e3e5" }, { "name": "Square Upsert Catalog Object", "id": "40b1c2f9-b775-4c1e-b857-a20cde86f0a0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"object\": {\n \"type\": \"TAX\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"is_deleted\": \"\",\n \"custom_attribute_values\": {\n \"sint329\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"BOOLEAN\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n }\n },\n \"catalog_v1_ids\": [\n {\n \"catalog_v1_id\": \"\",\n \"location_id\": \"\"\n }\n ],\n \"present_at_all_locations\": \"\",\n \"present_at_location_ids\": [\n \"\"\n ],\n \"absent_at_location_ids\": [\n \"\"\n ],\n \"item_data\": {\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"label_color\": \"\",\n \"is_taxable\": \"\",\n \"category_id\": \"\",\n \"tax_ids\": [\n \"\"\n ],\n \"modifier_list_info\": [\n {\n \"modifier_list_id\": \"\",\n \"modifier_overrides\": [\n {\n \"modifier_id\": \"\",\n \"on_by_default\": \"\"\n }\n ],\n \"min_selected_modifiers\": \"\",\n \"max_selected_modifiers\": \"\",\n \"enabled\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"product_type\": \"DIGITAL\",\n \"skip_modifier_screen\": \"\",\n \"item_options\": [\n {\n \"item_option_id\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"sort_name\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"description_html\": \"\",\n \"description_plaintext\": \"\",\n \"channels\": [\n \"\"\n ],\n \"is_archived\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"food_and_beverage_details\": {\n \"calorie_count\": \"\",\n \"dietary_preferences\": [\n {\n \"type\": \"STANDARD\",\n \"standard_name\": \"HALAL\",\n \"custom_name\": \"\"\n }\n ],\n \"ingredients\": [\n {\n \"type\": \"CUSTOM\",\n \"standard_name\": \"SESAME\",\n \"custom_name\": \"\"\n }\n ]\n },\n \"reporting_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n },\n \"category_data\": {\n \"name\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"category_type\": \"MENU_CATEGORY\",\n \"parent_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n },\n \"is_top_level\": \"\",\n \"channels\": [\n \"\"\n ],\n \"availability_period_ids\": [\n \"\"\n ],\n \"online_visibility\": \"\",\n \"root_category\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"path_to_root\": [\n {\n \"category_id\": \"\",\n \"category_name\": \"\"\n }\n ]\n },\n \"item_variation_data\": {\n \"item_id\": \"\",\n \"name\": \"\",\n \"sku\": \"\",\n \"upc\": \"\",\n \"ordinal\": \"\",\n \"pricing_type\": \"VARIABLE_PRICING\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"COP\"\n },\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"SLE\"\n },\n \"pricing_type\": \"FIXED_PRICING\",\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"NONE\",\n \"inventory_alert_threshold\": \"\",\n \"sold_out\": \"\",\n \"sold_out_valid_until\": \"\"\n }\n ],\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"NONE\",\n \"inventory_alert_threshold\": \"\",\n \"user_data\": \"\",\n \"service_duration\": \"\",\n \"available_for_booking\": \"\",\n \"item_option_values\": [\n {\n \"item_option_id\": \"\",\n \"item_option_value_id\": \"\"\n }\n ],\n \"measurement_unit_id\": \"\",\n \"sellable\": \"\",\n \"stockable\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"team_member_ids\": [\n \"\"\n ],\n \"stockable_conversion\": {\n \"stockable_item_variation_id\": \"\",\n \"stockable_quantity\": \"\",\n \"nonstockable_quantity\": \"\"\n }\n },\n \"tax_data\": {\n \"name\": \"\",\n \"calculation_phase\": \"TAX_TOTAL_PHASE\",\n \"inclusion_type\": \"ADDITIVE\",\n \"percentage\": \"\",\n \"applies_to_custom_amounts\": \"\",\n \"enabled\": \"\",\n \"applies_to_product_set_id\": \"\"\n },\n \"discount_data\": {\n \"name\": \"\",\n \"discount_type\": \"FIXED_AMOUNT\",\n \"percentage\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"CUC\"\n },\n \"pin_required\": \"\",\n \"label_color\": \"\",\n \"modify_tax_basis\": \"DO_NOT_MODIFY_TAX_BASIS\",\n \"maximum_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"VND\"\n }\n },\n \"modifier_list_data\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"selection_type\": \"MULTIPLE\",\n \"modifiers\": [\n {\n \"value\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"modifier_type\": \"LIST\",\n \"max_length\": \"\",\n \"text_required\": \"\",\n \"internal_name\": \"\"\n },\n \"modifier_data\": {\n \"name\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"MKD\"\n },\n \"ordinal\": \"\",\n \"modifier_list_id\": \"\",\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"GMD\"\n },\n \"sold_out\": \"\"\n }\n ],\n \"image_id\": \"\"\n },\n \"time_period_data\": {\n \"event\": \"\"\n },\n \"product_set_data\": {\n \"name\": \"\",\n \"product_ids_any\": [\n \"\"\n ],\n \"product_ids_all\": [\n \"\"\n ],\n \"quantity_exact\": \"\",\n \"quantity_min\": \"\",\n \"quantity_max\": \"\",\n \"all_products\": \"\"\n },\n \"pricing_rule_data\": {\n \"name\": \"\",\n \"time_period_ids\": [\n \"\"\n ],\n \"discount_id\": \"\",\n \"match_products_id\": \"\",\n \"apply_products_id\": \"\",\n \"exclude_products_id\": \"\",\n \"valid_from_date\": \"\",\n \"valid_from_local_time\": \"\",\n \"valid_until_date\": \"\",\n \"valid_until_local_time\": \"\",\n \"exclude_strategy\": \"LEAST_EXPENSIVE\",\n \"minimum_order_subtotal_money\": {\n \"amount\": \"\",\n \"currency\": \"SHP\"\n },\n \"customer_group_ids_any\": [\n \"\"\n ]\n },\n \"image_data\": {\n \"name\": \"\",\n \"url\": \"\",\n \"caption\": \"\",\n \"photo_studio_order_id\": \"\"\n },\n \"measurement_unit_data\": {\n \"measurement_unit\": {\n \"custom_unit\": {\n \"name\": \"\",\n \"abbreviation\": \"\"\n },\n \"area_unit\": \"IMPERIAL_SQUARE_MILE\",\n \"length_unit\": \"METRIC_KILOMETER\",\n \"volume_unit\": \"METRIC_MILLILITER\",\n \"weight_unit\": \"IMPERIAL_WEIGHT_OUNCE\",\n \"generic_unit\": \"UNIT\",\n \"time_unit\": \"GENERIC_MINUTE\",\n \"type\": \"TYPE_GENERIC\"\n },\n \"precision\": \"\"\n },\n \"subscription_plan_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"EVERY_TWO_MONTHS\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"PGK\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"RELATIVE\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"TTD\"\n }\n }\n }\n ],\n \"subscription_plan_variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"eligible_item_ids\": [\n \"\"\n ],\n \"eligible_category_ids\": [\n \"\"\n ],\n \"all_items\": \"\"\n },\n \"item_option_data\": {\n \"name\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"show_colors\": \"\",\n \"values\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"item_option_value_data\": {\n \"item_option_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"color\": \"\",\n \"ordinal\": \"\"\n },\n \"custom_attribute_definition_data\": {\n \"type\": \"SELECTION\",\n \"name\": \"\",\n \"allowed_object_types\": [\n \"PRODUCT_SET\"\n ],\n \"description\": \"\",\n \"source_application\": {\n \"product\": \"ITEM_LIBRARY_IMPORT\",\n \"application_id\": \"\",\n \"name\": \"\"\n },\n \"seller_visibility\": \"SELLER_VISIBILITY_HIDDEN\",\n \"app_visibility\": \"APP_VISIBILITY_READ_ONLY\",\n \"string_config\": {\n \"enforce_uniqueness\": \"\"\n },\n \"number_config\": {\n \"precision\": \"\"\n },\n \"selection_config\": {\n \"max_allowed_selections\": \"\",\n \"allowed_selections\": [\n {\n \"name\": \"\",\n \"uid\": \"\"\n }\n ]\n },\n \"custom_attribute_usage_count\": \"\",\n \"key\": \"3\"\n },\n \"quick_amounts_settings_data\": {\n \"option\": \"DISABLED\",\n \"eligible_for_auto_amounts\": \"\",\n \"amounts\": [\n {\n \"type\": \"QUICK_AMOUNT_TYPE_MANUAL\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"XBD\"\n },\n \"score\": \"\",\n \"ordinal\": \"\"\n }\n ]\n },\n \"subscription_plan_variation_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"DAILY\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"KPW\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"RELATIVE\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"GBP\"\n }\n }\n }\n ],\n \"subscription_plan_id\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"can_prorate\": \"\",\n \"successor_plan_variation_id\": \"\"\n },\n \"availability_period_data\": {\n \"start_local_time\": \"\",\n \"end_local_time\": \"\",\n \"day_of_week\": \"SAT\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/catalog/object", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "object" ] }, "description": "Creates a new or updates the specified [CatalogObject](entity:CatalogObject).\n\nTo ensure consistency, only one update request is processed at a time per seller account.\nWhile one (batch or non-batch) update request is being processed, other (batched and non-batched)\nupdate requests are rejected with the `429` error code." }, "response": [ { "id": "0688c633-50b4-4266-981e-84a156ff66f8", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"object\": {\n \"type\": \"TAX\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"is_deleted\": \"\",\n \"custom_attribute_values\": {\n \"sint329\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"BOOLEAN\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n }\n },\n \"catalog_v1_ids\": [\n {\n \"catalog_v1_id\": \"\",\n \"location_id\": \"\"\n }\n ],\n \"present_at_all_locations\": \"\",\n \"present_at_location_ids\": [\n \"\"\n ],\n \"absent_at_location_ids\": [\n \"\"\n ],\n \"item_data\": {\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"label_color\": \"\",\n \"is_taxable\": \"\",\n \"category_id\": \"\",\n \"tax_ids\": [\n \"\"\n ],\n \"modifier_list_info\": [\n {\n \"modifier_list_id\": \"\",\n \"modifier_overrides\": [\n {\n \"modifier_id\": \"\",\n \"on_by_default\": \"\"\n }\n ],\n \"min_selected_modifiers\": \"\",\n \"max_selected_modifiers\": \"\",\n \"enabled\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"product_type\": \"DIGITAL\",\n \"skip_modifier_screen\": \"\",\n \"item_options\": [\n {\n \"item_option_id\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"sort_name\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"description_html\": \"\",\n \"description_plaintext\": \"\",\n \"channels\": [\n \"\"\n ],\n \"is_archived\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"food_and_beverage_details\": {\n \"calorie_count\": \"\",\n \"dietary_preferences\": [\n {\n \"type\": \"STANDARD\",\n \"standard_name\": \"HALAL\",\n \"custom_name\": \"\"\n }\n ],\n \"ingredients\": [\n {\n \"type\": \"CUSTOM\",\n \"standard_name\": \"SESAME\",\n \"custom_name\": \"\"\n }\n ]\n },\n \"reporting_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n },\n \"category_data\": {\n \"name\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"category_type\": \"MENU_CATEGORY\",\n \"parent_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n },\n \"is_top_level\": \"\",\n \"channels\": [\n \"\"\n ],\n \"availability_period_ids\": [\n \"\"\n ],\n \"online_visibility\": \"\",\n \"root_category\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"path_to_root\": [\n {\n \"category_id\": \"\",\n \"category_name\": \"\"\n }\n ]\n },\n \"item_variation_data\": {\n \"item_id\": \"\",\n \"name\": \"\",\n \"sku\": \"\",\n \"upc\": \"\",\n \"ordinal\": \"\",\n \"pricing_type\": \"VARIABLE_PRICING\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"COP\"\n },\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"SLE\"\n },\n \"pricing_type\": \"FIXED_PRICING\",\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"NONE\",\n \"inventory_alert_threshold\": \"\",\n \"sold_out\": \"\",\n \"sold_out_valid_until\": \"\"\n }\n ],\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"NONE\",\n \"inventory_alert_threshold\": \"\",\n \"user_data\": \"\",\n \"service_duration\": \"\",\n \"available_for_booking\": \"\",\n \"item_option_values\": [\n {\n \"item_option_id\": \"\",\n \"item_option_value_id\": \"\"\n }\n ],\n \"measurement_unit_id\": \"\",\n \"sellable\": \"\",\n \"stockable\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"team_member_ids\": [\n \"\"\n ],\n \"stockable_conversion\": {\n \"stockable_item_variation_id\": \"\",\n \"stockable_quantity\": \"\",\n \"nonstockable_quantity\": \"\"\n }\n },\n \"tax_data\": {\n \"name\": \"\",\n \"calculation_phase\": \"TAX_TOTAL_PHASE\",\n \"inclusion_type\": \"ADDITIVE\",\n \"percentage\": \"\",\n \"applies_to_custom_amounts\": \"\",\n \"enabled\": \"\",\n \"applies_to_product_set_id\": \"\"\n },\n \"discount_data\": {\n \"name\": \"\",\n \"discount_type\": \"FIXED_AMOUNT\",\n \"percentage\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"CUC\"\n },\n \"pin_required\": \"\",\n \"label_color\": \"\",\n \"modify_tax_basis\": \"DO_NOT_MODIFY_TAX_BASIS\",\n \"maximum_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"VND\"\n }\n },\n \"modifier_list_data\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"selection_type\": \"MULTIPLE\",\n \"modifiers\": [\n {\n \"value\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"modifier_type\": \"LIST\",\n \"max_length\": \"\",\n \"text_required\": \"\",\n \"internal_name\": \"\"\n },\n \"modifier_data\": {\n \"name\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"MKD\"\n },\n \"ordinal\": \"\",\n \"modifier_list_id\": \"\",\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"GMD\"\n },\n \"sold_out\": \"\"\n }\n ],\n \"image_id\": \"\"\n },\n \"time_period_data\": {\n \"event\": \"\"\n },\n \"product_set_data\": {\n \"name\": \"\",\n \"product_ids_any\": [\n \"\"\n ],\n \"product_ids_all\": [\n \"\"\n ],\n \"quantity_exact\": \"\",\n \"quantity_min\": \"\",\n \"quantity_max\": \"\",\n \"all_products\": \"\"\n },\n \"pricing_rule_data\": {\n \"name\": \"\",\n \"time_period_ids\": [\n \"\"\n ],\n \"discount_id\": \"\",\n \"match_products_id\": \"\",\n \"apply_products_id\": \"\",\n \"exclude_products_id\": \"\",\n \"valid_from_date\": \"\",\n \"valid_from_local_time\": \"\",\n \"valid_until_date\": \"\",\n \"valid_until_local_time\": \"\",\n \"exclude_strategy\": \"LEAST_EXPENSIVE\",\n \"minimum_order_subtotal_money\": {\n \"amount\": \"\",\n \"currency\": \"SHP\"\n },\n \"customer_group_ids_any\": [\n \"\"\n ]\n },\n \"image_data\": {\n \"name\": \"\",\n \"url\": \"\",\n \"caption\": \"\",\n \"photo_studio_order_id\": \"\"\n },\n \"measurement_unit_data\": {\n \"measurement_unit\": {\n \"custom_unit\": {\n \"name\": \"\",\n \"abbreviation\": \"\"\n },\n \"area_unit\": \"IMPERIAL_SQUARE_MILE\",\n \"length_unit\": \"METRIC_KILOMETER\",\n \"volume_unit\": \"METRIC_MILLILITER\",\n \"weight_unit\": \"IMPERIAL_WEIGHT_OUNCE\",\n \"generic_unit\": \"UNIT\",\n \"time_unit\": \"GENERIC_MINUTE\",\n \"type\": \"TYPE_GENERIC\"\n },\n \"precision\": \"\"\n },\n \"subscription_plan_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"EVERY_TWO_MONTHS\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"PGK\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"RELATIVE\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"TTD\"\n }\n }\n }\n ],\n \"subscription_plan_variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"eligible_item_ids\": [\n \"\"\n ],\n \"eligible_category_ids\": [\n \"\"\n ],\n \"all_items\": \"\"\n },\n \"item_option_data\": {\n \"name\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"show_colors\": \"\",\n \"values\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"item_option_value_data\": {\n \"item_option_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"color\": \"\",\n \"ordinal\": \"\"\n },\n \"custom_attribute_definition_data\": {\n \"type\": \"SELECTION\",\n \"name\": \"\",\n \"allowed_object_types\": [\n \"PRODUCT_SET\"\n ],\n \"description\": \"\",\n \"source_application\": {\n \"product\": \"ITEM_LIBRARY_IMPORT\",\n \"application_id\": \"\",\n \"name\": \"\"\n },\n \"seller_visibility\": \"SELLER_VISIBILITY_HIDDEN\",\n \"app_visibility\": \"APP_VISIBILITY_READ_ONLY\",\n \"string_config\": {\n \"enforce_uniqueness\": \"\"\n },\n \"number_config\": {\n \"precision\": \"\"\n },\n \"selection_config\": {\n \"max_allowed_selections\": \"\",\n \"allowed_selections\": [\n {\n \"name\": \"\",\n \"uid\": \"\"\n }\n ]\n },\n \"custom_attribute_usage_count\": \"\",\n \"key\": \"3\"\n },\n \"quick_amounts_settings_data\": {\n \"option\": \"DISABLED\",\n \"eligible_for_auto_amounts\": \"\",\n \"amounts\": [\n {\n \"type\": \"QUICK_AMOUNT_TYPE_MANUAL\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"XBD\"\n },\n \"score\": \"\",\n \"ordinal\": \"\"\n }\n ]\n },\n \"subscription_plan_variation_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"DAILY\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"KPW\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"RELATIVE\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"GBP\"\n }\n }\n }\n ],\n \"subscription_plan_id\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"can_prorate\": \"\",\n \"successor_plan_variation_id\": \"\"\n },\n \"availability_period_data\": {\n \"start_local_time\": \"\",\n \"end_local_time\": \"\",\n \"day_of_week\": \"SAT\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/catalog/object", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "object" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"CLIENT_DISABLED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"catalog_object\": {\n \"type\": \"ITEM_OPTION\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"is_deleted\": \"\",\n \"custom_attribute_values\": {\n \"ut_85e\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"SELECTION\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"in_b\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"STRING\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n }\n },\n \"catalog_v1_ids\": [\n {\n \"catalog_v1_id\": \"\",\n \"location_id\": \"\"\n }\n ],\n \"present_at_all_locations\": \"\",\n \"present_at_location_ids\": [\n \"\"\n ],\n \"absent_at_location_ids\": [\n \"\"\n ],\n \"item_data\": {\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"label_color\": \"\",\n \"is_taxable\": \"\",\n \"category_id\": \"\",\n \"tax_ids\": [\n \"\"\n ],\n \"modifier_list_info\": [\n {\n \"modifier_list_id\": \"\",\n \"modifier_overrides\": [\n {\n \"modifier_id\": \"\",\n \"on_by_default\": \"\"\n }\n ],\n \"min_selected_modifiers\": \"\",\n \"max_selected_modifiers\": \"\",\n \"enabled\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"product_type\": \"DIGITAL\",\n \"skip_modifier_screen\": \"\",\n \"item_options\": [\n {\n \"item_option_id\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"sort_name\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"description_html\": \"\",\n \"description_plaintext\": \"\",\n \"channels\": [\n \"\"\n ],\n \"is_archived\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"food_and_beverage_details\": {\n \"calorie_count\": \"\",\n \"dietary_preferences\": [\n {\n \"type\": \"STANDARD\",\n \"standard_name\": \"VEGAN\",\n \"custom_name\": \"\"\n }\n ],\n \"ingredients\": [\n {\n \"type\": \"STANDARD\",\n \"standard_name\": \"PEANUTS\",\n \"custom_name\": \"\"\n }\n ]\n },\n \"reporting_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n },\n \"category_data\": {\n \"name\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"category_type\": \"MENU_CATEGORY\",\n \"parent_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n },\n \"is_top_level\": \"\",\n \"channels\": [\n \"\"\n ],\n \"availability_period_ids\": [\n \"\"\n ],\n \"online_visibility\": \"\",\n \"root_category\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"path_to_root\": [\n {\n \"category_id\": \"\",\n \"category_name\": \"\"\n }\n ]\n },\n \"item_variation_data\": {\n \"item_id\": \"\",\n \"name\": \"\",\n \"sku\": \"\",\n \"upc\": \"\",\n \"ordinal\": \"\",\n \"pricing_type\": \"FIXED_PRICING\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"XBB\"\n },\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"DZD\"\n },\n \"pricing_type\": \"FIXED_PRICING\",\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"LOW_QUANTITY\",\n \"inventory_alert_threshold\": \"\",\n \"sold_out\": \"\",\n \"sold_out_valid_until\": \"\"\n }\n ],\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"LOW_QUANTITY\",\n \"inventory_alert_threshold\": \"\",\n \"user_data\": \"\",\n \"service_duration\": \"\",\n \"available_for_booking\": \"\",\n \"item_option_values\": [\n {\n \"item_option_id\": \"\",\n \"item_option_value_id\": \"\"\n }\n ],\n \"measurement_unit_id\": \"\",\n \"sellable\": \"\",\n \"stockable\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"team_member_ids\": [\n \"\"\n ],\n \"stockable_conversion\": {\n \"stockable_item_variation_id\": \"\",\n \"stockable_quantity\": \"\",\n \"nonstockable_quantity\": \"\"\n }\n },\n \"tax_data\": {\n \"name\": \"\",\n \"calculation_phase\": \"TAX_SUBTOTAL_PHASE\",\n \"inclusion_type\": \"ADDITIVE\",\n \"percentage\": \"\",\n \"applies_to_custom_amounts\": \"\",\n \"enabled\": \"\",\n \"applies_to_product_set_id\": \"\"\n },\n \"discount_data\": {\n \"name\": \"\",\n \"discount_type\": \"VARIABLE_AMOUNT\",\n \"percentage\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"VND\"\n },\n \"pin_required\": \"\",\n \"label_color\": \"\",\n \"modify_tax_basis\": \"MODIFY_TAX_BASIS\",\n \"maximum_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"GYD\"\n }\n },\n \"modifier_list_data\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"selection_type\": \"SINGLE\",\n \"modifiers\": [\n {\n \"value\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"modifier_type\": \"TEXT\",\n \"max_length\": \"\",\n \"text_required\": \"\",\n \"internal_name\": \"\"\n },\n \"modifier_data\": {\n \"name\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"CDF\"\n },\n \"ordinal\": \"\",\n \"modifier_list_id\": \"\",\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"XPT\"\n },\n \"sold_out\": \"\"\n }\n ],\n \"image_id\": \"\"\n },\n \"time_period_data\": {\n \"event\": \"\"\n },\n \"product_set_data\": {\n \"name\": \"\",\n \"product_ids_any\": [\n \"\"\n ],\n \"product_ids_all\": [\n \"\"\n ],\n \"quantity_exact\": \"\",\n \"quantity_min\": \"\",\n \"quantity_max\": \"\",\n \"all_products\": \"\"\n },\n \"pricing_rule_data\": {\n \"name\": \"\",\n \"time_period_ids\": [\n \"\"\n ],\n \"discount_id\": \"\",\n \"match_products_id\": \"\",\n \"apply_products_id\": \"\",\n \"exclude_products_id\": \"\",\n \"valid_from_date\": \"\",\n \"valid_from_local_time\": \"\",\n \"valid_until_date\": \"\",\n \"valid_until_local_time\": \"\",\n \"exclude_strategy\": \"MOST_EXPENSIVE\",\n \"minimum_order_subtotal_money\": {\n \"amount\": \"\",\n \"currency\": \"IRR\"\n },\n \"customer_group_ids_any\": [\n \"\"\n ]\n },\n \"image_data\": {\n \"name\": \"\",\n \"url\": \"\",\n \"caption\": \"\",\n \"photo_studio_order_id\": \"\"\n },\n \"measurement_unit_data\": {\n \"measurement_unit\": {\n \"custom_unit\": {\n \"name\": \"\",\n \"abbreviation\": \"\"\n },\n \"area_unit\": \"METRIC_SQUARE_METER\",\n \"length_unit\": \"IMPERIAL_INCH\",\n \"volume_unit\": \"GENERIC_FLUID_OUNCE\",\n \"weight_unit\": \"METRIC_KILOGRAM\",\n \"generic_unit\": \"UNIT\",\n \"time_unit\": \"GENERIC_DAY\",\n \"type\": \"TYPE_LENGTH\"\n },\n \"precision\": \"\"\n },\n \"subscription_plan_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"EVERY_TWO_YEARS\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"GMD\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"STATIC\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"HNL\"\n }\n }\n }\n ],\n \"subscription_plan_variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"eligible_item_ids\": [\n \"\"\n ],\n \"eligible_category_ids\": [\n \"\"\n ],\n \"all_items\": \"\"\n },\n \"item_option_data\": {\n \"name\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"show_colors\": \"\",\n \"values\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"item_option_value_data\": {\n \"item_option_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"color\": \"\",\n \"ordinal\": \"\"\n },\n \"custom_attribute_definition_data\": {\n \"type\": \"BOOLEAN\",\n \"name\": \"\",\n \"allowed_object_types\": [\n \"PRICING_RULE\"\n ],\n \"description\": \"\",\n \"source_application\": {\n \"product\": \"EXTERNAL_API\",\n \"application_id\": \"\",\n \"name\": \"\"\n },\n \"seller_visibility\": \"SELLER_VISIBILITY_HIDDEN\",\n \"app_visibility\": \"APP_VISIBILITY_READ_ONLY\",\n \"string_config\": {\n \"enforce_uniqueness\": \"\"\n },\n \"number_config\": {\n \"precision\": \"\"\n },\n \"selection_config\": {\n \"max_allowed_selections\": \"\",\n \"allowed_selections\": [\n {\n \"name\": \"\",\n \"uid\": \"\"\n }\n ]\n },\n \"custom_attribute_usage_count\": \"\",\n \"key\": \"V6tk\"\n },\n \"quick_amounts_settings_data\": {\n \"option\": \"MANUAL\",\n \"eligible_for_auto_amounts\": \"\",\n \"amounts\": [\n {\n \"type\": \"QUICK_AMOUNT_TYPE_MANUAL\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"CLF\"\n },\n \"score\": \"\",\n \"ordinal\": \"\"\n }\n ]\n },\n \"subscription_plan_variation_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"WEEKLY\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"SSP\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"RELATIVE\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"ZMK\"\n }\n }\n }\n ],\n \"subscription_plan_id\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"can_prorate\": \"\",\n \"successor_plan_variation_id\": \"\"\n },\n \"availability_period_data\": {\n \"start_local_time\": \"\",\n \"end_local_time\": \"\",\n \"day_of_week\": \"FRI\"\n }\n },\n \"id_mappings\": [\n {\n \"client_object_id\": \"\",\n \"object_id\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-0688c633-50b4-4266-981e-84a156ff66f8" } ], "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-40b1c2f9-b775-4c1e-b857-a20cde86f0a0" } ], "id": "69060bf8-972e-460b-afdc-a64e27d4934b", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-69060bf8-972e-460b-afdc-a64e27d4934b" }, { "name": "search", "item": [ { "name": "Square Search Catalog Objects", "id": "3a18a1d5-87a2-44aa-9a68-a93644e10cb9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cursor\": \"\",\n \"object_types\": [\n \"AVAILABILITY_PERIOD\",\n \"CATEGORY\"\n ],\n \"include_deleted_objects\": \"\",\n \"include_related_objects\": \"\",\n \"begin_time\": \"\",\n \"query\": {\n \"sorted_attribute_query\": {\n \"attribute_name\": \"\",\n \"initial_attribute_value\": \"\",\n \"sort_order\": \"DESC\"\n },\n \"exact_query\": {\n \"attribute_name\": \"\",\n \"attribute_value\": \"\"\n },\n \"set_query\": {\n \"attribute_name\": \"\",\n \"attribute_values\": [\n \"\",\n \"\"\n ]\n },\n \"prefix_query\": {\n \"attribute_name\": \"\",\n \"attribute_prefix\": \"\"\n },\n \"range_query\": {\n \"attribute_name\": \"\",\n \"attribute_min_value\": \"\",\n \"attribute_max_value\": \"\"\n },\n \"text_query\": {\n \"keywords\": [\n \"\",\n \"\"\n ]\n },\n \"items_for_tax_query\": {\n \"tax_ids\": [\n \"\",\n \"\"\n ]\n },\n \"items_for_modifier_list_query\": {\n \"modifier_list_ids\": [\n \"\",\n \"\"\n ]\n },\n \"items_for_item_options_query\": {\n \"item_option_ids\": [\n \"\",\n \"\"\n ]\n },\n \"item_variations_for_item_option_values_query\": {\n \"item_option_value_ids\": [\n \"\",\n \"\"\n ]\n }\n },\n \"limit\": \"\",\n \"include_category_path_to_root\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/catalog/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "search" ] }, "description": "Searches for [CatalogObject](entity:CatalogObject) of any type by matching supported search attribute values,\nexcluding custom attribute values on items or item variations, against one or more of the specified query filters.\n\nThis (`SearchCatalogObjects`) endpoint differs from the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems)\nendpoint in the following aspects:\n\n- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects.\n- `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not.\n- `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does.\n- The both endpoints have different call conventions, including the query filter formats." }, "response": [ { "id": "e37d79e3-bdd7-4bb0-9bac-7a8be2c24bd5", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"cursor\": \"\",\n \"object_types\": [\n \"AVAILABILITY_PERIOD\",\n \"CATEGORY\"\n ],\n \"include_deleted_objects\": \"\",\n \"include_related_objects\": \"\",\n \"begin_time\": \"\",\n \"query\": {\n \"sorted_attribute_query\": {\n \"attribute_name\": \"\",\n \"initial_attribute_value\": \"\",\n \"sort_order\": \"DESC\"\n },\n \"exact_query\": {\n \"attribute_name\": \"\",\n \"attribute_value\": \"\"\n },\n \"set_query\": {\n \"attribute_name\": \"\",\n \"attribute_values\": [\n \"\",\n \"\"\n ]\n },\n \"prefix_query\": {\n \"attribute_name\": \"\",\n \"attribute_prefix\": \"\"\n },\n \"range_query\": {\n \"attribute_name\": \"\",\n \"attribute_min_value\": \"\",\n \"attribute_max_value\": \"\"\n },\n \"text_query\": {\n \"keywords\": [\n \"\",\n \"\"\n ]\n },\n \"items_for_tax_query\": {\n \"tax_ids\": [\n \"\",\n \"\"\n ]\n },\n \"items_for_modifier_list_query\": {\n \"modifier_list_ids\": [\n \"\",\n \"\"\n ]\n },\n \"items_for_item_options_query\": {\n \"item_option_ids\": [\n \"\",\n \"\"\n ]\n },\n \"item_variations_for_item_option_values_query\": {\n \"item_option_value_ids\": [\n \"\",\n \"\"\n ]\n }\n },\n \"limit\": \"\",\n \"include_category_path_to_root\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/catalog/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "search" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"MAP_KEY_LENGTH_TOO_LONG\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"cursor\": \"\",\n \"objects\": [\n {\n \"type\": \"ITEM_OPTION_VAL\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"is_deleted\": \"\",\n \"custom_attribute_values\": {\n \"ipsum_5\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"NUMBER\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"labore_9\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"STRING\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"sunt0\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"STRING\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n }\n },\n \"catalog_v1_ids\": [\n {\n \"catalog_v1_id\": \"\",\n \"location_id\": \"\"\n }\n ],\n \"present_at_all_locations\": \"\",\n \"present_at_location_ids\": [\n \"\"\n ],\n \"absent_at_location_ids\": [\n \"\"\n ],\n \"item_data\": {\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"label_color\": \"\",\n \"is_taxable\": \"\",\n \"category_id\": \"\",\n \"tax_ids\": [\n \"\"\n ],\n \"modifier_list_info\": [\n {\n \"modifier_list_id\": \"\",\n \"modifier_overrides\": [\n {\n \"modifier_id\": \"\",\n \"on_by_default\": \"\"\n }\n ],\n \"min_selected_modifiers\": \"\",\n \"max_selected_modifiers\": \"\",\n \"enabled\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"product_type\": \"GIFT_CARD\",\n \"skip_modifier_screen\": \"\",\n \"item_options\": [\n {\n \"item_option_id\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"sort_name\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"description_html\": \"\",\n \"description_plaintext\": \"\",\n \"channels\": [\n \"\"\n ],\n \"is_archived\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"food_and_beverage_details\": {\n \"calorie_count\": \"\",\n \"dietary_preferences\": [\n {\n \"type\": \"CUSTOM\",\n \"standard_name\": \"HALAL\",\n \"custom_name\": \"\"\n }\n ],\n \"ingredients\": [\n {\n \"type\": \"CUSTOM\",\n \"standard_name\": \"LUPIN\",\n \"custom_name\": \"\"\n }\n ]\n },\n \"reporting_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n },\n \"category_data\": {\n \"name\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"category_type\": \"REGULAR_CATEGORY\",\n \"parent_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n },\n \"is_top_level\": \"\",\n \"channels\": [\n \"\"\n ],\n \"availability_period_ids\": [\n \"\"\n ],\n \"online_visibility\": \"\",\n \"root_category\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"path_to_root\": [\n {\n \"category_id\": \"\",\n \"category_name\": \"\"\n }\n ]\n },\n \"item_variation_data\": {\n \"item_id\": \"\",\n \"name\": \"\",\n \"sku\": \"\",\n \"upc\": \"\",\n \"ordinal\": \"\",\n \"pricing_type\": \"FIXED_PRICING\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"MRO\"\n },\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"PKR\"\n },\n \"pricing_type\": \"VARIABLE_PRICING\",\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"LOW_QUANTITY\",\n \"inventory_alert_threshold\": \"\",\n \"sold_out\": \"\",\n \"sold_out_valid_until\": \"\"\n }\n ],\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"LOW_QUANTITY\",\n \"inventory_alert_threshold\": \"\",\n \"user_data\": \"\",\n \"service_duration\": \"\",\n \"available_for_booking\": \"\",\n \"item_option_values\": [\n {\n \"item_option_id\": \"\",\n \"item_option_value_id\": \"\"\n }\n ],\n \"measurement_unit_id\": \"\",\n \"sellable\": \"\",\n \"stockable\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"team_member_ids\": [\n \"\"\n ],\n \"stockable_conversion\": {\n \"stockable_item_variation_id\": \"\",\n \"stockable_quantity\": \"\",\n \"nonstockable_quantity\": \"\"\n }\n },\n \"tax_data\": {\n \"name\": \"\",\n \"calculation_phase\": \"TAX_TOTAL_PHASE\",\n \"inclusion_type\": \"INCLUSIVE\",\n \"percentage\": \"\",\n \"applies_to_custom_amounts\": \"\",\n \"enabled\": \"\",\n \"applies_to_product_set_id\": \"\"\n },\n \"discount_data\": {\n \"name\": \"\",\n \"discount_type\": \"FIXED_PERCENTAGE\",\n \"percentage\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"XBB\"\n },\n \"pin_required\": \"\",\n \"label_color\": \"\",\n \"modify_tax_basis\": \"DO_NOT_MODIFY_TAX_BASIS\",\n \"maximum_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"GIP\"\n }\n },\n \"modifier_list_data\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"selection_type\": \"MULTIPLE\",\n \"modifiers\": [\n {\n \"value\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"modifier_type\": \"TEXT\",\n \"max_length\": \"\",\n \"text_required\": \"\",\n \"internal_name\": \"\"\n },\n \"modifier_data\": {\n \"name\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"THB\"\n },\n \"ordinal\": \"\",\n \"modifier_list_id\": \"\",\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"LVL\"\n },\n \"sold_out\": \"\"\n }\n ],\n \"image_id\": \"\"\n },\n \"time_period_data\": {\n \"event\": \"\"\n },\n \"product_set_data\": {\n \"name\": \"\",\n \"product_ids_any\": [\n \"\"\n ],\n \"product_ids_all\": [\n \"\"\n ],\n \"quantity_exact\": \"\",\n \"quantity_min\": \"\",\n \"quantity_max\": \"\",\n \"all_products\": \"\"\n },\n \"pricing_rule_data\": {\n \"name\": \"\",\n \"time_period_ids\": [\n \"\"\n ],\n \"discount_id\": \"\",\n \"match_products_id\": \"\",\n \"apply_products_id\": \"\",\n \"exclude_products_id\": \"\",\n \"valid_from_date\": \"\",\n \"valid_from_local_time\": \"\",\n \"valid_until_date\": \"\",\n \"valid_until_local_time\": \"\",\n \"exclude_strategy\": \"LEAST_EXPENSIVE\",\n \"minimum_order_subtotal_money\": {\n \"amount\": \"\",\n \"currency\": \"MYR\"\n },\n \"customer_group_ids_any\": [\n \"\"\n ]\n },\n \"image_data\": {\n \"name\": \"\",\n \"url\": \"\",\n \"caption\": \"\",\n \"photo_studio_order_id\": \"\"\n },\n \"measurement_unit_data\": {\n \"measurement_unit\": {\n \"custom_unit\": {\n \"name\": \"\",\n \"abbreviation\": \"\"\n },\n \"area_unit\": \"METRIC_SQUARE_KILOMETER\",\n \"length_unit\": \"IMPERIAL_INCH\",\n \"volume_unit\": \"GENERIC_FLUID_OUNCE\",\n \"weight_unit\": \"IMPERIAL_STONE\",\n \"generic_unit\": \"UNIT\",\n \"time_unit\": \"GENERIC_SECOND\",\n \"type\": \"TYPE_GENERIC\"\n },\n \"precision\": \"\"\n },\n \"subscription_plan_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"EVERY_FOUR_MONTHS\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"NOK\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"RELATIVE\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"HNL\"\n }\n }\n }\n ],\n \"subscription_plan_variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"eligible_item_ids\": [\n \"\"\n ],\n \"eligible_category_ids\": [\n \"\"\n ],\n \"all_items\": \"\"\n },\n \"item_option_data\": {\n \"name\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"show_colors\": \"\",\n \"values\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"item_option_value_data\": {\n \"item_option_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"color\": \"\",\n \"ordinal\": \"\"\n },\n \"custom_attribute_definition_data\": {\n \"type\": \"NUMBER\",\n \"name\": \"\",\n \"allowed_object_types\": [\n \"CATEGORY\"\n ],\n \"description\": \"\",\n \"source_application\": {\n \"product\": \"OTHER\",\n \"application_id\": \"\",\n \"name\": \"\"\n },\n \"seller_visibility\": \"SELLER_VISIBILITY_READ_WRITE_VALUES\",\n \"app_visibility\": \"APP_VISIBILITY_READ_WRITE_VALUES\",\n \"string_config\": {\n \"enforce_uniqueness\": \"\"\n },\n \"number_config\": {\n \"precision\": \"\"\n },\n \"selection_config\": {\n \"max_allowed_selections\": \"\",\n \"allowed_selections\": [\n {\n \"name\": \"\",\n \"uid\": \"\"\n }\n ]\n },\n \"custom_attribute_usage_count\": \"\",\n \"key\": \"V60gC_S\"\n },\n \"quick_amounts_settings_data\": {\n \"option\": \"MANUAL\",\n \"eligible_for_auto_amounts\": \"\",\n \"amounts\": [\n {\n \"type\": \"QUICK_AMOUNT_TYPE_AUTO\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"TND\"\n },\n \"score\": \"\",\n \"ordinal\": \"\"\n }\n ]\n },\n \"subscription_plan_variation_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"EVERY_TWO_WEEKS\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"BMD\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"RELATIVE\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"MAD\"\n }\n }\n }\n ],\n \"subscription_plan_id\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"can_prorate\": \"\",\n \"successor_plan_variation_id\": \"\"\n },\n \"availability_period_data\": {\n \"start_local_time\": \"\",\n \"end_local_time\": \"\",\n \"day_of_week\": \"MON\"\n }\n }\n ],\n \"related_objects\": [\n {\n \"type\": \"AVAILABILITY_PERIOD\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"is_deleted\": \"\",\n \"custom_attribute_values\": {\n \"ad_51\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"NUMBER\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"qui_845\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"NUMBER\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"veniame\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"BOOLEAN\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n }\n },\n \"catalog_v1_ids\": [\n {\n \"catalog_v1_id\": \"\",\n \"location_id\": \"\"\n }\n ],\n \"present_at_all_locations\": \"\",\n \"present_at_location_ids\": [\n \"\"\n ],\n \"absent_at_location_ids\": [\n \"\"\n ],\n \"item_data\": {\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"label_color\": \"\",\n \"is_taxable\": \"\",\n \"category_id\": \"\",\n \"tax_ids\": [\n \"\"\n ],\n \"modifier_list_info\": [\n {\n \"modifier_list_id\": \"\",\n \"modifier_overrides\": [\n {\n \"modifier_id\": \"\",\n \"on_by_default\": \"\"\n }\n ],\n \"min_selected_modifiers\": \"\",\n \"max_selected_modifiers\": \"\",\n \"enabled\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"product_type\": \"DIGITAL\",\n \"skip_modifier_screen\": \"\",\n \"item_options\": [\n {\n \"item_option_id\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"sort_name\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"description_html\": \"\",\n \"description_plaintext\": \"\",\n \"channels\": [\n \"\"\n ],\n \"is_archived\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"food_and_beverage_details\": {\n \"calorie_count\": \"\",\n \"dietary_preferences\": [\n {\n \"type\": \"STANDARD\",\n \"standard_name\": \"VEGETARIAN\",\n \"custom_name\": \"\"\n }\n ],\n \"ingredients\": [\n {\n \"type\": \"STANDARD\",\n \"standard_name\": \"MUSTARD\",\n \"custom_name\": \"\"\n }\n ]\n },\n \"reporting_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n },\n \"category_data\": {\n \"name\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"category_type\": \"KITCHEN_CATEGORY\",\n \"parent_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n },\n \"is_top_level\": \"\",\n \"channels\": [\n \"\"\n ],\n \"availability_period_ids\": [\n \"\"\n ],\n \"online_visibility\": \"\",\n \"root_category\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"path_to_root\": [\n {\n \"category_id\": \"\",\n \"category_name\": \"\"\n }\n ]\n },\n \"item_variation_data\": {\n \"item_id\": \"\",\n \"name\": \"\",\n \"sku\": \"\",\n \"upc\": \"\",\n \"ordinal\": \"\",\n \"pricing_type\": \"FIXED_PRICING\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"GTQ\"\n },\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"XUS\"\n },\n \"pricing_type\": \"FIXED_PRICING\",\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"LOW_QUANTITY\",\n \"inventory_alert_threshold\": \"\",\n \"sold_out\": \"\",\n \"sold_out_valid_until\": \"\"\n }\n ],\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"NONE\",\n \"inventory_alert_threshold\": \"\",\n \"user_data\": \"\",\n \"service_duration\": \"\",\n \"available_for_booking\": \"\",\n \"item_option_values\": [\n {\n \"item_option_id\": \"\",\n \"item_option_value_id\": \"\"\n }\n ],\n \"measurement_unit_id\": \"\",\n \"sellable\": \"\",\n \"stockable\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"team_member_ids\": [\n \"\"\n ],\n \"stockable_conversion\": {\n \"stockable_item_variation_id\": \"\",\n \"stockable_quantity\": \"\",\n \"nonstockable_quantity\": \"\"\n }\n },\n \"tax_data\": {\n \"name\": \"\",\n \"calculation_phase\": \"TAX_TOTAL_PHASE\",\n \"inclusion_type\": \"ADDITIVE\",\n \"percentage\": \"\",\n \"applies_to_custom_amounts\": \"\",\n \"enabled\": \"\",\n \"applies_to_product_set_id\": \"\"\n },\n \"discount_data\": {\n \"name\": \"\",\n \"discount_type\": \"FIXED_AMOUNT\",\n \"percentage\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"SHP\"\n },\n \"pin_required\": \"\",\n \"label_color\": \"\",\n \"modify_tax_basis\": \"MODIFY_TAX_BASIS\",\n \"maximum_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"INR\"\n }\n },\n \"modifier_list_data\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"selection_type\": \"SINGLE\",\n \"modifiers\": [\n {\n \"value\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"modifier_type\": \"TEXT\",\n \"max_length\": \"\",\n \"text_required\": \"\",\n \"internal_name\": \"\"\n },\n \"modifier_data\": {\n \"name\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"PYG\"\n },\n \"ordinal\": \"\",\n \"modifier_list_id\": \"\",\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"GYD\"\n },\n \"sold_out\": \"\"\n }\n ],\n \"image_id\": \"\"\n },\n \"time_period_data\": {\n \"event\": \"\"\n },\n \"product_set_data\": {\n \"name\": \"\",\n \"product_ids_any\": [\n \"\"\n ],\n \"product_ids_all\": [\n \"\"\n ],\n \"quantity_exact\": \"\",\n \"quantity_min\": \"\",\n \"quantity_max\": \"\",\n \"all_products\": \"\"\n },\n \"pricing_rule_data\": {\n \"name\": \"\",\n \"time_period_ids\": [\n \"\"\n ],\n \"discount_id\": \"\",\n \"match_products_id\": \"\",\n \"apply_products_id\": \"\",\n \"exclude_products_id\": \"\",\n \"valid_from_date\": \"\",\n \"valid_from_local_time\": \"\",\n \"valid_until_date\": \"\",\n \"valid_until_local_time\": \"\",\n \"exclude_strategy\": \"MOST_EXPENSIVE\",\n \"minimum_order_subtotal_money\": {\n \"amount\": \"\",\n \"currency\": \"UYI\"\n },\n \"customer_group_ids_any\": [\n \"\"\n ]\n },\n \"image_data\": {\n \"name\": \"\",\n \"url\": \"\",\n \"caption\": \"\",\n \"photo_studio_order_id\": \"\"\n },\n \"measurement_unit_data\": {\n \"measurement_unit\": {\n \"custom_unit\": {\n \"name\": \"\",\n \"abbreviation\": \"\"\n },\n \"area_unit\": \"METRIC_SQUARE_KILOMETER\",\n \"length_unit\": \"IMPERIAL_YARD\",\n \"volume_unit\": \"GENERIC_GALLON\",\n \"weight_unit\": \"IMPERIAL_POUND\",\n \"generic_unit\": \"UNIT\",\n \"time_unit\": \"GENERIC_SECOND\",\n \"type\": \"TYPE_WEIGHT\"\n },\n \"precision\": \"\"\n },\n \"subscription_plan_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"QUARTERLY\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"MGA\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"STATIC\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"XOF\"\n }\n }\n }\n ],\n \"subscription_plan_variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"eligible_item_ids\": [\n \"\"\n ],\n \"eligible_category_ids\": [\n \"\"\n ],\n \"all_items\": \"\"\n },\n \"item_option_data\": {\n \"name\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"show_colors\": \"\",\n \"values\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"item_option_value_data\": {\n \"item_option_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"color\": \"\",\n \"ordinal\": \"\"\n },\n \"custom_attribute_definition_data\": {\n \"type\": \"STRING\",\n \"name\": \"\",\n \"allowed_object_types\": [\n \"SUBSCRIPTION_PLAN\"\n ],\n \"description\": \"\",\n \"source_application\": {\n \"product\": \"DASHBOARD\",\n \"application_id\": \"\",\n \"name\": \"\"\n },\n \"seller_visibility\": \"SELLER_VISIBILITY_READ_WRITE_VALUES\",\n \"app_visibility\": \"APP_VISIBILITY_HIDDEN\",\n \"string_config\": {\n \"enforce_uniqueness\": \"\"\n },\n \"number_config\": {\n \"precision\": \"\"\n },\n \"selection_config\": {\n \"max_allowed_selections\": \"\",\n \"allowed_selections\": [\n {\n \"name\": \"\",\n \"uid\": \"\"\n }\n ]\n },\n \"custom_attribute_usage_count\": \"\",\n \"key\": \"y8Ml\"\n },\n \"quick_amounts_settings_data\": {\n \"option\": \"DISABLED\",\n \"eligible_for_auto_amounts\": \"\",\n \"amounts\": [\n {\n \"type\": \"QUICK_AMOUNT_TYPE_AUTO\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"PYG\"\n },\n \"score\": \"\",\n \"ordinal\": \"\"\n }\n ]\n },\n \"subscription_plan_variation_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"NINETY_DAYS\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"JOD\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"STATIC\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"KYD\"\n }\n }\n }\n ],\n \"subscription_plan_id\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"can_prorate\": \"\",\n \"successor_plan_variation_id\": \"\"\n },\n \"availability_period_data\": {\n \"start_local_time\": \"\",\n \"end_local_time\": \"\",\n \"day_of_week\": \"THU\"\n }\n }\n ],\n \"latest_time\": \"\"\n}", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-e37d79e3-bdd7-4bb0-9bac-7a8be2c24bd5" } ], "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-3a18a1d5-87a2-44aa-9a68-a93644e10cb9" } ], "id": "ee6cff9d-6958-453f-b89e-8a95fcf860a7", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-ee6cff9d-6958-453f-b89e-8a95fcf860a7" }, { "name": "search-catalog-items", "item": [ { "name": "Square Search Catalog Items", "id": "fdf3f60c-2fc7-40a6-ab1e-0bec16a01907", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"text_filter\": \"\",\n \"category_ids\": [\n \"\",\n \"\"\n ],\n \"stock_levels\": [\n \"OUT\",\n \"LOW\"\n ],\n \"enabled_location_ids\": [\n \"\",\n \"\"\n ],\n \"cursor\": \"\",\n \"limit\": \"\",\n \"sort_order\": \"ASC\",\n \"product_types\": [\n \"DONATION\",\n \"LEGACY_SQUARE_ONLINE_MEMBERSHIP\"\n ],\n \"custom_attribute_filters\": [\n {\n \"custom_attribute_definition_id\": \"\",\n \"key\": \"\",\n \"string_filter\": \"\",\n \"number_filter\": {\n \"min\": \"\",\n \"max\": \"\"\n },\n \"selection_uids_filter\": [\n \"\",\n \"\"\n ],\n \"bool_filter\": \"\"\n },\n {\n \"custom_attribute_definition_id\": \"\",\n \"key\": \"\",\n \"string_filter\": \"\",\n \"number_filter\": {\n \"min\": \"\",\n \"max\": \"\"\n },\n \"selection_uids_filter\": [\n \"\",\n \"\"\n ],\n \"bool_filter\": \"\"\n }\n ],\n \"archived_state\": \"ARCHIVED_STATE_NOT_ARCHIVED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/catalog/search-catalog-items", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "search-catalog-items" ] }, "description": "Searches for catalog items or item variations by matching supported search attribute values, including\ncustom attribute values, against one or more of the specified query filters.\n\nThis (`SearchCatalogItems`) endpoint differs from the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects)\nendpoint in the following aspects:\n\n- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects.\n- `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not.\n- `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does.\n- The both endpoints use different call conventions, including the query filter formats." }, "response": [ { "id": "d9ec627c-0681-4ff1-aa5c-cb131fc4b9b1", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"text_filter\": \"\",\n \"category_ids\": [\n \"\",\n \"\"\n ],\n \"stock_levels\": [\n \"OUT\",\n \"LOW\"\n ],\n \"enabled_location_ids\": [\n \"\",\n \"\"\n ],\n \"cursor\": \"\",\n \"limit\": \"\",\n \"sort_order\": \"ASC\",\n \"product_types\": [\n \"DONATION\",\n \"LEGACY_SQUARE_ONLINE_MEMBERSHIP\"\n ],\n \"custom_attribute_filters\": [\n {\n \"custom_attribute_definition_id\": \"\",\n \"key\": \"\",\n \"string_filter\": \"\",\n \"number_filter\": {\n \"min\": \"\",\n \"max\": \"\"\n },\n \"selection_uids_filter\": [\n \"\",\n \"\"\n ],\n \"bool_filter\": \"\"\n },\n {\n \"custom_attribute_definition_id\": \"\",\n \"key\": \"\",\n \"string_filter\": \"\",\n \"number_filter\": {\n \"min\": \"\",\n \"max\": \"\"\n },\n \"selection_uids_filter\": [\n \"\",\n \"\"\n ],\n \"bool_filter\": \"\"\n }\n ],\n \"archived_state\": \"ARCHIVED_STATE_NOT_ARCHIVED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/catalog/search-catalog-items", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "search-catalog-items" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"EXTERNAL_VENDOR_ERROR\",\n \"code\": \"CARDHOLDER_INSUFFICIENT_PERMISSIONS\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"items\": [\n {\n \"type\": \"ITEM_OPTION_VAL\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"is_deleted\": \"\",\n \"custom_attribute_values\": {\n \"deserunt__0\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"NUMBER\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"dolore_c\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"SELECTION\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"laborum901\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"STRING\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n },\n \"tempor_da\": {\n \"name\": \"\",\n \"string_value\": \"\",\n \"custom_attribute_definition_id\": \"\",\n \"type\": \"BOOLEAN\",\n \"number_value\": \"\",\n \"boolean_value\": \"\",\n \"selection_uid_values\": [\n \"\"\n ],\n \"key\": \"\"\n }\n },\n \"catalog_v1_ids\": [\n {\n \"catalog_v1_id\": \"\",\n \"location_id\": \"\"\n }\n ],\n \"present_at_all_locations\": \"\",\n \"present_at_location_ids\": [\n \"\"\n ],\n \"absent_at_location_ids\": [\n \"\"\n ],\n \"item_data\": {\n \"name\": \"\",\n \"description\": \"\",\n \"abbreviation\": \"\",\n \"label_color\": \"\",\n \"is_taxable\": \"\",\n \"category_id\": \"\",\n \"tax_ids\": [\n \"\"\n ],\n \"modifier_list_info\": [\n {\n \"modifier_list_id\": \"\",\n \"modifier_overrides\": [\n {\n \"modifier_id\": \"\",\n \"on_by_default\": \"\"\n }\n ],\n \"min_selected_modifiers\": \"\",\n \"max_selected_modifiers\": \"\",\n \"enabled\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"product_type\": \"DONATION\",\n \"skip_modifier_screen\": \"\",\n \"item_options\": [\n {\n \"item_option_id\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"sort_name\": \"\",\n \"categories\": [\n {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n ],\n \"description_html\": \"\",\n \"description_plaintext\": \"\",\n \"channels\": [\n \"\"\n ],\n \"is_archived\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"food_and_beverage_details\": {\n \"calorie_count\": \"\",\n \"dietary_preferences\": [\n {\n \"type\": \"CUSTOM\",\n \"standard_name\": \"VEGETARIAN\",\n \"custom_name\": \"\"\n }\n ],\n \"ingredients\": [\n {\n \"type\": \"CUSTOM\",\n \"standard_name\": \"PEANUTS\",\n \"custom_name\": \"\"\n }\n ]\n },\n \"reporting_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n }\n },\n \"category_data\": {\n \"name\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"category_type\": \"MENU_CATEGORY\",\n \"parent_category\": {\n \"id\": \"\",\n \"ordinal\": \"\"\n },\n \"is_top_level\": \"\",\n \"channels\": [\n \"\"\n ],\n \"availability_period_ids\": [\n \"\"\n ],\n \"online_visibility\": \"\",\n \"root_category\": \"\",\n \"ecom_seo_data\": {\n \"page_title\": \"\",\n \"page_description\": \"\",\n \"permalink\": \"\"\n },\n \"path_to_root\": [\n {\n \"category_id\": \"\",\n \"category_name\": \"\"\n }\n ]\n },\n \"item_variation_data\": {\n \"item_id\": \"\",\n \"name\": \"\",\n \"sku\": \"\",\n \"upc\": \"\",\n \"ordinal\": \"\",\n \"pricing_type\": \"FIXED_PRICING\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"EUR\"\n },\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"XBB\"\n },\n \"pricing_type\": \"FIXED_PRICING\",\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"LOW_QUANTITY\",\n \"inventory_alert_threshold\": \"\",\n \"sold_out\": \"\",\n \"sold_out_valid_until\": \"\"\n }\n ],\n \"track_inventory\": \"\",\n \"inventory_alert_type\": \"LOW_QUANTITY\",\n \"inventory_alert_threshold\": \"\",\n \"user_data\": \"\",\n \"service_duration\": \"\",\n \"available_for_booking\": \"\",\n \"item_option_values\": [\n {\n \"item_option_id\": \"\",\n \"item_option_value_id\": \"\"\n }\n ],\n \"measurement_unit_id\": \"\",\n \"sellable\": \"\",\n \"stockable\": \"\",\n \"image_ids\": [\n \"\"\n ],\n \"team_member_ids\": [\n \"\"\n ],\n \"stockable_conversion\": {\n \"stockable_item_variation_id\": \"\",\n \"stockable_quantity\": \"\",\n \"nonstockable_quantity\": \"\"\n }\n },\n \"tax_data\": {\n \"name\": \"\",\n \"calculation_phase\": \"TAX_TOTAL_PHASE\",\n \"inclusion_type\": \"ADDITIVE\",\n \"percentage\": \"\",\n \"applies_to_custom_amounts\": \"\",\n \"enabled\": \"\",\n \"applies_to_product_set_id\": \"\"\n },\n \"discount_data\": {\n \"name\": \"\",\n \"discount_type\": \"FIXED_AMOUNT\",\n \"percentage\": \"\",\n \"amount_money\": {\n \"amount\": \"\",\n \"currency\": \"UAH\"\n },\n \"pin_required\": \"\",\n \"label_color\": \"\",\n \"modify_tax_basis\": \"MODIFY_TAX_BASIS\",\n \"maximum_amount_money\": {\n \"amount\": \"\",\n \"currency\": \"BSD\"\n }\n },\n \"modifier_list_data\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"selection_type\": \"MULTIPLE\",\n \"modifiers\": [\n {\n \"value\": \"\"\n }\n ],\n \"image_ids\": [\n \"\"\n ],\n \"modifier_type\": \"LIST\",\n \"max_length\": \"\",\n \"text_required\": \"\",\n \"internal_name\": \"\"\n },\n \"modifier_data\": {\n \"name\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"CNY\"\n },\n \"ordinal\": \"\",\n \"modifier_list_id\": \"\",\n \"location_overrides\": [\n {\n \"location_id\": \"\",\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"LTL\"\n },\n \"sold_out\": \"\"\n }\n ],\n \"image_id\": \"\"\n },\n \"time_period_data\": {\n \"event\": \"\"\n },\n \"product_set_data\": {\n \"name\": \"\",\n \"product_ids_any\": [\n \"\"\n ],\n \"product_ids_all\": [\n \"\"\n ],\n \"quantity_exact\": \"\",\n \"quantity_min\": \"\",\n \"quantity_max\": \"\",\n \"all_products\": \"\"\n },\n \"pricing_rule_data\": {\n \"name\": \"\",\n \"time_period_ids\": [\n \"\"\n ],\n \"discount_id\": \"\",\n \"match_products_id\": \"\",\n \"apply_products_id\": \"\",\n \"exclude_products_id\": \"\",\n \"valid_from_date\": \"\",\n \"valid_from_local_time\": \"\",\n \"valid_until_date\": \"\",\n \"valid_until_local_time\": \"\",\n \"exclude_strategy\": \"MOST_EXPENSIVE\",\n \"minimum_order_subtotal_money\": {\n \"amount\": \"\",\n \"currency\": \"ZMK\"\n },\n \"customer_group_ids_any\": [\n \"\"\n ]\n },\n \"image_data\": {\n \"name\": \"\",\n \"url\": \"\",\n \"caption\": \"\",\n \"photo_studio_order_id\": \"\"\n },\n \"measurement_unit_data\": {\n \"measurement_unit\": {\n \"custom_unit\": {\n \"name\": \"\",\n \"abbreviation\": \"\"\n },\n \"area_unit\": \"IMPERIAL_SQUARE_MILE\",\n \"length_unit\": \"METRIC_KILOMETER\",\n \"volume_unit\": \"GENERIC_SHOT\",\n \"weight_unit\": \"IMPERIAL_POUND\",\n \"generic_unit\": \"UNIT\",\n \"time_unit\": \"GENERIC_MILLISECOND\",\n \"type\": \"TYPE_GENERIC\"\n },\n \"precision\": \"\"\n },\n \"subscription_plan_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"ANNUAL\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"CHE\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"RELATIVE\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"AOA\"\n }\n }\n }\n ],\n \"subscription_plan_variations\": [\n {\n \"value\": \"\"\n }\n ],\n \"eligible_item_ids\": [\n \"\"\n ],\n \"eligible_category_ids\": [\n \"\"\n ],\n \"all_items\": \"\"\n },\n \"item_option_data\": {\n \"name\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"show_colors\": \"\",\n \"values\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"item_option_value_data\": {\n \"item_option_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"color\": \"\",\n \"ordinal\": \"\"\n },\n \"custom_attribute_definition_data\": {\n \"type\": \"NUMBER\",\n \"name\": \"\",\n \"allowed_object_types\": [\n \"PRODUCT_SET\"\n ],\n \"description\": \"\",\n \"source_application\": {\n \"product\": \"EXTERNAL_API\",\n \"application_id\": \"\",\n \"name\": \"\"\n },\n \"seller_visibility\": \"SELLER_VISIBILITY_HIDDEN\",\n \"app_visibility\": \"APP_VISIBILITY_READ_ONLY\",\n \"string_config\": {\n \"enforce_uniqueness\": \"\"\n },\n \"number_config\": {\n \"precision\": \"\"\n },\n \"selection_config\": {\n \"max_allowed_selections\": \"\",\n \"allowed_selections\": [\n {\n \"name\": \"\",\n \"uid\": \"\"\n }\n ]\n },\n \"custom_attribute_usage_count\": \"\",\n \"key\": \"eF2sx\"\n },\n \"quick_amounts_settings_data\": {\n \"option\": \"AUTO\",\n \"eligible_for_auto_amounts\": \"\",\n \"amounts\": [\n {\n \"type\": \"QUICK_AMOUNT_TYPE_AUTO\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"KPW\"\n },\n \"score\": \"\",\n \"ordinal\": \"\"\n }\n ]\n },\n \"subscription_plan_variation_data\": {\n \"name\": \"\",\n \"phases\": [\n {\n \"cadence\": \"EVERY_SIX_MONTHS\",\n \"uid\": \"\",\n \"periods\": \"\",\n \"recurring_price_money\": {\n \"amount\": \"\",\n \"currency\": \"KGS\"\n },\n \"ordinal\": \"\",\n \"pricing\": {\n \"type\": \"STATIC\",\n \"discount_ids\": [\n \"\"\n ],\n \"price_money\": {\n \"amount\": \"\",\n \"currency\": \"YER\"\n }\n }\n }\n ],\n \"subscription_plan_id\": \"\",\n \"monthly_billing_anchor_date\": \"\",\n \"can_prorate\": \"\",\n \"successor_plan_variation_id\": \"\"\n },\n \"availability_period_data\": {\n \"start_local_time\": \"\",\n \"end_local_time\": \"\",\n \"day_of_week\": \"MON\"\n }\n }\n ],\n \"cursor\": \"\",\n \"matched_variation_ids\": [\n \"\"\n ]\n}", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-d9ec627c-0681-4ff1-aa5c-cb131fc4b9b1" } ], "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-fdf3f60c-2fc7-40a6-ab1e-0bec16a01907" } ], "id": "03889cd6-9cd9-4449-ac69-964f8817eef0", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-03889cd6-9cd9-4449-ac69-964f8817eef0" }, { "name": "update-item-modifier-lists", "item": [ { "name": "Square Update Item Modifier Lists", "id": "b795d9c7-7ff4-4579-9970-e95b4ce8304a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n \"\",\n \"\"\n ],\n \"modifier_lists_to_enable\": [\n \"\",\n \"\"\n ],\n \"modifier_lists_to_disable\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/catalog/update-item-modifier-lists", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "update-item-modifier-lists" ] }, "description": "Updates the [CatalogModifierList](entity:CatalogModifierList) objects\nthat apply to the targeted [CatalogItem](entity:CatalogItem) without having\nto perform an upsert on the entire item." }, "response": [ { "id": "e95f4d38-1faf-4b43-8c03-892628f476f0", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n \"\",\n \"\"\n ],\n \"modifier_lists_to_enable\": [\n \"\",\n \"\"\n ],\n \"modifier_lists_to_disable\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/catalog/update-item-modifier-lists", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "update-item-modifier-lists" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"INTERNAL_SERVER_ERROR\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"METHOD_NOT_ALLOWED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"updated_at\": \"\"\n}", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-e95f4d38-1faf-4b43-8c03-892628f476f0" } ], "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-b795d9c7-7ff4-4579-9970-e95b4ce8304a" } ], "id": "4ca6dae2-1808-4f0f-8246-566f3feb0001", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-4ca6dae2-1808-4f0f-8246-566f3feb0001" }, { "name": "update-item-taxes", "item": [ { "name": "Square Update Item Taxes", "id": "67916775-5718-4357-aee7-f504bce4fd4a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n \"\",\n \"\"\n ],\n \"taxes_to_enable\": [\n \"\",\n \"\"\n ],\n \"taxes_to_disable\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/catalog/update-item-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "update-item-taxes" ] }, "description": "Updates the [CatalogTax](entity:CatalogTax) objects that apply to the\ntargeted [CatalogItem](entity:CatalogItem) without having to perform an\nupsert on the entire item." }, "response": [ { "id": "82cee1af-aadb-40e7-96c2-1d9f36807bc2", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n \"\",\n \"\"\n ],\n \"taxes_to_enable\": [\n \"\",\n \"\"\n ],\n \"taxes_to_disable\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/catalog/update-item-taxes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "catalog", "update-item-taxes" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"MISSING_PIN\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"updated_at\": \"\"\n}", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-82cee1af-aadb-40e7-96c2-1d9f36807bc2" } ], "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-67916775-5718-4357-aee7-f504bce4fd4a" } ], "id": "a1ee57a6-c842-45a4-931b-97ca3cc3fe7a", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-a1ee57a6-c842-45a4-931b-97ca3cc3fe7a" } ], "id": "415980f2-4792-4286-9851-4990ff442052", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-415980f2-4792-4286-9851-4990ff442052" } ], "id": "50402cc7-b371-490e-8a86-2d4cf7d78db0", "createdAt": "2026-07-28T03:01:56.000Z", "updatedAt": "2026-07-28T03:01:56.000Z", "uid": "35240-50402cc7-b371-490e-8a86-2d4cf7d78db0" } ], "variable": [ { "key": "baseUrl", "value": "https://connect.squareup.com" } ] }