Ctrl K
BatchUpsertCatalogObjects

Published Oct 17, 2025
Creates or updates up to 10,000 target objects based on the provided list of objects.
Script square Verified
Use in Windmill
The script

Submitted by hugo697 Bun
Verified 235 days ago
All edits
Permalink
//native
type Square = {
  token: string;
};
/**
 * BatchUpsertCatalogObjects
 * Creates or updates up to 10,000 target objects based on the provided
list of objects.
 */
export async function main(
  auth: Square,
  body: {
    idempotency_key: string;
    batches: {
      objects: {
        type:
          | "ITEM"
          | "IMAGE"
          | "CATEGORY"
          | "ITEM_VARIATION"
          | "TAX"
          | "DISCOUNT"
          | "MODIFIER_LIST"
          | "MODIFIER"
          | "PRICING_RULE"
          | "PRODUCT_SET"
          | "TIME_PERIOD"
          | "MEASUREMENT_UNIT"
          | "SUBSCRIPTION_PLAN_VARIATION"
          | "ITEM_OPTION"
          | "ITEM_OPTION_VAL"
          | "CUSTOM_ATTRIBUTE_DEFINITION"
          | "QUICK_AMOUNTS_SETTINGS"
          | "SUBSCRIPTION_PLAN"
          | "AVAILABILITY_PERIOD";
        id: string;
        updated_at?: string;
        version?: number;
        is_deleted?: false | true;
        custom_attribute_values?: {};
        catalog_v1_ids?: { catalog_v1_id?: string; location_id?: string }[];
        present_at_all_locations?: false | true;
        present_at_location_ids?: string[];
        absent_at_location_ids?: string[];
        item_data?: {
          name?: string;
          description?: string;
          abbreviation?: string;
          label_color?: string;
          is_taxable?: false | true;
          available_online?: false | true;
          available_for_pickup?: false | true;
          available_electronically?: false | true;
          category_id?: string;
          tax_ids?: string[];
          modifier_list_info?: {
            modifier_list_id: string;
            modifier_overrides?: {
              modifier_id: string;
              on_by_default?: false | true;
            }[];
            min_selected_modifiers?: number;
            max_selected_modifiers?: number;
            enabled?: false | true;
            ordinal?: number;
          }[];
          variations?: {}[];
          product_type?:
            | "REGULAR"
            | "GIFT_CARD"
            | "APPOINTMENTS_SERVICE"
            | "FOOD_AND_BEV"
            | "EVENT"
            | "DIGITAL"
            | "DONATION"
            | "LEGACY_SQUARE_ONLINE_SERVICE"
            | "LEGACY_SQUARE_ONLINE_MEMBERSHIP";
          skip_modifier_screen?: false | true;
          item_options?: { item_option_id?: string }[];
          image_ids?: string[];
          sort_name?: string;
          categories?: { id?: string; ordinal?: number }[];
          description_html?: string;
          description_plaintext?: string;
          channels?: string[];
          is_archived?: false | true;
          ecom_seo_data?: {
            page_title?: string;
            page_description?: string;
            permalink?: string;
          };
          food_and_beverage_details?: {
            calorie_count?: number;
            dietary_preferences?: {
              type?: "STANDARD" | "CUSTOM";
              standard_name?:
                | "DAIRY_FREE"
                | "GLUTEN_FREE"
                | "HALAL"
                | "KOSHER"
                | "NUT_FREE"
                | "VEGAN"
                | "VEGETARIAN";
              custom_name?: string;
            }[];
            ingredients?: {
              type?: "STANDARD" | "CUSTOM";
              standard_name?:
                | "CELERY"
                | "CRUSTACEANS"
                | "EGGS"
                | "FISH"
                | "GLUTEN"
                | "LUPIN"
                | "MILK"
                | "MOLLUSCS"
                | "MUSTARD"
                | "PEANUTS"
                | "SESAME"
                | "SOY"
                | "SULPHITES"
                | "TREE_NUTS";
              custom_name?: string;
            }[];
          };
          reporting_category?: { id?: string; ordinal?: number };
        };
        category_data?: {
          name?: string;
          image_ids?: string[];
          category_type?:
            | "REGULAR_CATEGORY"
            | "MENU_CATEGORY"
            | "KITCHEN_CATEGORY";
          parent_category?: { id?: string; ordinal?: number };
          is_top_level?: false | true;
          channels?: string[];
          availability_period_ids?: string[];
          online_visibility?: false | true;
          root_category?: string;
          ecom_seo_data?: {
            page_title?: string;
            page_description?: string;
            permalink?: string;
          };
          path_to_root?: { category_id?: string; category_name?: string }[];
        };
        item_variation_data?: {
          item_id?: string;
          name?: string;
          sku?: string;
          upc?: string;
          ordinal?: number;
          pricing_type?: "FIXED_PRICING" | "VARIABLE_PRICING";
          price_money?: {
            amount?: number;
            currency?:
              | "UNKNOWN_CURRENCY"
              | "AED"
              | "AFN"
              | "ALL"
              | "AMD"
              | "ANG"
              | "AOA"
              | "ARS"
              | "AUD"
              | "AWG"
              | "AZN"
              | "BAM"
              | "BBD"
              | "BDT"
              | "BGN"
              | "BHD"
              | "BIF"
              | "BMD"
              | "BND"
              | "BOB"
              | "BOV"
              | "BRL"
              | "BSD"
              | "BTN"
              | "BWP"
              | "BYR"
              | "BZD"
              | "CAD"
              | "CDF"
              | "CHE"
              | "CHF"
              | "CHW"
              | "CLF"
              | "CLP"
              | "CNY"
              | "COP"
              | "COU"
              | "CRC"
              | "CUC"
              | "CUP"
              | "CVE"
              | "CZK"
              | "DJF"
              | "DKK"
              | "DOP"
              | "DZD"
              | "EGP"
              | "ERN"
              | "ETB"
              | "EUR"
              | "FJD"
              | "FKP"
              | "GBP"
              | "GEL"
              | "GHS"
              | "GIP"
              | "GMD"
              | "GNF"
              | "GTQ"
              | "GYD"
              | "HKD"
              | "HNL"
              | "HRK"
              | "HTG"
              | "HUF"
              | "IDR"
              | "ILS"
              | "INR"
              | "IQD"
              | "IRR"
              | "ISK"
              | "JMD"
              | "JOD"
              | "JPY"
              | "KES"
              | "KGS"
              | "KHR"
              | "KMF"
              | "KPW"
              | "KRW"
              | "KWD"
              | "KYD"
              | "KZT"
              | "LAK"
              | "LBP"
              | "LKR"
              | "LRD"
              | "LSL"
              | "LTL"
              | "LVL"
              | "LYD"
              | "MAD"
              | "MDL"
              | "MGA"
              | "MKD"
              | "MMK"
              | "MNT"
              | "MOP"
              | "MRO"
              | "MUR"
              | "MVR"
              | "MWK"
              | "MXN"
              | "MXV"
              | "MYR"
              | "MZN"
              | "NAD"
              | "NGN"
              | "NIO"
              | "NOK"
              | "NPR"
              | "NZD"
              | "OMR"
              | "PAB"
              | "PEN"
              | "PGK"
              | "PHP"
              | "PKR"
              | "PLN"
              | "PYG"
              | "QAR"
              | "RON"
              | "RSD"
              | "RUB"
              | "RWF"
              | "SAR"
              | "SBD"
              | "SCR"
              | "SDG"
              | "SEK"
              | "SGD"
              | "SHP"
              | "SLL"
              | "SLE"
              | "SOS"
              | "SRD"
              | "SSP"
              | "STD"
              | "SVC"
              | "SYP"
              | "SZL"
              | "THB"
              | "TJS"
              | "TMT"
              | "TND"
              | "TOP"
              | "TRY"
              | "TTD"
              | "TWD"
              | "TZS"
              | "UAH"
              | "UGX"
              | "USD"
              | "USN"
              | "USS"
              | "UYI"
              | "UYU"
              | "UZS"
              | "VEF"
              | "VND"
              | "VUV"
              | "WST"
              | "XAF"
              | "XAG"
              | "XAU"
              | "XBA"
              | "XBB"
              | "XBC"
              | "XBD"
              | "XCD"
              | "XDR"
              | "XOF"
              | "XPD"
              | "XPF"
              | "XPT"
              | "XTS"
              | "XXX"
              | "YER"
              | "ZAR"
              | "ZMK"
              | "ZMW"
              | "BTC"
              | "XUS";
          };
          location_overrides?: {
            location_id?: string;
            price_money?: {
              amount?: number;
              currency?:
                | "UNKNOWN_CURRENCY"
                | "AED"
                | "AFN"
                | "ALL"
                | "AMD"
                | "ANG"
                | "AOA"
                | "ARS"
                | "AUD"
                | "AWG"
                | "AZN"
                | "BAM"
                | "BBD"
                | "BDT"
                | "BGN"
                | "BHD"
                | "BIF"
                | "BMD"
                | "BND"
                | "BOB"
                | "BOV"
                | "BRL"
                | "BSD"
                | "BTN"
                | "BWP"
                | "BYR"
                | "BZD"
                | "CAD"
                | "CDF"
                | "CHE"
                | "CHF"
                | "CHW"
                | "CLF"
                | "CLP"
                | "CNY"
                | "COP"
                | "COU"
                | "CRC"
                | "CUC"
                | "CUP"
                | "CVE"
                | "CZK"
                | "DJF"
                | "DKK"
                | "DOP"
                | "DZD"
                | "EGP"
                | "ERN"
                | "ETB"
                | "EUR"
                | "FJD"
                | "FKP"
                | "GBP"
                | "GEL"
                | "GHS"
                | "GIP"
                | "GMD"
                | "GNF"
                | "GTQ"
                | "GYD"
                | "HKD"
                | "HNL"
                | "HRK"
                | "HTG"
                | "HUF"
                | "IDR"
                | "ILS"
                | "INR"
                | "IQD"
                | "IRR"
                | "ISK"
                | "JMD"
                | "JOD"
                | "JPY"
                | "KES"
                | "KGS"
                | "KHR"
                | "KMF"
                | "KPW"
                | "KRW"
                | "KWD"
                | "KYD"
                | "KZT"
                | "LAK"
                | "LBP"
                | "LKR"
                | "LRD"
                | "LSL"
                | "LTL"
                | "LVL"
                | "LYD"
                | "MAD"
                | "MDL"
                | "MGA"
                | "MKD"
                | "MMK"
                | "MNT"
                | "MOP"
                | "MRO"
                | "MUR"
                | "MVR"
                | "MWK"
                | "MXN"
                | "MXV"
                | "MYR"
                | "MZN"
                | "NAD"
                | "NGN"
                | "NIO"
                | "NOK"
                | "NPR"
                | "NZD"
                | "OMR"
                | "PAB"
                | "PEN"
                | "PGK"
                | "PHP"
                | "PKR"
                | "PLN"
                | "PYG"
                | "QAR"
                | "RON"
                | "RSD"
                | "RUB"
                | "RWF"
                | "SAR"
                | "SBD"
                | "SCR"
                | "SDG"
                | "SEK"
                | "SGD"
                | "SHP"
                | "SLL"
                | "SLE"
                | "SOS"
                | "SRD"
                | "SSP"
                | "STD"
                | "SVC"
                | "SYP"
                | "SZL"
                | "THB"
                | "TJS"
                | "TMT"
                | "TND"
                | "TOP"
                | "TRY"
                | "TTD"
                | "TWD"
                | "TZS"
                | "UAH"
                | "UGX"
                | "USD"
                | "USN"
                | "USS"
                | "UYI"
                | "UYU"
                | "UZS"
                | "VEF"
                | "VND"
                | "VUV"
                | "WST"
                | "XAF"
                | "XAG"
                | "XAU"
                | "XBA"
                | "XBB"
                | "XBC"
                | "XBD"
                | "XCD"
                | "XDR"
                | "XOF"
                | "XPD"
                | "XPF"
                | "XPT"
                | "XTS"
                | "XXX"
                | "YER"
                | "ZAR"
                | "ZMK"
                | "ZMW"
                | "BTC"
                | "XUS";
            };
            pricing_type?: "FIXED_PRICING" | "VARIABLE_PRICING";
            track_inventory?: false | true;
            inventory_alert_type?: "NONE" | "LOW_QUANTITY";
            inventory_alert_threshold?: number;
            sold_out?: false | true;
            sold_out_valid_until?: string;
          }[];
          track_inventory?: false | true;
          inventory_alert_type?: "NONE" | "LOW_QUANTITY";
          inventory_alert_threshold?: number;
          user_data?: string;
          service_duration?: number;
          available_for_booking?: false | true;
          item_option_values?: {
            item_option_id?: string;
            item_option_value_id?: string;
          }[];
          measurement_unit_id?: string;
          sellable?: false | true;
          stockable?: false | true;
          image_ids?: string[];
          team_member_ids?: string[];
          stockable_conversion?: {
            stockable_item_variation_id: string;
            stockable_quantity: string;
            nonstockable_quantity: string;
          };
        };
        tax_data?: {
          name?: string;
          calculation_phase?: "TAX_SUBTOTAL_PHASE" | "TAX_TOTAL_PHASE";
          inclusion_type?: "ADDITIVE" | "INCLUSIVE";
          percentage?: string;
          applies_to_custom_amounts?: false | true;
          enabled?: false | true;
          applies_to_product_set_id?: string;
        };
        discount_data?: {
          name?: string;
          discount_type?:
            | "FIXED_PERCENTAGE"
            | "FIXED_AMOUNT"
            | "VARIABLE_PERCENTAGE"
            | "VARIABLE_AMOUNT";
          percentage?: string;
          amount_money?: {
            amount?: number;
            currency?:
              | "UNKNOWN_CURRENCY"
              | "AED"
              | "AFN"
              | "ALL"
              | "AMD"
              | "ANG"
              | "AOA"
              | "ARS"
              | "AUD"
              | "AWG"
              | "AZN"
              | "BAM"
              | "BBD"
              | "BDT"
              | "BGN"
              | "BHD"
              | "BIF"
              | "BMD"
              | "BND"
              | "BOB"
              | "BOV"
              | "BRL"
              | "BSD"
              | "BTN"
              | "BWP"
              | "BYR"
              | "BZD"
              | "CAD"
              | "CDF"
              | "CHE"
              | "CHF"
              | "CHW"
              | "CLF"
              | "CLP"
              | "CNY"
              | "COP"
              | "COU"
              | "CRC"
              | "CUC"
              | "CUP"
              | "CVE"
              | "CZK"
              | "DJF"
              | "DKK"
              | "DOP"
              | "DZD"
              | "EGP"
              | "ERN"
              | "ETB"
              | "EUR"
              | "FJD"
              | "FKP"
              | "GBP"
              | "GEL"
              | "GHS"
              | "GIP"
              | "GMD"
              | "GNF"
              | "GTQ"
              | "GYD"
              | "HKD"
              | "HNL"
              | "HRK"
              | "HTG"
              | "HUF"
              | "IDR"
              | "ILS"
              | "INR"
              | "IQD"
              | "IRR"
              | "ISK"
              | "JMD"
              | "JOD"
              | "JPY"
              | "KES"
              | "KGS"
              | "KHR"
              | "KMF"
              | "KPW"
              | "KRW"
              | "KWD"
              | "KYD"
              | "KZT"
              | "LAK"
              | "LBP"
              | "LKR"
              | "LRD"
              | "LSL"
              | "LTL"
              | "LVL"
              | "LYD"
              | "MAD"
              | "MDL"
              | "MGA"
              | "MKD"
              | "MMK"
              | "MNT"
              | "MOP"
              | "MRO"
              | "MUR"
              | "MVR"
              | "MWK"
              | "MXN"
              | "MXV"
              | "MYR"
              | "MZN"
              | "NAD"
              | "NGN"
              | "NIO"
              | "NOK"
              | "NPR"
              | "NZD"
              | "OMR"
              | "PAB"
              | "PEN"
              | "PGK"
              | "PHP"
              | "PKR"
              | "PLN"
              | "PYG"
              | "QAR"
              | "RON"
              | "RSD"
              | "RUB"
              | "RWF"
              | "SAR"
              | "SBD"
              | "SCR"
              | "SDG"
              | "SEK"
              | "SGD"
              | "SHP"
              | "SLL"
              | "SLE"
              | "SOS"
              | "SRD"
              | "SSP"
              | "STD"
              | "SVC"
              | "SYP"
              | "SZL"
              | "THB"
              | "TJS"
              | "TMT"
              | "TND"
              | "TOP"
              | "TRY"
              | "TTD"
              | "TWD"
              | "TZS"
              | "UAH"
              | "UGX"
              | "USD"
              | "USN"
              | "USS"
              | "UYI"
              | "UYU"
              | "UZS"
              | "VEF"
              | "VND"
              | "VUV"
              | "WST"
              | "XAF"
              | "XAG"
              | "XAU"
              | "XBA"
              | "XBB"
              | "XBC"
              | "XBD"
              | "XCD"
              | "XDR"
              | "XOF"
              | "XPD"
              | "XPF"
              | "XPT"
              | "XTS"
              | "XXX"
              | "YER"
              | "ZAR"
              | "ZMK"
              | "ZMW"
              | "BTC"
              | "XUS";
          };
          pin_required?: false | true;
          label_color?: string;
          modify_tax_basis?: "MODIFY_TAX_BASIS" | "DO_NOT_MODIFY_TAX_BASIS";
          maximum_amount_money?: {
            amount?: number;
            currency?:
              | "UNKNOWN_CURRENCY"
              | "AED"
              | "AFN"
              | "ALL"
              | "AMD"
              | "ANG"
              | "AOA"
              | "ARS"
              | "AUD"
              | "AWG"
              | "AZN"
              | "BAM"
              | "BBD"
              | "BDT"
              | "BGN"
              | "BHD"
              | "BIF"
              | "BMD"
              | "BND"
              | "BOB"
              | "BOV"
              | "BRL"
              | "BSD"
              | "BTN"
              | "BWP"
              | "BYR"
              | "BZD"
              | "CAD"
              | "CDF"
              | "CHE"
              | "CHF"
              | "CHW"
              | "CLF"
              | "CLP"
              | "CNY"
              | "COP"
              | "COU"
              | "CRC"
              | "CUC"
              | "CUP"
              | "CVE"
              | "CZK"
              | "DJF"
              | "DKK"
              | "DOP"
              | "DZD"
              | "EGP"
              | "ERN"
              | "ETB"
              | "EUR"
              | "FJD"
              | "FKP"
              | "GBP"
              | "GEL"
              | "GHS"
              | "GIP"
              | "GMD"
              | "GNF"
              | "GTQ"
              | "GYD"
              | "HKD"
              | "HNL"
              | "HRK"
              | "HTG"
              | "HUF"
              | "IDR"
              | "ILS"
              | "INR"
              | "IQD"
              | "IRR"
              | "ISK"
              | "JMD"
              | "JOD"
              | "JPY"
              | "KES"
              | "KGS"
              | "KHR"
              | "KMF"
              | "KPW"
              | "KRW"
              | "KWD"
              | "KYD"
              | "KZT"
              | "LAK"
              | "LBP"
              | "LKR"
              | "LRD"
              | "LSL"
              | "LTL"
              | "LVL"
              | "LYD"
              | "MAD"
              | "MDL"
              | "MGA"
              | "MKD"
              | "MMK"
              | "MNT"
              | "MOP"
              | "MRO"
              | "MUR"
              | "MVR"
              | "MWK"
              | "MXN"
              | "MXV"
              | "MYR"
              | "MZN"
              | "NAD"
              | "NGN"
              | "NIO"
              | "NOK"
              | "NPR"
              | "NZD"
              | "OMR"
              | "PAB"
              | "PEN"
              | "PGK"
              | "PHP"
              | "PKR"
              | "PLN"
              | "PYG"
              | "QAR"
              | "RON"
              | "RSD"
              | "RUB"
              | "RWF"
              | "SAR"
              | "SBD"
              | "SCR"
              | "SDG"
              | "SEK"
              | "SGD"
              | "SHP"
              | "SLL"
              | "SLE"
              | "SOS"
              | "SRD"
              | "SSP"
              | "STD"
              | "SVC"
              | "SYP"
              | "SZL"
              | "THB"
              | "TJS"
              | "TMT"
              | "TND"
              | "TOP"
              | "TRY"
              | "TTD"
              | "TWD"
              | "TZS"
              | "UAH"
              | "UGX"
              | "USD"
              | "USN"
              | "USS"
              | "UYI"
              | "UYU"
              | "UZS"
              | "VEF"
              | "VND"
              | "VUV"
              | "WST"
              | "XAF"
              | "XAG"
              | "XAU"
              | "XBA"
              | "XBB"
              | "XBC"
              | "XBD"
              | "XCD"
              | "XDR"
              | "XOF"
              | "XPD"
              | "XPF"
              | "XPT"
              | "XTS"
              | "XXX"
              | "YER"
              | "ZAR"
              | "ZMK"
              | "ZMW"
              | "BTC"
              | "XUS";
          };
        };
        modifier_list_data?: {
          name?: string;
          ordinal?: number;
          selection_type?: "SINGLE" | "MULTIPLE";
          modifiers?: {}[];
          image_ids?: string[];
          modifier_type?: "LIST" | "TEXT";
          max_length?: number;
          text_required?: false | true;
          internal_name?: string;
        };
        modifier_data?: {
          name?: string;
          price_money?: {
            amount?: number;
            currency?:
              | "UNKNOWN_CURRENCY"
              | "AED"
              | "AFN"
              | "ALL"
              | "AMD"
              | "ANG"
              | "AOA"
              | "ARS"
              | "AUD"
              | "AWG"
              | "AZN"
              | "BAM"
              | "BBD"
              | "BDT"
              | "BGN"
              | "BHD"
              | "BIF"
              | "BMD"
              | "BND"
              | "BOB"
              | "BOV"
              | "BRL"
              | "BSD"
              | "BTN"
              | "BWP"
              | "BYR"
              | "BZD"
              | "CAD"
              | "CDF"
              | "CHE"
              | "CHF"
              | "CHW"
              | "CLF"
              | "CLP"
              | "CNY"
              | "COP"
              | "COU"
              | "CRC"
              | "CUC"
              | "CUP"
              | "CVE"
              | "CZK"
              | "DJF"
              | "DKK"
              | "DOP"
              | "DZD"
              | "EGP"
              | "ERN"
              | "ETB"
              | "EUR"
              | "FJD"
              | "FKP"
              | "GBP"
              | "GEL"
              | "GHS"
              | "GIP"
              | "GMD"
              | "GNF"
              | "GTQ"
              | "GYD"
              | "HKD"
              | "HNL"
              | "HRK"
              | "HTG"
              | "HUF"
              | "IDR"
              | "ILS"
              | "INR"
              | "IQD"
              | "IRR"
              | "ISK"
              | "JMD"
              | "JOD"
              | "JPY"
              | "KES"
              | "KGS"
              | "KHR"
              | "KMF"
              | "KPW"
              | "KRW"
              | "KWD"
              | "KYD"
              | "KZT"
              | "LAK"
              | "LBP"
              | "LKR"
              | "LRD"
              | "LSL"
              | "LTL"
              | "LVL"
              | "LYD"
              | "MAD"
              | "MDL"
              | "MGA"
              | "MKD"
              | "MMK"
              | "MNT"
              | "MOP"
              | "MRO"
              | "MUR"
              | "MVR"
              | "MWK"
              | "MXN"
              | "MXV"
              | "MYR"
              | "MZN"
              | "NAD"
              | "NGN"
              | "NIO"
              | "NOK"
              | "NPR"
              | "NZD"
              | "OMR"
              | "PAB"
              | "PEN"
              | "PGK"
              | "PHP"
              | "PKR"
              | "PLN"
              | "PYG"
              | "QAR"
              | "RON"
              | "RSD"
              | "RUB"
              | "RWF"
              | "SAR"
              | "SBD"
              | "SCR"
              | "SDG"
              | "SEK"
              | "SGD"
              | "SHP"
              | "SLL"
              | "SLE"
              | "SOS"
              | "SRD"
              | "SSP"
              | "STD"
              | "SVC"
              | "SYP"
              | "SZL"
              | "THB"
              | "TJS"
              | "TMT"
              | "TND"
              | "TOP"
              | "TRY"
              | "TTD"
              | "TWD"
              | "TZS"
              | "UAH"
              | "UGX"
              | "USD"
              | "USN"
              | "USS"
              | "UYI"
              | "UYU"
              | "UZS"
              | "VEF"
              | "VND"
              | "VUV"
              | "WST"
              | "XAF"
              | "XAG"
              | "XAU"
              | "XBA"
              | "XBB"
              | "XBC"
              | "XBD"
              | "XCD"
              | "XDR"
              | "XOF"
              | "XPD"
              | "XPF"
              | "XPT"
              | "XTS"
              | "XXX"
              | "YER"
              | "ZAR"
              | "ZMK"
              | "ZMW"
              | "BTC"
              | "XUS";
          };
          ordinal?: number;
          modifier_list_id?: string;
          location_overrides?: {
            location_id?: string;
            price_money?: {
              amount?: number;
              currency?:
                | "UNKNOWN_CURRENCY"
                | "AED"
                | "AFN"
                | "ALL"
                | "AMD"
                | "ANG"
                | "AOA"
                | "ARS"
                | "AUD"
                | "AWG"
                | "AZN"
                | "BAM"
                | "BBD"
                | "BDT"
                | "BGN"
                | "BHD"
                | "BIF"
                | "BMD"
                | "BND"
                | "BOB"
                | "BOV"
                | "BRL"
                | "BSD"
                | "BTN"
                | "BWP"
                | "BYR"
                | "BZD"
                | "CAD"
                | "CDF"
                | "CHE"
                | "CHF"
                | "CHW"
                | "CLF"
                | "CLP"
                | "CNY"
                | "COP"
                | "COU"
                | "CRC"
                | "CUC"
                | "CUP"
                | "CVE"
                | "CZK"
                | "DJF"
                | "DKK"
                | "DOP"
                | "DZD"
                | "EGP"
                | "ERN"
                | "ETB"
                | "EUR"
                | "FJD"
                | "FKP"
                | "GBP"
                | "GEL"
                | "GHS"
                | "GIP"
                | "GMD"
                | "GNF"
                | "GTQ"
                | "GYD"
                | "HKD"
                | "HNL"
                | "HRK"
                | "HTG"
                | "HUF"
                | "IDR"
                | "ILS"
                | "INR"
                | "IQD"
                | "IRR"
                | "ISK"
                | "JMD"
                | "JOD"
                | "JPY"
                | "KES"
                | "KGS"
                | "KHR"
                | "KMF"
                | "KPW"
                | "KRW"
                | "KWD"
                | "KYD"
                | "KZT"
                | "LAK"
                | "LBP"
                | "LKR"
                | "LRD"
                | "LSL"
                | "LTL"
                | "LVL"
                | "LYD"
                | "MAD"
                | "MDL"
                | "MGA"
                | "MKD"
                | "MMK"
                | "MNT"
                | "MOP"
                | "MRO"
                | "MUR"
                | "MVR"
                | "MWK"
                | "MXN"
                | "MXV"
                | "MYR"
                | "MZN"
                | "NAD"
                | "NGN"
                | "NIO"
                | "NOK"
                | "NPR"
                | "NZD"
                | "OMR"
                | "PAB"
                | "PEN"
                | "PGK"
                | "PHP"
                | "PKR"
                | "PLN"
                | "PYG"
                | "QAR"
                | "RON"
                | "RSD"
                | "RUB"
                | "RWF"
                | "SAR"
                | "SBD"
                | "SCR"
                | "SDG"
                | "SEK"
                | "SGD"
                | "SHP"
                | "SLL"
                | "SLE"
                | "SOS"
                | "SRD"
                | "SSP"
                | "STD"
                | "SVC"
                | "SYP"
                | "SZL"
                | "THB"
                | "TJS"
                | "TMT"
                | "TND"
                | "TOP"
                | "TRY"
                | "TTD"
                | "TWD"
                | "TZS"
                | "UAH"
                | "UGX"
                | "USD"
                | "USN"
                | "USS"
                | "UYI"
                | "UYU"
                | "UZS"
                | "VEF"
                | "VND"
                | "VUV"
                | "WST"
                | "XAF"
                | "XAG"
                | "XAU"
                | "XBA"
                | "XBB"
                | "XBC"
                | "XBD"
                | "XCD"
                | "XDR"
                | "XOF"
                | "XPD"
                | "XPF"
                | "XPT"
                | "XTS"
                | "XXX"
                | "YER"
                | "ZAR"
                | "ZMK"
                | "ZMW"
                | "BTC"
                | "XUS";
            };
            sold_out?: false | true;
          }[];
          image_id?: string;
        };
        time_period_data?: { event?: string };
        product_set_data?: {
          name?: string;
          product_ids_any?: string[];
          product_ids_all?: string[];
          quantity_exact?: number;
          quantity_min?: number;
          quantity_max?: number;
          all_products?: false | true;
        };
        pricing_rule_data?: {
          name?: string;
          time_period_ids?: string[];
          discount_id?: string;
          match_products_id?: string;
          apply_products_id?: string;
          exclude_products_id?: string;
          valid_from_date?: string;
          valid_from_local_time?: string;
          valid_until_date?: string;
          valid_until_local_time?: string;
          exclude_strategy?: "LEAST_EXPENSIVE" | "MOST_EXPENSIVE";
          minimum_order_subtotal_money?: {
            amount?: number;
            currency?:
              | "UNKNOWN_CURRENCY"
              | "AED"
              | "AFN"
              | "ALL"
              | "AMD"
              | "ANG"
              | "AOA"
              | "ARS"
              | "AUD"
              | "AWG"
              | "AZN"
              | "BAM"
              | "BBD"
              | "BDT"
              | "BGN"
              | "BHD"
              | "BIF"
              | "BMD"
              | "BND"
              | "BOB"
              | "BOV"
              | "BRL"
              | "BSD"
              | "BTN"
              | "BWP"
              | "BYR"
              | "BZD"
              | "CAD"
              | "CDF"
              | "CHE"
              | "CHF"
              | "CHW"
              | "CLF"
              | "CLP"
              | "CNY"
              | "COP"
              | "COU"
              | "CRC"
              | "CUC"
              | "CUP"
              | "CVE"
              | "CZK"
              | "DJF"
              | "DKK"
              | "DOP"
              | "DZD"
              | "EGP"
              | "ERN"
              | "ETB"
              | "EUR"
              | "FJD"
              | "FKP"
              | "GBP"
              | "GEL"
              | "GHS"
              | "GIP"
              | "GMD"
              | "GNF"
              | "GTQ"
              | "GYD"
              | "HKD"
              | "HNL"
              | "HRK"
              | "HTG"
              | "HUF"
              | "IDR"
              | "ILS"
              | "INR"
              | "IQD"
              | "IRR"
              | "ISK"
              | "JMD"
              | "JOD"
              | "JPY"
              | "KES"
              | "KGS"
              | "KHR"
              | "KMF"
              | "KPW"
              | "KRW"
              | "KWD"
              | "KYD"
              | "KZT"
              | "LAK"
              | "LBP"
              | "LKR"
              | "LRD"
              | "LSL"
              | "LTL"
              | "LVL"
              | "LYD"
              | "MAD"
              | "MDL"
              | "MGA"
              | "MKD"
              | "MMK"
              | "MNT"
              | "MOP"
              | "MRO"
              | "MUR"
              | "MVR"
              | "MWK"
              | "MXN"
              | "MXV"
              | "MYR"
              | "MZN"
              | "NAD"
              | "NGN"
              | "NIO"
              | "NOK"
              | "NPR"
              | "NZD"
              | "OMR"
              | "PAB"
              | "PEN"
              | "PGK"
              | "PHP"
              | "PKR"
              | "PLN"
              | "PYG"
              | "QAR"
              | "RON"
              | "RSD"
              | "RUB"
              | "RWF"
              | "SAR"
              | "SBD"
              | "SCR"
              | "SDG"
              | "SEK"
              | "SGD"
              | "SHP"
              | "SLL"
              | "SLE"
              | "SOS"
              | "SRD"
              | "SSP"
              | "STD"
              | "SVC"
              | "SYP"
              | "SZL"
              | "THB"
              | "TJS"
              | "TMT"
              | "TND"
              | "TOP"
              | "TRY"
              | "TTD"
              | "TWD"
              | "TZS"
              | "UAH"
              | "UGX"
              | "USD"
              | "USN"
              | "USS"
              | "UYI"
              | "UYU"
              | "UZS"
              | "VEF"
              | "VND"
              | "VUV"
              | "WST"
              | "XAF"
              | "XAG"
              | "XAU"
              | "XBA"
              | "XBB"
              | "XBC"
              | "XBD"
              | "XCD"
              | "XDR"
              | "XOF"
              | "XPD"
              | "XPF"
              | "XPT"
              | "XTS"
              | "XXX"
              | "YER"
              | "ZAR"
              | "ZMK"
              | "ZMW"
              | "BTC"
              | "XUS";
          };
          customer_group_ids_any?: string[];
        };
        image_data?: {
          name?: string;
          url?: string;
          caption?: string;
          photo_studio_order_id?: string;
        };
        measurement_unit_data?: {
          measurement_unit?: {
            custom_unit?: { name: string; abbreviation: string };
            area_unit?:
              | "IMPERIAL_ACRE"
              | "IMPERIAL_SQUARE_INCH"
              | "IMPERIAL_SQUARE_FOOT"
              | "IMPERIAL_SQUARE_YARD"
              | "IMPERIAL_SQUARE_MILE"
              | "METRIC_SQUARE_CENTIMETER"
              | "METRIC_SQUARE_METER"
              | "METRIC_SQUARE_KILOMETER";
            length_unit?:
              | "IMPERIAL_INCH"
              | "IMPERIAL_FOOT"
              | "IMPERIAL_YARD"
              | "IMPERIAL_MILE"
              | "METRIC_MILLIMETER"
              | "METRIC_CENTIMETER"
              | "METRIC_METER"
              | "METRIC_KILOMETER";
            volume_unit?:
              | "GENERIC_FLUID_OUNCE"
              | "GENERIC_SHOT"
              | "GENERIC_CUP"
              | "GENERIC_PINT"
              | "GENERIC_QUART"
              | "GENERIC_GALLON"
              | "IMPERIAL_CUBIC_INCH"
              | "IMPERIAL_CUBIC_FOOT"
              | "IMPERIAL_CUBIC_YARD"
              | "METRIC_MILLILITER"
              | "METRIC_LITER";
            weight_unit?:
              | "IMPERIAL_WEIGHT_OUNCE"
              | "IMPERIAL_POUND"
              | "IMPERIAL_STONE"
              | "METRIC_MILLIGRAM"
              | "METRIC_GRAM"
              | "METRIC_KILOGRAM";
            generic_unit?: "UNIT";
            time_unit?:
              | "GENERIC_MILLISECOND"
              | "GENERIC_SECOND"
              | "GENERIC_MINUTE"
              | "GENERIC_HOUR"
              | "GENERIC_DAY";
            type?:
              | "TYPE_CUSTOM"
              | "TYPE_AREA"
              | "TYPE_LENGTH"
              | "TYPE_VOLUME"
              | "TYPE_WEIGHT"
              | "TYPE_GENERIC";
          };
          precision?: number;
        };
        subscription_plan_data?: {
          name: string;
          phases?: {
            uid?: string;
            cadence:
              | "DAILY"
              | "WEEKLY"
              | "EVERY_TWO_WEEKS"
              | "THIRTY_DAYS"
              | "SIXTY_DAYS"
              | "NINETY_DAYS"
              | "MONTHLY"
              | "EVERY_TWO_MONTHS"
              | "QUARTERLY"
              | "EVERY_FOUR_MONTHS"
              | "EVERY_SIX_MONTHS"
              | "ANNUAL"
              | "EVERY_TWO_YEARS";
            periods?: number;
            recurring_price_money?: {
              amount?: number;
              currency?:
                | "UNKNOWN_CURRENCY"
                | "AED"
                | "AFN"
                | "ALL"
                | "AMD"
                | "ANG"
                | "AOA"
                | "ARS"
                | "AUD"
                | "AWG"
                | "AZN"
                | "BAM"
                | "BBD"
                | "BDT"
                | "BGN"
                | "BHD"
                | "BIF"
                | "BMD"
                | "BND"
                | "BOB"
                | "BOV"
                | "BRL"
                | "BSD"
                | "BTN"
                | "BWP"
                | "BYR"
                | "BZD"
                | "CAD"
                | "CDF"
                | "CHE"
                | "CHF"
                | "CHW"
                | "CLF"
                | "CLP"
                | "CNY"
                | "COP"
                | "COU"
                | "CRC"
                | "CUC"
                | "CUP"
                | "CVE"
                | "CZK"
                | "DJF"
                | "DKK"
                | "DOP"
                | "DZD"
                | "EGP"
                | "ERN"
                | "ETB"
                | "EUR"
                | "FJD"
                | "FKP"
                | "GBP"
                | "GEL"
                | "GHS"
                | "GIP"
                | "GMD"
                | "GNF"
                | "GTQ"
                | "GYD"
                | "HKD"
                | "HNL"
                | "HRK"
                | "HTG"
                | "HUF"
                | "IDR"
                | "ILS"
                | "INR"
                | "IQD"
                | "IRR"
                | "ISK"
                | "JMD"
                | "JOD"
                | "JPY"
                | "KES"
                | "KGS"
                | "KHR"
                | "KMF"
                | "KPW"
                | "KRW"
                | "KWD"
                | "KYD"
                | "KZT"
                | "LAK"
                | "LBP"
                | "LKR"
                | "LRD"
                | "LSL"
                | "LTL"
                | "LVL"
                | "LYD"
                | "MAD"
                | "MDL"
                | "MGA"
                | "MKD"
                | "MMK"
                | "MNT"
                | "MOP"
                | "MRO"
                | "MUR"
                | "MVR"
                | "MWK"
                | "MXN"
                | "MXV"
                | "MYR"
                | "MZN"
                | "NAD"
                | "NGN"
                | "NIO"
                | "NOK"
                | "NPR"
                | "NZD"
                | "OMR"
                | "PAB"
                | "PEN"
                | "PGK"
                | "PHP"
                | "PKR"
                | "PLN"
                | "PYG"
                | "QAR"
                | "RON"
                | "RSD"
                | "RUB"
                | "RWF"
                | "SAR"
                | "SBD"
                | "SCR"
                | "SDG"
                | "SEK"
                | "SGD"
                | "SHP"
                | "SLL"
                | "SLE"
                | "SOS"
                | "SRD"
                | "SSP"
                | "STD"
                | "SVC"
                | "SYP"
                | "SZL"
                | "THB"
                | "TJS"
                | "TMT"
                | "TND"
                | "TOP"
                | "TRY"
                | "TTD"
                | "TWD"
                | "TZS"
                | "UAH"
                | "UGX"
                | "USD"
                | "USN"
                | "USS"
                | "UYI"
                | "UYU"
                | "UZS"
                | "VEF"
                | "VND"
                | "VUV"
                | "WST"
                | "XAF"
                | "XAG"
                | "XAU"
                | "XBA"
                | "XBB"
                | "XBC"
                | "XBD"
                | "XCD"
                | "XDR"
                | "XOF"
                | "XPD"
                | "XPF"
                | "XPT"
                | "XTS"
                | "XXX"
                | "YER"
                | "ZAR"
                | "ZMK"
                | "ZMW"
                | "BTC"
                | "XUS";
            };
            ordinal?: number;
            pricing?: {
              type?: "STATIC" | "RELATIVE";
              discount_ids?: string[];
              price_money?: {
                amount?: number;
                currency?:
                  | "UNKNOWN_CURRENCY"
                  | "AED"
                  | "AFN"
                  | "ALL"
                  | "AMD"
                  | "ANG"
                  | "AOA"
                  | "ARS"
                  | "AUD"
                  | "AWG"
                  | "AZN"
                  | "BAM"
                  | "BBD"
                  | "BDT"
                  | "BGN"
                  | "BHD"
                  | "BIF"
                  | "BMD"
                  | "BND"
                  | "BOB"
                  | "BOV"
                  | "BRL"
                  | "BSD"
                  | "BTN"
                  | "BWP"
                  | "BYR"
                  | "BZD"
                  | "CAD"
                  | "CDF"
                  | "CHE"
                  | "CHF"
                  | "CHW"
                  | "CLF"
                  | "CLP"
                  | "CNY"
                  | "COP"
                  | "COU"
                  | "CRC"
                  | "CUC"
                  | "CUP"
                  | "CVE"
                  | "CZK"
                  | "DJF"
                  | "DKK"
                  | "DOP"
                  | "DZD"
                  | "EGP"
                  | "ERN"
                  | "ETB"
                  | "EUR"
                  | "FJD"
                  | "FKP"
                  | "GBP"
                  | "GEL"
                  | "GHS"
                  | "GIP"
                  | "GMD"
                  | "GNF"
                  | "GTQ"
                  | "GYD"
                  | "HKD"
                  | "HNL"
                  | "HRK"
                  | "HTG"
                  | "HUF"
                  | "IDR"
                  | "ILS"
                  | "INR"
                  | "IQD"
                  | "IRR"
                  | "ISK"
                  | "JMD"
                  | "JOD"
                  | "JPY"
                  | "KES"
                  | "KGS"
                  | "KHR"
                  | "KMF"
                  | "KPW"
                  | "KRW"
                  | "KWD"
                  | "KYD"
                  | "KZT"
                  | "LAK"
                  | "LBP"
                  | "LKR"
                  | "LRD"
                  | "LSL"
                  | "LTL"
                  | "LVL"
                  | "LYD"
                  | "MAD"
                  | "MDL"
                  | "MGA"
                  | "MKD"
                  | "MMK"
                  | "MNT"
                  | "MOP"
                  | "MRO"
                  | "MUR"
                  | "MVR"
                  | "MWK"
                  | "MXN"
                  | "MXV"
                  | "MYR"
                  | "MZN"
                  | "NAD"
                  | "NGN"
                  | "NIO"
                  | "NOK"
                  | "NPR"
                  | "NZD"
                  | "OMR"
                  | "PAB"
                  | "PEN"
                  | "PGK"
                  | "PHP"
                  | "PKR"
                  | "PLN"
                  | "PYG"
                  | "QAR"
                  | "RON"
                  | "RSD"
                  | "RUB"
                  | "RWF"
                  | "SAR"
                  | "SBD"
                  | "SCR"
                  | "SDG"
                  | "SEK"
                  | "SGD"
                  | "SHP"
                  | "SLL"
                  | "SLE"
                  | "SOS"
                  | "SRD"
                  | "SSP"
                  | "STD"
                  | "SVC"
                  | "SYP"
                  | "SZL"
                  | "THB"
                  | "TJS"
                  | "TMT"
                  | "TND"
                  | "TOP"
                  | "TRY"
                  | "TTD"
                  | "TWD"
                  | "TZS"
                  | "UAH"
                  | "UGX"
                  | "USD"
                  | "USN"
                  | "USS"
                  | "UYI"
                  | "UYU"
                  | "UZS"
                  | "VEF"
                  | "VND"
                  | "VUV"
                  | "WST"
                  | "XAF"
                  | "XAG"
                  | "XAU"
                  | "XBA"
                  | "XBB"
                  | "XBC"
                  | "XBD"
                  | "XCD"
                  | "XDR"
                  | "XOF"
                  | "XPD"
                  | "XPF"
                  | "XPT"
                  | "XTS"
                  | "XXX"
                  | "YER"
                  | "ZAR"
                  | "ZMK"
                  | "ZMW"
                  | "BTC"
                  | "XUS";
              };
            };
          }[];
          subscription_plan_variations?: {}[];
          eligible_item_ids?: string[];
          eligible_category_ids?: string[];
          all_items?: false | true;
        };
        item_option_data?: {
          name?: string;
          display_name?: string;
          description?: string;
          show_colors?: false | true;
          values?: {}[];
        };
        item_option_value_data?: {
          item_option_id?: string;
          name?: string;
          description?: string;
          color?: string;
          ordinal?: number;
        };
        custom_attribute_definition_data?: {
          type: "STRING" | "BOOLEAN" | "NUMBER" | "SELECTION";
          name: string;
          description?: string;
          source_application?: {
            product?:
              | "SQUARE_POS"
              | "EXTERNAL_API"
              | "BILLING"
              | "APPOINTMENTS"
              | "INVOICES"
              | "ONLINE_STORE"
              | "PAYROLL"
              | "DASHBOARD"
              | "ITEM_LIBRARY_IMPORT"
              | "OTHER";
            application_id?: string;
            name?: string;
          };
          allowed_object_types:
            | "ITEM"
            | "IMAGE"
            | "CATEGORY"
            | "ITEM_VARIATION"
            | "TAX"
            | "DISCOUNT"
            | "MODIFIER_LIST"
            | "MODIFIER"
            | "PRICING_RULE"
            | "PRODUCT_SET"
            | "TIME_PERIOD"
            | "MEASUREMENT_UNIT"
            | "SUBSCRIPTION_PLAN_VARIATION"
            | "ITEM_OPTION"
            | "ITEM_OPTION_VAL"
            | "CUSTOM_ATTRIBUTE_DEFINITION"
            | "QUICK_AMOUNTS_SETTINGS"
            | "SUBSCRIPTION_PLAN"
            | "AVAILABILITY_PERIOD"[];
          seller_visibility?:
            | "SELLER_VISIBILITY_HIDDEN"
            | "SELLER_VISIBILITY_READ_WRITE_VALUES";
          app_visibility?:
            | "APP_VISIBILITY_HIDDEN"
            | "APP_VISIBILITY_READ_ONLY"
            | "APP_VISIBILITY_READ_WRITE_VALUES";
          string_config?: { enforce_uniqueness?: false | true };
          number_config?: { precision?: number };
          selection_config?: {
            max_allowed_selections?: number;
            allowed_selections?: { uid?: string; name: string }[];
          };
          custom_attribute_usage_count?: number;
          key?: string;
        };
        quick_amounts_settings_data?: {
          option: "DISABLED" | "MANUAL" | "AUTO";
          eligible_for_auto_amounts?: false | true;
          amounts?: {
            type: "QUICK_AMOUNT_TYPE_MANUAL" | "QUICK_AMOUNT_TYPE_AUTO";
            amount: {
              amount?: number;
              currency?:
                | "UNKNOWN_CURRENCY"
                | "AED"
                | "AFN"
                | "ALL"
                | "AMD"
                | "ANG"
                | "AOA"
                | "ARS"
                | "AUD"
                | "AWG"
                | "AZN"
                | "BAM"
                | "BBD"
                | "BDT"
                | "BGN"
                | "BHD"
                | "BIF"
                | "BMD"
                | "BND"
                | "BOB"
                | "BOV"
                | "BRL"
                | "BSD"
                | "BTN"
                | "BWP"
                | "BYR"
                | "BZD"
                | "CAD"
                | "CDF"
                | "CHE"
                | "CHF"
                | "CHW"
                | "CLF"
                | "CLP"
                | "CNY"
                | "COP"
                | "COU"
                | "CRC"
                | "CUC"
                | "CUP"
                | "CVE"
                | "CZK"
                | "DJF"
                | "DKK"
                | "DOP"
                | "DZD"
                | "EGP"
                | "ERN"
                | "ETB"
                | "EUR"
                | "FJD"
                | "FKP"
                | "GBP"
                | "GEL"
                | "GHS"
                | "GIP"
                | "GMD"
                | "GNF"
                | "GTQ"
                | "GYD"
                | "HKD"
                | "HNL"
                | "HRK"
                | "HTG"
                | "HUF"
                | "IDR"
                | "ILS"
                | "INR"
                | "IQD"
                | "IRR"
                | "ISK"
                | "JMD"
                | "JOD"
                | "JPY"
                | "KES"
                | "KGS"
                | "KHR"
                | "KMF"
                | "KPW"
                | "KRW"
                | "KWD"
                | "KYD"
                | "KZT"
                | "LAK"
                | "LBP"
                | "LKR"
                | "LRD"
                | "LSL"
                | "LTL"
                | "LVL"
                | "LYD"
                | "MAD"
                | "MDL"
                | "MGA"
                | "MKD"
                | "MMK"
                | "MNT"
                | "MOP"
                | "MRO"
                | "MUR"
                | "MVR"
                | "MWK"
                | "MXN"
                | "MXV"
                | "MYR"
                | "MZN"
                | "NAD"
                | "NGN"
                | "NIO"
                | "NOK"
                | "NPR"
                | "NZD"
                | "OMR"
                | "PAB"
                | "PEN"
                | "PGK"
                | "PHP"
                | "PKR"
                | "PLN"
                | "PYG"
                | "QAR"
                | "RON"
                | "RSD"
                | "RUB"
                | "RWF"
                | "SAR"
                | "SBD"
                | "SCR"
                | "SDG"
                | "SEK"
                | "SGD"
                | "SHP"
                | "SLL"
                | "SLE"
                | "SOS"
                | "SRD"
                | "SSP"
                | "STD"
                | "SVC"
                | "SYP"
                | "SZL"
                | "THB"
                | "TJS"
                | "TMT"
                | "TND"
                | "TOP"
                | "TRY"
                | "TTD"
                | "TWD"
                | "TZS"
                | "UAH"
                | "UGX"
                | "USD"
                | "USN"
                | "USS"
                | "UYI"
                | "UYU"
                | "UZS"
                | "VEF"
                | "VND"
                | "VUV"
                | "WST"
                | "XAF"
                | "XAG"
                | "XAU"
                | "XBA"
                | "XBB"
                | "XBC"
                | "XBD"
                | "XCD"
                | "XDR"
                | "XOF"
                | "XPD"
                | "XPF"
                | "XPT"
                | "XTS"
                | "XXX"
                | "YER"
                | "ZAR"
                | "ZMK"
                | "ZMW"
                | "BTC"
                | "XUS";
            };
            score?: number;
            ordinal?: number;
          }[];
        };
        subscription_plan_variation_data?: {
          name: string;
          phases: {
            uid?: string;
            cadence:
              | "DAILY"
              | "WEEKLY"
              | "EVERY_TWO_WEEKS"
              | "THIRTY_DAYS"
              | "SIXTY_DAYS"
              | "NINETY_DAYS"
              | "MONTHLY"
              | "EVERY_TWO_MONTHS"
              | "QUARTERLY"
              | "EVERY_FOUR_MONTHS"
              | "EVERY_SIX_MONTHS"
              | "ANNUAL"
              | "EVERY_TWO_YEARS";
            periods?: number;
            recurring_price_money?: {
              amount?: number;
              currency?:
                | "UNKNOWN_CURRENCY"
                | "AED"
                | "AFN"
                | "ALL"
                | "AMD"
                | "ANG"
                | "AOA"
                | "ARS"
                | "AUD"
                | "AWG"
                | "AZN"
                | "BAM"
                | "BBD"
                | "BDT"
                | "BGN"
                | "BHD"
                | "BIF"
                | "BMD"
                | "BND"
                | "BOB"
                | "BOV"
                | "BRL"
                | "BSD"
                | "BTN"
                | "BWP"
                | "BYR"
                | "BZD"
                | "CAD"
                | "CDF"
                | "CHE"
                | "CHF"
                | "CHW"
                | "CLF"
                | "CLP"
                | "CNY"
                | "COP"
                | "COU"
                | "CRC"
                | "CUC"
                | "CUP"
                | "CVE"
                | "CZK"
                | "DJF"
                | "DKK"
                | "DOP"
                | "DZD"
                | "EGP"
                | "ERN"
                | "ETB"
                | "EUR"
                | "FJD"
                | "FKP"
                | "GBP"
                | "GEL"
                | "GHS"
                | "GIP"
                | "GMD"
                | "GNF"
                | "GTQ"
                | "GYD"
                | "HKD"
                | "HNL"
                | "HRK"
                | "HTG"
                | "HUF"
                | "IDR"
                | "ILS"
                | "INR"
                | "IQD"
                | "IRR"
                | "ISK"
                | "JMD"
                | "JOD"
                | "JPY"
                | "KES"
                | "KGS"
                | "KHR"
                | "KMF"
                | "KPW"
                | "KRW"
                | "KWD"
                | "KYD"
                | "KZT"
                | "LAK"
                | "LBP"
                | "LKR"
                | "LRD"
                | "LSL"
                | "LTL"
                | "LVL"
                | "LYD"
                | "MAD"
                | "MDL"
                | "MGA"
                | "MKD"
                | "MMK"
                | "MNT"
                | "MOP"
                | "MRO"
                | "MUR"
                | "MVR"
                | "MWK"
                | "MXN"
                | "MXV"
                | "MYR"
                | "MZN"
                | "NAD"
                | "NGN"
                | "NIO"
                | "NOK"
                | "NPR"
                | "NZD"
                | "OMR"
                | "PAB"
                | "PEN"
                | "PGK"
                | "PHP"
                | "PKR"
                | "PLN"
                | "PYG"
                | "QAR"
                | "RON"
                | "RSD"
                | "RUB"
                | "RWF"
                | "SAR"
                | "SBD"
                | "SCR"
                | "SDG"
                | "SEK"
                | "SGD"
                | "SHP"
                | "SLL"
                | "SLE"
                | "SOS"
                | "SRD"
                | "SSP"
                | "STD"
                | "SVC"
                | "SYP"
                | "SZL"
                | "THB"
                | "TJS"
                | "TMT"
                | "TND"
                | "TOP"
                | "TRY"
                | "TTD"
                | "TWD"
                | "TZS"
                | "UAH"
                | "UGX"
                | "USD"
                | "USN"
                | "USS"
                | "UYI"
                | "UYU"
                | "UZS"
                | "VEF"
                | "VND"
                | "VUV"
                | "WST"
                | "XAF"
                | "XAG"
                | "XAU"
                | "XBA"
                | "XBB"
                | "XBC"
                | "XBD"
                | "XCD"
                | "XDR"
                | "XOF"
                | "XPD"
                | "XPF"
                | "XPT"
                | "XTS"
                | "XXX"
                | "YER"
                | "ZAR"
                | "ZMK"
                | "ZMW"
                | "BTC"
                | "XUS";
            };
            ordinal?: number;
            pricing?: {
              type?: "STATIC" | "RELATIVE";
              discount_ids?: string[];
              price_money?: {
                amount?: number;
                currency?:
                  | "UNKNOWN_CURRENCY"
                  | "AED"
                  | "AFN"
                  | "ALL"
                  | "AMD"
                  | "ANG"
                  | "AOA"
                  | "ARS"
                  | "AUD"
                  | "AWG"
                  | "AZN"
                  | "BAM"
                  | "BBD"
                  | "BDT"
                  | "BGN"
                  | "BHD"
                  | "BIF"
                  | "BMD"
                  | "BND"
                  | "BOB"
                  | "BOV"
                  | "BRL"
                  | "BSD"
                  | "BTN"
                  | "BWP"
                  | "BYR"
                  | "BZD"
                  | "CAD"
                  | "CDF"
                  | "CHE"
                  | "CHF"
                  | "CHW"
                  | "CLF"
                  | "CLP"
                  | "CNY"
                  | "COP"
                  | "COU"
                  | "CRC"
                  | "CUC"
                  | "CUP"
                  | "CVE"
                  | "CZK"
                  | "DJF"
                  | "DKK"
                  | "DOP"
                  | "DZD"
                  | "EGP"
                  | "ERN"
                  | "ETB"
                  | "EUR"
                  | "FJD"
                  | "FKP"
                  | "GBP"
                  | "GEL"
                  | "GHS"
                  | "GIP"
                  | "GMD"
                  | "GNF"
                  | "GTQ"
                  | "GYD"
                  | "HKD"
                  | "HNL"
                  | "HRK"
                  | "HTG"
                  | "HUF"
                  | "IDR"
                  | "ILS"
                  | "INR"
                  | "IQD"
                  | "IRR"
                  | "ISK"
                  | "JMD"
                  | "JOD"
                  | "JPY"
                  | "KES"
                  | "KGS"
                  | "KHR"
                  | "KMF"
                  | "KPW"
                  | "KRW"
                  | "KWD"
                  | "KYD"
                  | "KZT"
                  | "LAK"
                  | "LBP"
                  | "LKR"
                  | "LRD"
                  | "LSL"
                  | "LTL"
                  | "LVL"
                  | "LYD"
                  | "MAD"
                  | "MDL"
                  | "MGA"
                  | "MKD"
                  | "MMK"
                  | "MNT"
                  | "MOP"
                  | "MRO"
                  | "MUR"
                  | "MVR"
                  | "MWK"
                  | "MXN"
                  | "MXV"
                  | "MYR"
                  | "MZN"
                  | "NAD"
                  | "NGN"
                  | "NIO"
                  | "NOK"
                  | "NPR"
                  | "NZD"
                  | "OMR"
                  | "PAB"
                  | "PEN"
                  | "PGK"
                  | "PHP"
                  | "PKR"
                  | "PLN"
                  | "PYG"
                  | "QAR"
                  | "RON"
                  | "RSD"
                  | "RUB"
                  | "RWF"
                  | "SAR"
                  | "SBD"
                  | "SCR"
                  | "SDG"
                  | "SEK"
                  | "SGD"
                  | "SHP"
                  | "SLL"
                  | "SLE"
                  | "SOS"
                  | "SRD"
                  | "SSP"
                  | "STD"
                  | "SVC"
                  | "SYP"
                  | "SZL"
                  | "THB"
                  | "TJS"
                  | "TMT"
                  | "TND"
                  | "TOP"
                  | "TRY"
                  | "TTD"
                  | "TWD"
                  | "TZS"
                  | "UAH"
                  | "UGX"
                  | "USD"
                  | "USN"
                  | "USS"
                  | "UYI"
                  | "UYU"
                  | "UZS"
                  | "VEF"
                  | "VND"
                  | "VUV"
                  | "WST"
                  | "XAF"
                  | "XAG"
                  | "XAU"
                  | "XBA"
                  | "XBB"
                  | "XBC"
                  | "XBD"
                  | "XCD"
                  | "XDR"
                  | "XOF"
                  | "XPD"
                  | "XPF"
                  | "XPT"
                  | "XTS"
                  | "XXX"
                  | "YER"
                  | "ZAR"
                  | "ZMK"
                  | "ZMW"
                  | "BTC"
                  | "XUS";
              };
            };
          }[];
          subscription_plan_id?: string;
          monthly_billing_anchor_date?: number;
          can_prorate?: false | true;
          successor_plan_variation_id?: string;
        };
        availability_period_data?: {
          start_local_time?: string;
          end_local_time?: string;
          day_of_week?: "SUN" | "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT";
        };
      }[];
    }[];
  },
) {
  const url = new URL(`https://connect.squareup.com/v2/catalog/batch-upsert`);

  const response = await fetch(url, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      Authorization: "Bearer " + auth.token,
    },
    body: JSON.stringify(body),
  });
  if (!response.ok) {
    const text = await response.text();
    throw new Error(`${response.status} ${text}`);
  }
  return await response.json();
}

`1`	`//native`
`2`	`type Square = {`
`3`	`token: string;`
`4`	`};`
`5`	`/**`
`6`	`* BatchUpsertCatalogObjects`
`7`	`* Creates or updates up to 10,000 target objects based on the provided`
`8`	`list of objects.`
`9`	`*/`
`10`	`export async function main(`
`11`	`auth: Square,`
`12`	`body: {`
`13`	`idempotency_key: string;`
`14`	`batches: {`
`15`	`objects: {`
`16`	`type:`
`17`	`\| "ITEM"`
`18`	`\| "IMAGE"`
`19`	`\| "CATEGORY"`
`20`	`\| "ITEM_VARIATION"`
`21`	`\| "TAX"`
`22`	`\| "DISCOUNT"`
`23`	`\| "MODIFIER_LIST"`
`24`	`\| "MODIFIER"`
`25`	`\| "PRICING_RULE"`
`26`	`\| "PRODUCT_SET"`
`27`	`\| "TIME_PERIOD"`
`28`	`\| "MEASUREMENT_UNIT"`
`29`	`\| "SUBSCRIPTION_PLAN_VARIATION"`
`30`	`\| "ITEM_OPTION"`
`31`	`\| "ITEM_OPTION_VAL"`
`32`	`\| "CUSTOM_ATTRIBUTE_DEFINITION"`
`33`	`\| "QUICK_AMOUNTS_SETTINGS"`
`34`	`\| "SUBSCRIPTION_PLAN"`
`35`	`\| "AVAILABILITY_PERIOD";`
`36`	`id: string;`
`37`	`updated_at?: string;`
`38`	`version?: number;`
`39`	`is_deleted?: false \| true;`
`40`	`custom_attribute_values?: {};`