• Associate App retailer configuration
  • getGet Associate App configuration
  • putUpdate Associate App configuration
  • patchUpdate Associate App configuration
• Associate App store configuration
  • getGet Associate App configuration for the given store.
  • putUpdate Associate App configuration
  • patchUpdate Associate App configuration for the given store.
  • delDeletes Associate App configuration for the given store.

API docs by Redocly

Associate App Configuration API (v1)

Download OpenAPI specification:Download

Use this API to retrieve and update the current configuration for Associate App set up for your business.

Use this API to enable or disable features such as offline mode, payment and refund options, commerce components in the app, etc. You can also use the API to update general UI settings of the app.

Important: Enabling "new_customer_profile" toggle will disrupt any active custom app extensions that you have configured for customer profile screens in Associate App. This feature is supported from Associate App v1.37.0 and later.

For more information, see Associate App configuration guides.

Associate App retailer configuration

Configure Associate App globally across all stores in your business.

Get Associate App configuration

Returns the current configuration for Associate App in your business.

Important: For more information on the schema properties and how to use them to configure the app, see the guide.

Responses

/api/v1/associate-app/config

Response samples

• 200

Content type

application/json

Example

case 1case 2case 1

{

• "capabilities": {

  • "add_products_from_listing": true,
  • "cash_drawer_static_ip_enabled": true,
  • "cash_for_endless_aisle_orders_enabled": true,
  • "cash_management": true,
  • "line_item_attribution": true,
  • "mixed_cart": true,
  • "offline_mode": true,
  • "offline_mode_catalog_backup": true,
  • "offline_mode_prices_backup": true,
  • "printer_management": {

    • "air_print": true,
    • "star_print_resolution": 0,
    • "air_print_paper_width": 0,
    • "air_print_height_factor": 0,
    • "air_print_width_factor": 0

    },
  • "qualaroo_user_nps_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_quarterly_nps_survey": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string"

    },
  • "qualaroo_manual_app_restart_feedback": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_associate_sff_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "reason_codes_enabled": true,
  • "serialized_inventory": {

    • "serial_number_regex": "string"

    },
  • "send_email_receipt_from_order_history": true,
  • "survey_selling": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string",
    • "minimumTransactionsToSurvey": 0

    }

  },
• "commerce_components": {

  • "barcode_types": [

    • "CodeTypeAll"

    ],
  • "document_printer_types": {

    • "sales_receipt": "labelPrinter",
    • "refund_note": "labelPrinter",
    • "shipping_label": "labelPrinter",
    • "packing_slip": "labelPrinter",
    • "invoice": "labelPrinter",
    • "exchange_receipt": "labelPrinter",
    • "return_receipt": "labelPrinter",
    • "default": "labelPrinter"

    },
  • "gift_card_product_id": "string",
  • "gift_card_regexp": "string",
  • "template_render_lambda_url": "string",
  • "warranty_lambda_url": "string",
  • "mto_configurator": {

    • "base_url": "string",
    • "mto_identifier": "string",
    • "repair_identifier": "string",
    • "extended_attribute_name": "string"

    }

  },
• "return_process_configuration": {

  • "blind_return_enabled": true,
  • "quality_inspection_options": [

    • {

      • "code": 0,
      • "option": "string"

      }

    ],
  • "return_reasons": [

    • {

      • "code": 0,
      • "reason": "string",
      • "reasons": { }

      }

    ]

  },
• "ui_configurations": {

  • "display_product_identifier": "product_id",
  • "seconds_until_logout_on_inactivity": 0,
  • "display_address_line_name": true,
  • "show_preorders_filter": true,
  • "suggested_email_domains": [

    • "string"

    ],
  • "tax_exemption_enabled": true,
  • "use_new_om_ui": true,
  • "hide_selling": true,
  • "logo": "string"

  },
• "customizations": {

  • "address_completion": "string",
  • "hang_tag_printing_enabled": true,
  • "hang_tag_pricebooks": [

    • "string"

    ],
  • "gift_card_pin": true,
  • "gift_receipt_printing_enabled": true,
  • "membership_customers_enabled": true,
  • "stage_switch_enabled": true,
  • "cart_management": [

    • "orderDiscount"

    ],
  • "customization_framework": {

    • "customer_extended_attributes": true

    },
  • "email_opt_in": {

    • "privacy_policy_url": "string"

    },
  • "newstore_checkout_button_share_configuration": [

    • "SMS"

    ],
  • "disabled_contact_buttons": [

    • "CALL"

    ],
  • "editable_extended_attributes": {

    • "order": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default"

        }

      ],
    • "item": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default",
        • "sibling": "string"

        }

      ]

    },
  • "displayed_extended_attributes": {

    • "product_detail": [

      • {

        • "attribute_name": "string",
        • "label": { }

        }

      ]

    },
  • "customer_identifier": {

    • "scanner_code_type": 0,
    • "regex": "string",
    • "extended_attribute_field": "string"

    },
  • "customer_profile_scanner_identifiers": [

    • {

      • "scanner_code_type": 0,
      • "regex": "string"

      }

    ],
  • "customer_profile_auto_populate_fields": [

    • {

      • "regex": "string",
      • "field_path": "string"

      }

    ]

  },
• "release_toggles": {

  • "allow_multipackage_packing": true,
  • "bluetooth_scanner_enabled": true,
  • "cash_rounding_enabled": true,
  • "catalog_product_quantity_picker": true,
  • "cloud_translations": true,
  • "drawer_navigation": true,
  • "fiscal_printer_management_enabled": true,
  • "login_v2": true,
  • "new_hang_tag_template": true,
  • "new_customer_profile": true,
  • "new_printer_management": true,
  • "new_cash_management": true,
  • "new_cash_experience": true,
  • "new_cash_refund_experience": true,
  • "new_tax_exemption": true,
  • "use_data_scanner_view_controller": true,
  • "runner_enabled": true,
  • "priority_orders_enabled": true,
  • "push_notifications": true,
  • "use_traditional_cash_refund_ids": true,
  • "use_short_pick_reasons": true,
  • "disable_split_tender_cancellations": true,
  • "async_terminal_payments": true,
  • "ship_to_store_enabled": true

  },
• "external_integration": {

  • "post_login_callback_url": "string",
  • "post_login_callback_urls": [

    • {

      • "identity_provider": "external1",
      • "url": "https://example.com/callback1"

      },
    • {

      • "identity_provider": "loyalty",
      • "url": "https://example.com/callback2"

      },
    • {

      • "identity_provider": "url3",
      • "url": "https://example.com/callback3"

      }

    ],
  • "cart.more.loyaltyProgram": {

    • "url": "string",
    • "is_deeplink": true,
    • "identity_provider": "string"

    }

  },
• "last_published_release": "string"

}

Update Associate App configuration

Updates and replaces the current configuration values for Associate App in your business.

Important: Before you use this method to update or replace Associate App configuration, see the guide for instructions.

Note: If no previous configuration for the app existed, use this method to create a new configuration for the app.

If you have specified a store specific Associate App configuration in your business, the store configuration takes precedence over the global configuration for the app.

Authorizations:

newStoreAccessToken

Request Body schema: application/json

non-empty

One of

non-empty

	object
required	object
required	object
	object
	object
	object
	object
last_published_release	string^\d+\.\d+\.\d+$ Version of the last published Associate App release to identify users on an outdated app.

Responses

/api/v1/associate-app/config

Request samples

• Payload

Content type

application/json

Example

case 1case 2case 1

{

• "capabilities": {

  • "add_products_from_listing": true,
  • "cash_drawer_static_ip_enabled": true,
  • "cash_for_endless_aisle_orders_enabled": true,
  • "cash_management": true,
  • "line_item_attribution": true,
  • "mixed_cart": true,
  • "offline_mode": true,
  • "offline_mode_catalog_backup": true,
  • "offline_mode_prices_backup": true,
  • "printer_management": {

    • "air_print": true,
    • "star_print_resolution": 0,
    • "air_print_paper_width": 0,
    • "air_print_height_factor": 0,
    • "air_print_width_factor": 0

    },
  • "qualaroo_user_nps_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_quarterly_nps_survey": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string"

    },
  • "qualaroo_manual_app_restart_feedback": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_associate_sff_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "reason_codes_enabled": true,
  • "serialized_inventory": {

    • "serial_number_regex": "string"

    },
  • "send_email_receipt_from_order_history": true,
  • "survey_selling": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string",
    • "minimumTransactionsToSurvey": 0

    }

  },
• "commerce_components": {

  • "barcode_types": [

    • "CodeTypeAll"

    ],
  • "document_printer_types": {

    • "sales_receipt": "labelPrinter",
    • "refund_note": "labelPrinter",
    • "shipping_label": "labelPrinter",
    • "packing_slip": "labelPrinter",
    • "invoice": "labelPrinter",
    • "exchange_receipt": "labelPrinter",
    • "return_receipt": "labelPrinter",
    • "default": "labelPrinter"

    },
  • "gift_card_product_id": "string",
  • "gift_card_regexp": "string",
  • "template_render_lambda_url": "string",
  • "warranty_lambda_url": "string",
  • "mto_configurator": {

    • "base_url": "string",
    • "mto_identifier": "string",
    • "repair_identifier": "string",
    • "extended_attribute_name": "string"

    }

  },
• "return_process_configuration": {

  • "blind_return_enabled": true,
  • "quality_inspection_options": [

    • {

      • "code": 0,
      • "option": "string"

      }

    ],
  • "return_reasons": [

    • {

      • "code": 0,
      • "reason": "string",
      • "reasons": { }

      }

    ]

  },
• "ui_configurations": {

  • "display_product_identifier": "product_id",
  • "seconds_until_logout_on_inactivity": 0,
  • "display_address_line_name": true,
  • "show_preorders_filter": true,
  • "suggested_email_domains": [

    • "string"

    ],
  • "tax_exemption_enabled": true,
  • "use_new_om_ui": true,
  • "hide_selling": true,
  • "logo": "string"

  },
• "customizations": {

  • "address_completion": "string",
  • "hang_tag_printing_enabled": true,
  • "hang_tag_pricebooks": [

    • "string"

    ],
  • "gift_card_pin": true,
  • "gift_receipt_printing_enabled": true,
  • "membership_customers_enabled": true,
  • "stage_switch_enabled": true,
  • "cart_management": [

    • "orderDiscount"

    ],
  • "customization_framework": {

    • "customer_extended_attributes": true

    },
  • "email_opt_in": {

    • "privacy_policy_url": "string"

    },
  • "newstore_checkout_button_share_configuration": [

    • "SMS"

    ],
  • "disabled_contact_buttons": [

    • "CALL"

    ],
  • "editable_extended_attributes": {

    • "order": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default"

        }

      ],
    • "item": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default",
        • "sibling": "string"

        }

      ]

    },
  • "displayed_extended_attributes": {

    • "product_detail": [

      • {

        • "attribute_name": "string",
        • "label": { }

        }

      ]

    },
  • "customer_identifier": {

    • "scanner_code_type": 0,
    • "regex": "string",
    • "extended_attribute_field": "string"

    },
  • "customer_profile_scanner_identifiers": [

    • {

      • "scanner_code_type": 0,
      • "regex": "string"

      }

    ],
  • "customer_profile_auto_populate_fields": [

    • {

      • "regex": "string",
      • "field_path": "string"

      }

    ]

  },
• "release_toggles": {

  • "allow_multipackage_packing": true,
  • "bluetooth_scanner_enabled": true,
  • "cash_rounding_enabled": true,
  • "catalog_product_quantity_picker": true,
  • "cloud_translations": true,
  • "drawer_navigation": true,
  • "fiscal_printer_management_enabled": true,
  • "login_v2": true,
  • "new_hang_tag_template": true,
  • "new_customer_profile": true,
  • "new_printer_management": true,
  • "new_cash_management": true,
  • "new_cash_experience": true,
  • "new_cash_refund_experience": true,
  • "new_tax_exemption": true,
  • "use_data_scanner_view_controller": true,
  • "runner_enabled": true,
  • "priority_orders_enabled": true,
  • "push_notifications": true,
  • "use_traditional_cash_refund_ids": true,
  • "use_short_pick_reasons": true,
  • "disable_split_tender_cancellations": true,
  • "async_terminal_payments": true,
  • "ship_to_store_enabled": true

  },
• "external_integration": {

  • "post_login_callback_url": "string",
  • "post_login_callback_urls": [

    • {

      • "identity_provider": "external1",
      • "url": "https://example.com/callback1"

      },
    • {

      • "identity_provider": "loyalty",
      • "url": "https://example.com/callback2"

      },
    • {

      • "identity_provider": "url3",
      • "url": "https://example.com/callback3"

      }

    ],
  • "cart.more.loyaltyProgram": {

    • "url": "string",
    • "is_deeplink": true,
    • "identity_provider": "string"

    }

  },
• "last_published_release": "string"

}

Response samples

• 200

Content type

application/json

Example

case 1case 2case 1

{

• "capabilities": {

  • "add_products_from_listing": true,
  • "cash_drawer_static_ip_enabled": true,
  • "cash_for_endless_aisle_orders_enabled": true,
  • "cash_management": true,
  • "line_item_attribution": true,
  • "mixed_cart": true,
  • "offline_mode": true,
  • "offline_mode_catalog_backup": true,
  • "offline_mode_prices_backup": true,
  • "printer_management": {

    • "air_print": true,
    • "star_print_resolution": 0,
    • "air_print_paper_width": 0,
    • "air_print_height_factor": 0,
    • "air_print_width_factor": 0

    },
  • "qualaroo_user_nps_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_quarterly_nps_survey": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string"

    },
  • "qualaroo_manual_app_restart_feedback": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_associate_sff_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "reason_codes_enabled": true,
  • "serialized_inventory": {

    • "serial_number_regex": "string"

    },
  • "send_email_receipt_from_order_history": true,
  • "survey_selling": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string",
    • "minimumTransactionsToSurvey": 0

    }

  },
• "commerce_components": {

  • "barcode_types": [

    • "CodeTypeAll"

    ],
  • "document_printer_types": {

    • "sales_receipt": "labelPrinter",
    • "refund_note": "labelPrinter",
    • "shipping_label": "labelPrinter",
    • "packing_slip": "labelPrinter",
    • "invoice": "labelPrinter",
    • "exchange_receipt": "labelPrinter",
    • "return_receipt": "labelPrinter",
    • "default": "labelPrinter"

    },
  • "gift_card_product_id": "string",
  • "gift_card_regexp": "string",
  • "template_render_lambda_url": "string",
  • "warranty_lambda_url": "string",
  • "mto_configurator": {

    • "base_url": "string",
    • "mto_identifier": "string",
    • "repair_identifier": "string",
    • "extended_attribute_name": "string"

    }

  },
• "return_process_configuration": {

  • "blind_return_enabled": true,
  • "quality_inspection_options": [

    • {

      • "code": 0,
      • "option": "string"

      }

    ],
  • "return_reasons": [

    • {

      • "code": 0,
      • "reason": "string",
      • "reasons": { }

      }

    ]

  },
• "ui_configurations": {

  • "display_product_identifier": "product_id",
  • "seconds_until_logout_on_inactivity": 0,
  • "display_address_line_name": true,
  • "show_preorders_filter": true,
  • "suggested_email_domains": [

    • "string"

    ],
  • "tax_exemption_enabled": true,
  • "use_new_om_ui": true,
  • "hide_selling": true,
  • "logo": "string"

  },
• "customizations": {

  • "address_completion": "string",
  • "hang_tag_printing_enabled": true,
  • "hang_tag_pricebooks": [

    • "string"

    ],
  • "gift_card_pin": true,
  • "gift_receipt_printing_enabled": true,
  • "membership_customers_enabled": true,
  • "stage_switch_enabled": true,
  • "cart_management": [

    • "orderDiscount"

    ],
  • "customization_framework": {

    • "customer_extended_attributes": true

    },
  • "email_opt_in": {

    • "privacy_policy_url": "string"

    },
  • "newstore_checkout_button_share_configuration": [

    • "SMS"

    ],
  • "disabled_contact_buttons": [

    • "CALL"

    ],
  • "editable_extended_attributes": {

    • "order": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default"

        }

      ],
    • "item": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default",
        • "sibling": "string"

        }

      ]

    },
  • "displayed_extended_attributes": {

    • "product_detail": [

      • {

        • "attribute_name": "string",
        • "label": { }

        }

      ]

    },
  • "customer_identifier": {

    • "scanner_code_type": 0,
    • "regex": "string",
    • "extended_attribute_field": "string"

    },
  • "customer_profile_scanner_identifiers": [

    • {

      • "scanner_code_type": 0,
      • "regex": "string"

      }

    ],
  • "customer_profile_auto_populate_fields": [

    • {

      • "regex": "string",
      • "field_path": "string"

      }

    ]

  },
• "release_toggles": {

  • "allow_multipackage_packing": true,
  • "bluetooth_scanner_enabled": true,
  • "cash_rounding_enabled": true,
  • "catalog_product_quantity_picker": true,
  • "cloud_translations": true,
  • "drawer_navigation": true,
  • "fiscal_printer_management_enabled": true,
  • "login_v2": true,
  • "new_hang_tag_template": true,
  • "new_customer_profile": true,
  • "new_printer_management": true,
  • "new_cash_management": true,
  • "new_cash_experience": true,
  • "new_cash_refund_experience": true,
  • "new_tax_exemption": true,
  • "use_data_scanner_view_controller": true,
  • "runner_enabled": true,
  • "priority_orders_enabled": true,
  • "push_notifications": true,
  • "use_traditional_cash_refund_ids": true,
  • "use_short_pick_reasons": true,
  • "disable_split_tender_cancellations": true,
  • "async_terminal_payments": true,
  • "ship_to_store_enabled": true

  },
• "external_integration": {

  • "post_login_callback_url": "string",
  • "post_login_callback_urls": [

    • {

      • "identity_provider": "external1",
      • "url": "https://example.com/callback1"

      },
    • {

      • "identity_provider": "loyalty",
      • "url": "https://example.com/callback2"

      },
    • {

      • "identity_provider": "url3",
      • "url": "https://example.com/callback3"

      }

    ],
  • "cart.more.loyaltyProgram": {

    • "url": "string",
    • "is_deeplink": true,
    • "identity_provider": "string"

    }

  },
• "last_published_release": "string"

}

Update Associate App configuration

Updates the current configuration values for Associate App in your business.

Important: Before you use this method to update or replace Associate App configuration, see the guide for instructions.

Authorizations:

newStoreAccessToken

Request Body schema: application/json

non-empty

One of

non-empty

	object
required	object
required	object
	object
	object
	object
	object
last_published_release	string^\d+\.\d+\.\d+$ Version of the last published Associate App release to identify users on an outdated app.

Responses

/api/v1/associate-app/config

Request samples

• Payload

Content type

application/json

Example

case 1case 2case 1

{

• "capabilities": {

  • "add_products_from_listing": true,
  • "cash_drawer_static_ip_enabled": true,
  • "cash_for_endless_aisle_orders_enabled": true,
  • "cash_management": true,
  • "line_item_attribution": true,
  • "mixed_cart": true,
  • "offline_mode": true,
  • "offline_mode_catalog_backup": true,
  • "offline_mode_prices_backup": true,
  • "printer_management": {

    • "air_print": true,
    • "star_print_resolution": 0,
    • "air_print_paper_width": 0,
    • "air_print_height_factor": 0,
    • "air_print_width_factor": 0

    },
  • "qualaroo_user_nps_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_quarterly_nps_survey": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string"

    },
  • "qualaroo_manual_app_restart_feedback": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_associate_sff_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "reason_codes_enabled": true,
  • "serialized_inventory": {

    • "serial_number_regex": "string"

    },
  • "send_email_receipt_from_order_history": true,
  • "survey_selling": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string",
    • "minimumTransactionsToSurvey": 0

    }

  },
• "commerce_components": {

  • "barcode_types": [

    • "CodeTypeAll"

    ],
  • "document_printer_types": {

    • "sales_receipt": "labelPrinter",
    • "refund_note": "labelPrinter",
    • "shipping_label": "labelPrinter",
    • "packing_slip": "labelPrinter",
    • "invoice": "labelPrinter",
    • "exchange_receipt": "labelPrinter",
    • "return_receipt": "labelPrinter",
    • "default": "labelPrinter"

    },
  • "gift_card_product_id": "string",
  • "gift_card_regexp": "string",
  • "template_render_lambda_url": "string",
  • "warranty_lambda_url": "string",
  • "mto_configurator": {

    • "base_url": "string",
    • "mto_identifier": "string",
    • "repair_identifier": "string",
    • "extended_attribute_name": "string"

    }

  },
• "return_process_configuration": {

  • "blind_return_enabled": true,
  • "quality_inspection_options": [

    • {

      • "code": 0,
      • "option": "string"

      }

    ],
  • "return_reasons": [

    • {

      • "code": 0,
      • "reason": "string",
      • "reasons": { }

      }

    ]

  },
• "ui_configurations": {

  • "display_product_identifier": "product_id",
  • "seconds_until_logout_on_inactivity": 0,
  • "display_address_line_name": true,
  • "show_preorders_filter": true,
  • "suggested_email_domains": [

    • "string"

    ],
  • "tax_exemption_enabled": true,
  • "use_new_om_ui": true,
  • "hide_selling": true,
  • "logo": "string"

  },
• "customizations": {

  • "address_completion": "string",
  • "hang_tag_printing_enabled": true,
  • "hang_tag_pricebooks": [

    • "string"

    ],
  • "gift_card_pin": true,
  • "gift_receipt_printing_enabled": true,
  • "membership_customers_enabled": true,
  • "stage_switch_enabled": true,
  • "cart_management": [

    • "orderDiscount"

    ],
  • "customization_framework": {

    • "customer_extended_attributes": true

    },
  • "email_opt_in": {

    • "privacy_policy_url": "string"

    },
  • "newstore_checkout_button_share_configuration": [

    • "SMS"

    ],
  • "disabled_contact_buttons": [

    • "CALL"

    ],
  • "editable_extended_attributes": {

    • "order": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default"

        }

      ],
    • "item": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default",
        • "sibling": "string"

        }

      ]

    },
  • "displayed_extended_attributes": {

    • "product_detail": [

      • {

        • "attribute_name": "string",
        • "label": { }

        }

      ]

    },
  • "customer_identifier": {

    • "scanner_code_type": 0,
    • "regex": "string",
    • "extended_attribute_field": "string"

    },
  • "customer_profile_scanner_identifiers": [

    • {

      • "scanner_code_type": 0,
      • "regex": "string"

      }

    ],
  • "customer_profile_auto_populate_fields": [

    • {

      • "regex": "string",
      • "field_path": "string"

      }

    ]

  },
• "release_toggles": {

  • "allow_multipackage_packing": true,
  • "bluetooth_scanner_enabled": true,
  • "cash_rounding_enabled": true,
  • "catalog_product_quantity_picker": true,
  • "cloud_translations": true,
  • "drawer_navigation": true,
  • "fiscal_printer_management_enabled": true,
  • "login_v2": true,
  • "new_hang_tag_template": true,
  • "new_customer_profile": true,
  • "new_printer_management": true,
  • "new_cash_management": true,
  • "new_cash_experience": true,
  • "new_cash_refund_experience": true,
  • "new_tax_exemption": true,
  • "use_data_scanner_view_controller": true,
  • "runner_enabled": true,
  • "priority_orders_enabled": true,
  • "push_notifications": true,
  • "use_traditional_cash_refund_ids": true,
  • "use_short_pick_reasons": true,
  • "disable_split_tender_cancellations": true,
  • "async_terminal_payments": true,
  • "ship_to_store_enabled": true

  },
• "external_integration": {

  • "post_login_callback_url": "string",
  • "post_login_callback_urls": [

    • {

      • "identity_provider": "external1",
      • "url": "https://example.com/callback1"

      },
    • {

      • "identity_provider": "loyalty",
      • "url": "https://example.com/callback2"

      },
    • {

      • "identity_provider": "url3",
      • "url": "https://example.com/callback3"

      }

    ],
  • "cart.more.loyaltyProgram": {

    • "url": "string",
    • "is_deeplink": true,
    • "identity_provider": "string"

    }

  },
• "last_published_release": "string"

}

Response samples

• 200

Content type

application/json

Example

case 1case 2case 1

{

• "capabilities": {

  • "add_products_from_listing": true,
  • "cash_drawer_static_ip_enabled": true,
  • "cash_for_endless_aisle_orders_enabled": true,
  • "cash_management": true,
  • "line_item_attribution": true,
  • "mixed_cart": true,
  • "offline_mode": true,
  • "offline_mode_catalog_backup": true,
  • "offline_mode_prices_backup": true,
  • "printer_management": {

    • "air_print": true,
    • "star_print_resolution": 0,
    • "air_print_paper_width": 0,
    • "air_print_height_factor": 0,
    • "air_print_width_factor": 0

    },
  • "qualaroo_user_nps_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_quarterly_nps_survey": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string"

    },
  • "qualaroo_manual_app_restart_feedback": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_associate_sff_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "reason_codes_enabled": true,
  • "serialized_inventory": {

    • "serial_number_regex": "string"

    },
  • "send_email_receipt_from_order_history": true,
  • "survey_selling": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string",
    • "minimumTransactionsToSurvey": 0

    }

  },
• "commerce_components": {

  • "barcode_types": [

    • "CodeTypeAll"

    ],
  • "document_printer_types": {

    • "sales_receipt": "labelPrinter",
    • "refund_note": "labelPrinter",
    • "shipping_label": "labelPrinter",
    • "packing_slip": "labelPrinter",
    • "invoice": "labelPrinter",
    • "exchange_receipt": "labelPrinter",
    • "return_receipt": "labelPrinter",
    • "default": "labelPrinter"

    },
  • "gift_card_product_id": "string",
  • "gift_card_regexp": "string",
  • "template_render_lambda_url": "string",
  • "warranty_lambda_url": "string",
  • "mto_configurator": {

    • "base_url": "string",
    • "mto_identifier": "string",
    • "repair_identifier": "string",
    • "extended_attribute_name": "string"

    }

  },
• "return_process_configuration": {

  • "blind_return_enabled": true,
  • "quality_inspection_options": [

    • {

      • "code": 0,
      • "option": "string"

      }

    ],
  • "return_reasons": [

    • {

      • "code": 0,
      • "reason": "string",
      • "reasons": { }

      }

    ]

  },
• "ui_configurations": {

  • "display_product_identifier": "product_id",
  • "seconds_until_logout_on_inactivity": 0,
  • "display_address_line_name": true,
  • "show_preorders_filter": true,
  • "suggested_email_domains": [

    • "string"

    ],
  • "tax_exemption_enabled": true,
  • "use_new_om_ui": true,
  • "hide_selling": true,
  • "logo": "string"

  },
• "customizations": {

  • "address_completion": "string",
  • "hang_tag_printing_enabled": true,
  • "hang_tag_pricebooks": [

    • "string"

    ],
  • "gift_card_pin": true,
  • "gift_receipt_printing_enabled": true,
  • "membership_customers_enabled": true,
  • "stage_switch_enabled": true,
  • "cart_management": [

    • "orderDiscount"

    ],
  • "customization_framework": {

    • "customer_extended_attributes": true

    },
  • "email_opt_in": {

    • "privacy_policy_url": "string"

    },
  • "newstore_checkout_button_share_configuration": [

    • "SMS"

    ],
  • "disabled_contact_buttons": [

    • "CALL"

    ],
  • "editable_extended_attributes": {

    • "order": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default"

        }

      ],
    • "item": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default",
        • "sibling": "string"

        }

      ]

    },
  • "displayed_extended_attributes": {

    • "product_detail": [

      • {

        • "attribute_name": "string",
        • "label": { }

        }

      ]

    },
  • "customer_identifier": {

    • "scanner_code_type": 0,
    • "regex": "string",
    • "extended_attribute_field": "string"

    },
  • "customer_profile_scanner_identifiers": [

    • {

      • "scanner_code_type": 0,
      • "regex": "string"

      }

    ],
  • "customer_profile_auto_populate_fields": [

    • {

      • "regex": "string",
      • "field_path": "string"

      }

    ]

  },
• "release_toggles": {

  • "allow_multipackage_packing": true,
  • "bluetooth_scanner_enabled": true,
  • "cash_rounding_enabled": true,
  • "catalog_product_quantity_picker": true,
  • "cloud_translations": true,
  • "drawer_navigation": true,
  • "fiscal_printer_management_enabled": true,
  • "login_v2": true,
  • "new_hang_tag_template": true,
  • "new_customer_profile": true,
  • "new_printer_management": true,
  • "new_cash_management": true,
  • "new_cash_experience": true,
  • "new_cash_refund_experience": true,
  • "new_tax_exemption": true,
  • "use_data_scanner_view_controller": true,
  • "runner_enabled": true,
  • "priority_orders_enabled": true,
  • "push_notifications": true,
  • "use_traditional_cash_refund_ids": true,
  • "use_short_pick_reasons": true,
  • "disable_split_tender_cancellations": true,
  • "async_terminal_payments": true,
  • "ship_to_store_enabled": true

  },
• "external_integration": {

  • "post_login_callback_url": "string",
  • "post_login_callback_urls": [

    • {

      • "identity_provider": "external1",
      • "url": "https://example.com/callback1"

      },
    • {

      • "identity_provider": "loyalty",
      • "url": "https://example.com/callback2"

      },
    • {

      • "identity_provider": "url3",
      • "url": "https://example.com/callback3"

      }

    ],
  • "cart.more.loyaltyProgram": {

    • "url": "string",
    • "is_deeplink": true,
    • "identity_provider": "string"

    }

  },
• "last_published_release": "string"

}

Associate App store configuration

Configure Associate App for specific stores for your business.

Get Associate App configuration for the given store.

Returns the current store configuration for Associate App in your business.

Important: For more information on the schema properties and how to use them to configure the app, see the guide.

Responses

/api/v1/associate-app/config/{$storeId}

Response samples

• 200

Content type

application/json

Example

case 1case 2case 1

{

• "capabilities": {

  • "add_products_from_listing": true,
  • "cash_drawer_static_ip_enabled": true,
  • "cash_for_endless_aisle_orders_enabled": true,
  • "cash_management": true,
  • "line_item_attribution": true,
  • "mixed_cart": true,
  • "offline_mode": true,
  • "offline_mode_catalog_backup": true,
  • "offline_mode_prices_backup": true,
  • "printer_management": {

    • "air_print": true,
    • "star_print_resolution": 0,
    • "air_print_paper_width": 0,
    • "air_print_height_factor": 0,
    • "air_print_width_factor": 0

    },
  • "qualaroo_user_nps_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_quarterly_nps_survey": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string"

    },
  • "qualaroo_manual_app_restart_feedback": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_associate_sff_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "reason_codes_enabled": true,
  • "serialized_inventory": {

    • "serial_number_regex": "string"

    },
  • "send_email_receipt_from_order_history": true,
  • "survey_selling": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string",
    • "minimumTransactionsToSurvey": 0

    }

  },
• "commerce_components": {

  • "barcode_types": [

    • "CodeTypeAll"

    ],
  • "document_printer_types": {

    • "sales_receipt": "labelPrinter",
    • "refund_note": "labelPrinter",
    • "shipping_label": "labelPrinter",
    • "packing_slip": "labelPrinter",
    • "invoice": "labelPrinter",
    • "exchange_receipt": "labelPrinter",
    • "return_receipt": "labelPrinter",
    • "default": "labelPrinter"

    },
  • "gift_card_product_id": "string",
  • "gift_card_regexp": "string",
  • "template_render_lambda_url": "string",
  • "warranty_lambda_url": "string",
  • "mto_configurator": {

    • "base_url": "string",
    • "mto_identifier": "string",
    • "repair_identifier": "string",
    • "extended_attribute_name": "string"

    }

  },
• "return_process_configuration": {

  • "blind_return_enabled": true,
  • "quality_inspection_options": [

    • {

      • "code": 0,
      • "option": "string"

      }

    ],
  • "return_reasons": [

    • {

      • "code": 0,
      • "reason": "string",
      • "reasons": { }

      }

    ]

  },
• "ui_configurations": {

  • "display_product_identifier": "product_id",
  • "seconds_until_logout_on_inactivity": 0,
  • "display_address_line_name": true,
  • "show_preorders_filter": true,
  • "suggested_email_domains": [

    • "string"

    ],
  • "tax_exemption_enabled": true,
  • "use_new_om_ui": true,
  • "hide_selling": true,
  • "logo": "string"

  },
• "customizations": {

  • "address_completion": "string",
  • "hang_tag_printing_enabled": true,
  • "hang_tag_pricebooks": [

    • "string"

    ],
  • "gift_card_pin": true,
  • "gift_receipt_printing_enabled": true,
  • "membership_customers_enabled": true,
  • "stage_switch_enabled": true,
  • "cart_management": [

    • "orderDiscount"

    ],
  • "customization_framework": {

    • "customer_extended_attributes": true

    },
  • "email_opt_in": {

    • "privacy_policy_url": "string"

    },
  • "newstore_checkout_button_share_configuration": [

    • "SMS"

    ],
  • "disabled_contact_buttons": [

    • "CALL"

    ],
  • "editable_extended_attributes": {

    • "order": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default"

        }

      ],
    • "item": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default",
        • "sibling": "string"

        }

      ]

    },
  • "displayed_extended_attributes": {

    • "product_detail": [

      • {

        • "attribute_name": "string",
        • "label": { }

        }

      ]

    },
  • "customer_identifier": {

    • "scanner_code_type": 0,
    • "regex": "string",
    • "extended_attribute_field": "string"

    },
  • "customer_profile_scanner_identifiers": [

    • {

      • "scanner_code_type": 0,
      • "regex": "string"

      }

    ],
  • "customer_profile_auto_populate_fields": [

    • {

      • "regex": "string",
      • "field_path": "string"

      }

    ]

  },
• "release_toggles": {

  • "allow_multipackage_packing": true,
  • "bluetooth_scanner_enabled": true,
  • "cash_rounding_enabled": true,
  • "catalog_product_quantity_picker": true,
  • "cloud_translations": true,
  • "drawer_navigation": true,
  • "fiscal_printer_management_enabled": true,
  • "login_v2": true,
  • "new_hang_tag_template": true,
  • "new_customer_profile": true,
  • "new_printer_management": true,
  • "new_cash_management": true,
  • "new_cash_experience": true,
  • "new_cash_refund_experience": true,
  • "new_tax_exemption": true,
  • "use_data_scanner_view_controller": true,
  • "runner_enabled": true,
  • "priority_orders_enabled": true,
  • "push_notifications": true,
  • "use_traditional_cash_refund_ids": true,
  • "use_short_pick_reasons": true,
  • "disable_split_tender_cancellations": true,
  • "async_terminal_payments": true,
  • "ship_to_store_enabled": true

  },
• "external_integration": {

  • "post_login_callback_url": "string",
  • "post_login_callback_urls": [

    • {

      • "identity_provider": "external1",
      • "url": "https://example.com/callback1"

      },
    • {

      • "identity_provider": "loyalty",
      • "url": "https://example.com/callback2"

      },
    • {

      • "identity_provider": "url3",
      • "url": "https://example.com/callback3"

      }

    ],
  • "cart.more.loyaltyProgram": {

    • "url": "string",
    • "is_deeplink": true,
    • "identity_provider": "string"

    }

  },
• "last_published_release": "string"

}

Update Associate App configuration

Updates and replaces the current store configuration values for Associate App in your business.

Important: Before you use this method to update or replace Associate App configuration, see the guide for instructions.

Authorizations:

newStoreAccessToken

Request Body schema: application/json

non-empty

One of

non-empty

	object
required	object
required	object
	object
	object
	object
	object
last_published_release	string^\d+\.\d+\.\d+$ Version of the last published Associate App release to identify users on an outdated app.

Responses

/api/v1/associate-app/config/{$storeId}

Request samples

• Payload

Content type

application/json

Example

case 1case 2case 1

{

• "capabilities": {

  • "add_products_from_listing": true,
  • "cash_drawer_static_ip_enabled": true,
  • "cash_for_endless_aisle_orders_enabled": true,
  • "cash_management": true,
  • "line_item_attribution": true,
  • "mixed_cart": true,
  • "offline_mode": true,
  • "offline_mode_catalog_backup": true,
  • "offline_mode_prices_backup": true,
  • "printer_management": {

    • "air_print": true,
    • "star_print_resolution": 0,
    • "air_print_paper_width": 0,
    • "air_print_height_factor": 0,
    • "air_print_width_factor": 0

    },
  • "qualaroo_user_nps_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_quarterly_nps_survey": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string"

    },
  • "qualaroo_manual_app_restart_feedback": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_associate_sff_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "reason_codes_enabled": true,
  • "serialized_inventory": {

    • "serial_number_regex": "string"

    },
  • "send_email_receipt_from_order_history": true,
  • "survey_selling": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string",
    • "minimumTransactionsToSurvey": 0

    }

  },
• "commerce_components": {

  • "barcode_types": [

    • "CodeTypeAll"

    ],
  • "document_printer_types": {

    • "sales_receipt": "labelPrinter",
    • "refund_note": "labelPrinter",
    • "shipping_label": "labelPrinter",
    • "packing_slip": "labelPrinter",
    • "invoice": "labelPrinter",
    • "exchange_receipt": "labelPrinter",
    • "return_receipt": "labelPrinter",
    • "default": "labelPrinter"

    },
  • "gift_card_product_id": "string",
  • "gift_card_regexp": "string",
  • "template_render_lambda_url": "string",
  • "warranty_lambda_url": "string",
  • "mto_configurator": {

    • "base_url": "string",
    • "mto_identifier": "string",
    • "repair_identifier": "string",
    • "extended_attribute_name": "string"

    }

  },
• "return_process_configuration": {

  • "blind_return_enabled": true,
  • "quality_inspection_options": [

    • {

      • "code": 0,
      • "option": "string"

      }

    ],
  • "return_reasons": [

    • {

      • "code": 0,
      • "reason": "string",
      • "reasons": { }

      }

    ]

  },
• "ui_configurations": {

  • "display_product_identifier": "product_id",
  • "seconds_until_logout_on_inactivity": 0,
  • "display_address_line_name": true,
  • "show_preorders_filter": true,
  • "suggested_email_domains": [

    • "string"

    ],
  • "tax_exemption_enabled": true,
  • "use_new_om_ui": true,
  • "hide_selling": true,
  • "logo": "string"

  },
• "customizations": {

  • "address_completion": "string",
  • "hang_tag_printing_enabled": true,
  • "hang_tag_pricebooks": [

    • "string"

    ],
  • "gift_card_pin": true,
  • "gift_receipt_printing_enabled": true,
  • "membership_customers_enabled": true,
  • "stage_switch_enabled": true,
  • "cart_management": [

    • "orderDiscount"

    ],
  • "customization_framework": {

    • "customer_extended_attributes": true

    },
  • "email_opt_in": {

    • "privacy_policy_url": "string"

    },
  • "newstore_checkout_button_share_configuration": [

    • "SMS"

    ],
  • "disabled_contact_buttons": [

    • "CALL"

    ],
  • "editable_extended_attributes": {

    • "order": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default"

        }

      ],
    • "item": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default",
        • "sibling": "string"

        }

      ]

    },
  • "displayed_extended_attributes": {

    • "product_detail": [

      • {

        • "attribute_name": "string",
        • "label": { }

        }

      ]

    },
  • "customer_identifier": {

    • "scanner_code_type": 0,
    • "regex": "string",
    • "extended_attribute_field": "string"

    },
  • "customer_profile_scanner_identifiers": [

    • {

      • "scanner_code_type": 0,
      • "regex": "string"

      }

    ],
  • "customer_profile_auto_populate_fields": [

    • {

      • "regex": "string",
      • "field_path": "string"

      }

    ]

  },
• "release_toggles": {

  • "allow_multipackage_packing": true,
  • "bluetooth_scanner_enabled": true,
  • "cash_rounding_enabled": true,
  • "catalog_product_quantity_picker": true,
  • "cloud_translations": true,
  • "drawer_navigation": true,
  • "fiscal_printer_management_enabled": true,
  • "login_v2": true,
  • "new_hang_tag_template": true,
  • "new_customer_profile": true,
  • "new_printer_management": true,
  • "new_cash_management": true,
  • "new_cash_experience": true,
  • "new_cash_refund_experience": true,
  • "new_tax_exemption": true,
  • "use_data_scanner_view_controller": true,
  • "runner_enabled": true,
  • "priority_orders_enabled": true,
  • "push_notifications": true,
  • "use_traditional_cash_refund_ids": true,
  • "use_short_pick_reasons": true,
  • "disable_split_tender_cancellations": true,
  • "async_terminal_payments": true,
  • "ship_to_store_enabled": true

  },
• "external_integration": {

  • "post_login_callback_url": "string",
  • "post_login_callback_urls": [

    • {

      • "identity_provider": "external1",
      • "url": "https://example.com/callback1"

      },
    • {

      • "identity_provider": "loyalty",
      • "url": "https://example.com/callback2"

      },
    • {

      • "identity_provider": "url3",
      • "url": "https://example.com/callback3"

      }

    ],
  • "cart.more.loyaltyProgram": {

    • "url": "string",
    • "is_deeplink": true,
    • "identity_provider": "string"

    }

  },
• "last_published_release": "string"

}

Response samples

• 200

Content type

application/json

Example

case 1case 2case 1

{

• "capabilities": {

  • "add_products_from_listing": true,
  • "cash_drawer_static_ip_enabled": true,
  • "cash_for_endless_aisle_orders_enabled": true,
  • "cash_management": true,
  • "line_item_attribution": true,
  • "mixed_cart": true,
  • "offline_mode": true,
  • "offline_mode_catalog_backup": true,
  • "offline_mode_prices_backup": true,
  • "printer_management": {

    • "air_print": true,
    • "star_print_resolution": 0,
    • "air_print_paper_width": 0,
    • "air_print_height_factor": 0,
    • "air_print_width_factor": 0

    },
  • "qualaroo_user_nps_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_quarterly_nps_survey": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string"

    },
  • "qualaroo_manual_app_restart_feedback": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_associate_sff_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "reason_codes_enabled": true,
  • "serialized_inventory": {

    • "serial_number_regex": "string"

    },
  • "send_email_receipt_from_order_history": true,
  • "survey_selling": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string",
    • "minimumTransactionsToSurvey": 0

    }

  },
• "commerce_components": {

  • "barcode_types": [

    • "CodeTypeAll"

    ],
  • "document_printer_types": {

    • "sales_receipt": "labelPrinter",
    • "refund_note": "labelPrinter",
    • "shipping_label": "labelPrinter",
    • "packing_slip": "labelPrinter",
    • "invoice": "labelPrinter",
    • "exchange_receipt": "labelPrinter",
    • "return_receipt": "labelPrinter",
    • "default": "labelPrinter"

    },
  • "gift_card_product_id": "string",
  • "gift_card_regexp": "string",
  • "template_render_lambda_url": "string",
  • "warranty_lambda_url": "string",
  • "mto_configurator": {

    • "base_url": "string",
    • "mto_identifier": "string",
    • "repair_identifier": "string",
    • "extended_attribute_name": "string"

    }

  },
• "return_process_configuration": {

  • "blind_return_enabled": true,
  • "quality_inspection_options": [

    • {

      • "code": 0,
      • "option": "string"

      }

    ],
  • "return_reasons": [

    • {

      • "code": 0,
      • "reason": "string",
      • "reasons": { }

      }

    ]

  },
• "ui_configurations": {

  • "display_product_identifier": "product_id",
  • "seconds_until_logout_on_inactivity": 0,
  • "display_address_line_name": true,
  • "show_preorders_filter": true,
  • "suggested_email_domains": [

    • "string"

    ],
  • "tax_exemption_enabled": true,
  • "use_new_om_ui": true,
  • "hide_selling": true,
  • "logo": "string"

  },
• "customizations": {

  • "address_completion": "string",
  • "hang_tag_printing_enabled": true,
  • "hang_tag_pricebooks": [

    • "string"

    ],
  • "gift_card_pin": true,
  • "gift_receipt_printing_enabled": true,
  • "membership_customers_enabled": true,
  • "stage_switch_enabled": true,
  • "cart_management": [

    • "orderDiscount"

    ],
  • "customization_framework": {

    • "customer_extended_attributes": true

    },
  • "email_opt_in": {

    • "privacy_policy_url": "string"

    },
  • "newstore_checkout_button_share_configuration": [

    • "SMS"

    ],
  • "disabled_contact_buttons": [

    • "CALL"

    ],
  • "editable_extended_attributes": {

    • "order": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default"

        }

      ],
    • "item": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default",
        • "sibling": "string"

        }

      ]

    },
  • "displayed_extended_attributes": {

    • "product_detail": [

      • {

        • "attribute_name": "string",
        • "label": { }

        }

      ]

    },
  • "customer_identifier": {

    • "scanner_code_type": 0,
    • "regex": "string",
    • "extended_attribute_field": "string"

    },
  • "customer_profile_scanner_identifiers": [

    • {

      • "scanner_code_type": 0,
      • "regex": "string"

      }

    ],
  • "customer_profile_auto_populate_fields": [

    • {

      • "regex": "string",
      • "field_path": "string"

      }

    ]

  },
• "release_toggles": {

  • "allow_multipackage_packing": true,
  • "bluetooth_scanner_enabled": true,
  • "cash_rounding_enabled": true,
  • "catalog_product_quantity_picker": true,
  • "cloud_translations": true,
  • "drawer_navigation": true,
  • "fiscal_printer_management_enabled": true,
  • "login_v2": true,
  • "new_hang_tag_template": true,
  • "new_customer_profile": true,
  • "new_printer_management": true,
  • "new_cash_management": true,
  • "new_cash_experience": true,
  • "new_cash_refund_experience": true,
  • "new_tax_exemption": true,
  • "use_data_scanner_view_controller": true,
  • "runner_enabled": true,
  • "priority_orders_enabled": true,
  • "push_notifications": true,
  • "use_traditional_cash_refund_ids": true,
  • "use_short_pick_reasons": true,
  • "disable_split_tender_cancellations": true,
  • "async_terminal_payments": true,
  • "ship_to_store_enabled": true

  },
• "external_integration": {

  • "post_login_callback_url": "string",
  • "post_login_callback_urls": [

    • {

      • "identity_provider": "external1",
      • "url": "https://example.com/callback1"

      },
    • {

      • "identity_provider": "loyalty",
      • "url": "https://example.com/callback2"

      },
    • {

      • "identity_provider": "url3",
      • "url": "https://example.com/callback3"

      }

    ],
  • "cart.more.loyaltyProgram": {

    • "url": "string",
    • "is_deeplink": true,
    • "identity_provider": "string"

    }

  },
• "last_published_release": "string"

}

Update Associate App configuration for the given store.

Updates the current configuration values for Associate App in your business.

Important: Before you use this method to update or replace the Associate App configuration, see the guide for instructions.

Authorizations:

newStoreAccessToken

Request Body schema: application/json

non-empty

One of

non-empty

	object
required	object
required	object
	object
	object
	object
	object
last_published_release	string^\d+\.\d+\.\d+$ Version of the last published Associate App release to identify users on an outdated app.

Responses

/api/v1/associate-app/config/{$storeId}

Request samples

• Payload

Content type

application/json

Example

case 1case 2case 1

{

• "capabilities": {

  • "add_products_from_listing": true,
  • "cash_drawer_static_ip_enabled": true,
  • "cash_for_endless_aisle_orders_enabled": true,
  • "cash_management": true,
  • "line_item_attribution": true,
  • "mixed_cart": true,
  • "offline_mode": true,
  • "offline_mode_catalog_backup": true,
  • "offline_mode_prices_backup": true,
  • "printer_management": {

    • "air_print": true,
    • "star_print_resolution": 0,
    • "air_print_paper_width": 0,
    • "air_print_height_factor": 0,
    • "air_print_width_factor": 0

    },
  • "qualaroo_user_nps_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_quarterly_nps_survey": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string"

    },
  • "qualaroo_manual_app_restart_feedback": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_associate_sff_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "reason_codes_enabled": true,
  • "serialized_inventory": {

    • "serial_number_regex": "string"

    },
  • "send_email_receipt_from_order_history": true,
  • "survey_selling": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string",
    • "minimumTransactionsToSurvey": 0

    }

  },
• "commerce_components": {

  • "barcode_types": [

    • "CodeTypeAll"

    ],
  • "document_printer_types": {

    • "sales_receipt": "labelPrinter",
    • "refund_note": "labelPrinter",
    • "shipping_label": "labelPrinter",
    • "packing_slip": "labelPrinter",
    • "invoice": "labelPrinter",
    • "exchange_receipt": "labelPrinter",
    • "return_receipt": "labelPrinter",
    • "default": "labelPrinter"

    },
  • "gift_card_product_id": "string",
  • "gift_card_regexp": "string",
  • "template_render_lambda_url": "string",
  • "warranty_lambda_url": "string",
  • "mto_configurator": {

    • "base_url": "string",
    • "mto_identifier": "string",
    • "repair_identifier": "string",
    • "extended_attribute_name": "string"

    }

  },
• "return_process_configuration": {

  • "blind_return_enabled": true,
  • "quality_inspection_options": [

    • {

      • "code": 0,
      • "option": "string"

      }

    ],
  • "return_reasons": [

    • {

      • "code": 0,
      • "reason": "string",
      • "reasons": { }

      }

    ]

  },
• "ui_configurations": {

  • "display_product_identifier": "product_id",
  • "seconds_until_logout_on_inactivity": 0,
  • "display_address_line_name": true,
  • "show_preorders_filter": true,
  • "suggested_email_domains": [

    • "string"

    ],
  • "tax_exemption_enabled": true,
  • "use_new_om_ui": true,
  • "hide_selling": true,
  • "logo": "string"

  },
• "customizations": {

  • "address_completion": "string",
  • "hang_tag_printing_enabled": true,
  • "hang_tag_pricebooks": [

    • "string"

    ],
  • "gift_card_pin": true,
  • "gift_receipt_printing_enabled": true,
  • "membership_customers_enabled": true,
  • "stage_switch_enabled": true,
  • "cart_management": [

    • "orderDiscount"

    ],
  • "customization_framework": {

    • "customer_extended_attributes": true

    },
  • "email_opt_in": {

    • "privacy_policy_url": "string"

    },
  • "newstore_checkout_button_share_configuration": [

    • "SMS"

    ],
  • "disabled_contact_buttons": [

    • "CALL"

    ],
  • "editable_extended_attributes": {

    • "order": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default"

        }

      ],
    • "item": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default",
        • "sibling": "string"

        }

      ]

    },
  • "displayed_extended_attributes": {

    • "product_detail": [

      • {

        • "attribute_name": "string",
        • "label": { }

        }

      ]

    },
  • "customer_identifier": {

    • "scanner_code_type": 0,
    • "regex": "string",
    • "extended_attribute_field": "string"

    },
  • "customer_profile_scanner_identifiers": [

    • {

      • "scanner_code_type": 0,
      • "regex": "string"

      }

    ],
  • "customer_profile_auto_populate_fields": [

    • {

      • "regex": "string",
      • "field_path": "string"

      }

    ]

  },
• "release_toggles": {

  • "allow_multipackage_packing": true,
  • "bluetooth_scanner_enabled": true,
  • "cash_rounding_enabled": true,
  • "catalog_product_quantity_picker": true,
  • "cloud_translations": true,
  • "drawer_navigation": true,
  • "fiscal_printer_management_enabled": true,
  • "login_v2": true,
  • "new_hang_tag_template": true,
  • "new_customer_profile": true,
  • "new_printer_management": true,
  • "new_cash_management": true,
  • "new_cash_experience": true,
  • "new_cash_refund_experience": true,
  • "new_tax_exemption": true,
  • "use_data_scanner_view_controller": true,
  • "runner_enabled": true,
  • "priority_orders_enabled": true,
  • "push_notifications": true,
  • "use_traditional_cash_refund_ids": true,
  • "use_short_pick_reasons": true,
  • "disable_split_tender_cancellations": true,
  • "async_terminal_payments": true,
  • "ship_to_store_enabled": true

  },
• "external_integration": {

  • "post_login_callback_url": "string",
  • "post_login_callback_urls": [

    • {

      • "identity_provider": "external1",
      • "url": "https://example.com/callback1"

      },
    • {

      • "identity_provider": "loyalty",
      • "url": "https://example.com/callback2"

      },
    • {

      • "identity_provider": "url3",
      • "url": "https://example.com/callback3"

      }

    ],
  • "cart.more.loyaltyProgram": {

    • "url": "string",
    • "is_deeplink": true,
    • "identity_provider": "string"

    }

  },
• "last_published_release": "string"

}

Response samples

• 200

Content type

application/json

Example

case 1case 2case 1

{

• "capabilities": {

  • "add_products_from_listing": true,
  • "cash_drawer_static_ip_enabled": true,
  • "cash_for_endless_aisle_orders_enabled": true,
  • "cash_management": true,
  • "line_item_attribution": true,
  • "mixed_cart": true,
  • "offline_mode": true,
  • "offline_mode_catalog_backup": true,
  • "offline_mode_prices_backup": true,
  • "printer_management": {

    • "air_print": true,
    • "star_print_resolution": 0,
    • "air_print_paper_width": 0,
    • "air_print_height_factor": 0,
    • "air_print_width_factor": 0

    },
  • "qualaroo_user_nps_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_quarterly_nps_survey": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string"

    },
  • "qualaroo_manual_app_restart_feedback": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_associate_sff_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "reason_codes_enabled": true,
  • "serialized_inventory": {

    • "serial_number_regex": "string"

    },
  • "send_email_receipt_from_order_history": true,
  • "survey_selling": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string",
    • "minimumTransactionsToSurvey": 0

    }

  },
• "commerce_components": {

  • "barcode_types": [

    • "CodeTypeAll"

    ],
  • "document_printer_types": {

    • "sales_receipt": "labelPrinter",
    • "refund_note": "labelPrinter",
    • "shipping_label": "labelPrinter",
    • "packing_slip": "labelPrinter",
    • "invoice": "labelPrinter",
    • "exchange_receipt": "labelPrinter",
    • "return_receipt": "labelPrinter",
    • "default": "labelPrinter"

    },
  • "gift_card_product_id": "string",
  • "gift_card_regexp": "string",
  • "template_render_lambda_url": "string",
  • "warranty_lambda_url": "string",
  • "mto_configurator": {

    • "base_url": "string",
    • "mto_identifier": "string",
    • "repair_identifier": "string",
    • "extended_attribute_name": "string"

    }

  },
• "return_process_configuration": {

  • "blind_return_enabled": true,
  • "quality_inspection_options": [

    • {

      • "code": 0,
      • "option": "string"

      }

    ],
  • "return_reasons": [

    • {

      • "code": 0,
      • "reason": "string",
      • "reasons": { }

      }

    ]

  },
• "ui_configurations": {

  • "display_product_identifier": "product_id",
  • "seconds_until_logout_on_inactivity": 0,
  • "display_address_line_name": true,
  • "show_preorders_filter": true,
  • "suggested_email_domains": [

    • "string"

    ],
  • "tax_exemption_enabled": true,
  • "use_new_om_ui": true,
  • "hide_selling": true,
  • "logo": "string"

  },
• "customizations": {

  • "address_completion": "string",
  • "hang_tag_printing_enabled": true,
  • "hang_tag_pricebooks": [

    • "string"

    ],
  • "gift_card_pin": true,
  • "gift_receipt_printing_enabled": true,
  • "membership_customers_enabled": true,
  • "stage_switch_enabled": true,
  • "cart_management": [

    • "orderDiscount"

    ],
  • "customization_framework": {

    • "customer_extended_attributes": true

    },
  • "email_opt_in": {

    • "privacy_policy_url": "string"

    },
  • "newstore_checkout_button_share_configuration": [

    • "SMS"

    ],
  • "disabled_contact_buttons": [

    • "CALL"

    ],
  • "editable_extended_attributes": {

    • "order": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default"

        }

      ],
    • "item": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default",
        • "sibling": "string"

        }

      ]

    },
  • "displayed_extended_attributes": {

    • "product_detail": [

      • {

        • "attribute_name": "string",
        • "label": { }

        }

      ]

    },
  • "customer_identifier": {

    • "scanner_code_type": 0,
    • "regex": "string",
    • "extended_attribute_field": "string"

    },
  • "customer_profile_scanner_identifiers": [

    • {

      • "scanner_code_type": 0,
      • "regex": "string"

      }

    ],
  • "customer_profile_auto_populate_fields": [

    • {

      • "regex": "string",
      • "field_path": "string"

      }

    ]

  },
• "release_toggles": {

  • "allow_multipackage_packing": true,
  • "bluetooth_scanner_enabled": true,
  • "cash_rounding_enabled": true,
  • "catalog_product_quantity_picker": true,
  • "cloud_translations": true,
  • "drawer_navigation": true,
  • "fiscal_printer_management_enabled": true,
  • "login_v2": true,
  • "new_hang_tag_template": true,
  • "new_customer_profile": true,
  • "new_printer_management": true,
  • "new_cash_management": true,
  • "new_cash_experience": true,
  • "new_cash_refund_experience": true,
  • "new_tax_exemption": true,
  • "use_data_scanner_view_controller": true,
  • "runner_enabled": true,
  • "priority_orders_enabled": true,
  • "push_notifications": true,
  • "use_traditional_cash_refund_ids": true,
  • "use_short_pick_reasons": true,
  • "disable_split_tender_cancellations": true,
  • "async_terminal_payments": true,
  • "ship_to_store_enabled": true

  },
• "external_integration": {

  • "post_login_callback_url": "string",
  • "post_login_callback_urls": [

    • {

      • "identity_provider": "external1",
      • "url": "https://example.com/callback1"

      },
    • {

      • "identity_provider": "loyalty",
      • "url": "https://example.com/callback2"

      },
    • {

      • "identity_provider": "url3",
      • "url": "https://example.com/callback3"

      }

    ],
  • "cart.more.loyaltyProgram": {

    • "url": "string",
    • "is_deeplink": true,
    • "identity_provider": "string"

    }

  },
• "last_published_release": "string"

}

Deletes Associate App configuration for the given store.

Deletes the configuration for Associate App that has been currently specified for the store.

If you have specified a global Associate App configuration for your business, the global configuration is set for the store once you delete the store-specific app configuration.

Authorizations:

newStoreAccessToken

Request Body schema: application/json

non-empty

One of

non-empty

	object
required	object
required	object
	object
	object
	object
	object
last_published_release	string^\d+\.\d+\.\d+$ Version of the last published Associate App release to identify users on an outdated app.

Responses

/api/v1/associate-app/config/{$storeId}

Request samples

• Payload

Content type

application/json

Example

case 1case 2case 1

{

• "capabilities": {

  • "add_products_from_listing": true,
  • "cash_drawer_static_ip_enabled": true,
  • "cash_for_endless_aisle_orders_enabled": true,
  • "cash_management": true,
  • "line_item_attribution": true,
  • "mixed_cart": true,
  • "offline_mode": true,
  • "offline_mode_catalog_backup": true,
  • "offline_mode_prices_backup": true,
  • "printer_management": {

    • "air_print": true,
    • "star_print_resolution": 0,
    • "air_print_paper_width": 0,
    • "air_print_height_factor": 0,
    • "air_print_width_factor": 0

    },
  • "qualaroo_user_nps_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_quarterly_nps_survey": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string"

    },
  • "qualaroo_manual_app_restart_feedback": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_associate_sff_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "reason_codes_enabled": true,
  • "serialized_inventory": {

    • "serial_number_regex": "string"

    },
  • "send_email_receipt_from_order_history": true,
  • "survey_selling": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string",
    • "minimumTransactionsToSurvey": 0

    }

  },
• "commerce_components": {

  • "barcode_types": [

    • "CodeTypeAll"

    ],
  • "document_printer_types": {

    • "sales_receipt": "labelPrinter",
    • "refund_note": "labelPrinter",
    • "shipping_label": "labelPrinter",
    • "packing_slip": "labelPrinter",
    • "invoice": "labelPrinter",
    • "exchange_receipt": "labelPrinter",
    • "return_receipt": "labelPrinter",
    • "default": "labelPrinter"

    },
  • "gift_card_product_id": "string",
  • "gift_card_regexp": "string",
  • "template_render_lambda_url": "string",
  • "warranty_lambda_url": "string",
  • "mto_configurator": {

    • "base_url": "string",
    • "mto_identifier": "string",
    • "repair_identifier": "string",
    • "extended_attribute_name": "string"

    }

  },
• "return_process_configuration": {

  • "blind_return_enabled": true,
  • "quality_inspection_options": [

    • {

      • "code": 0,
      • "option": "string"

      }

    ],
  • "return_reasons": [

    • {

      • "code": 0,
      • "reason": "string",
      • "reasons": { }

      }

    ]

  },
• "ui_configurations": {

  • "display_product_identifier": "product_id",
  • "seconds_until_logout_on_inactivity": 0,
  • "display_address_line_name": true,
  • "show_preorders_filter": true,
  • "suggested_email_domains": [

    • "string"

    ],
  • "tax_exemption_enabled": true,
  • "use_new_om_ui": true,
  • "hide_selling": true,
  • "logo": "string"

  },
• "customizations": {

  • "address_completion": "string",
  • "hang_tag_printing_enabled": true,
  • "hang_tag_pricebooks": [

    • "string"

    ],
  • "gift_card_pin": true,
  • "gift_receipt_printing_enabled": true,
  • "membership_customers_enabled": true,
  • "stage_switch_enabled": true,
  • "cart_management": [

    • "orderDiscount"

    ],
  • "customization_framework": {

    • "customer_extended_attributes": true

    },
  • "email_opt_in": {

    • "privacy_policy_url": "string"

    },
  • "newstore_checkout_button_share_configuration": [

    • "SMS"

    ],
  • "disabled_contact_buttons": [

    • "CALL"

    ],
  • "editable_extended_attributes": {

    • "order": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default"

        }

      ],
    • "item": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default",
        • "sibling": "string"

        }

      ]

    },
  • "displayed_extended_attributes": {

    • "product_detail": [

      • {

        • "attribute_name": "string",
        • "label": { }

        }

      ]

    },
  • "customer_identifier": {

    • "scanner_code_type": 0,
    • "regex": "string",
    • "extended_attribute_field": "string"

    },
  • "customer_profile_scanner_identifiers": [

    • {

      • "scanner_code_type": 0,
      • "regex": "string"

      }

    ],
  • "customer_profile_auto_populate_fields": [

    • {

      • "regex": "string",
      • "field_path": "string"

      }

    ]

  },
• "release_toggles": {

  • "allow_multipackage_packing": true,
  • "bluetooth_scanner_enabled": true,
  • "cash_rounding_enabled": true,
  • "catalog_product_quantity_picker": true,
  • "cloud_translations": true,
  • "drawer_navigation": true,
  • "fiscal_printer_management_enabled": true,
  • "login_v2": true,
  • "new_hang_tag_template": true,
  • "new_customer_profile": true,
  • "new_printer_management": true,
  • "new_cash_management": true,
  • "new_cash_experience": true,
  • "new_cash_refund_experience": true,
  • "new_tax_exemption": true,
  • "use_data_scanner_view_controller": true,
  • "runner_enabled": true,
  • "priority_orders_enabled": true,
  • "push_notifications": true,
  • "use_traditional_cash_refund_ids": true,
  • "use_short_pick_reasons": true,
  • "disable_split_tender_cancellations": true,
  • "async_terminal_payments": true,
  • "ship_to_store_enabled": true

  },
• "external_integration": {

  • "post_login_callback_url": "string",
  • "post_login_callback_urls": [

    • {

      • "identity_provider": "external1",
      • "url": "https://example.com/callback1"

      },
    • {

      • "identity_provider": "loyalty",
      • "url": "https://example.com/callback2"

      },
    • {

      • "identity_provider": "url3",
      • "url": "https://example.com/callback3"

      }

    ],
  • "cart.more.loyaltyProgram": {

    • "url": "string",
    • "is_deeplink": true,
    • "identity_provider": "string"

    }

  },
• "last_published_release": "string"

}

Response samples

• 200

Content type

application/json

Example

case 1case 2case 1

{

• "capabilities": {

  • "add_products_from_listing": true,
  • "cash_drawer_static_ip_enabled": true,
  • "cash_for_endless_aisle_orders_enabled": true,
  • "cash_management": true,
  • "line_item_attribution": true,
  • "mixed_cart": true,
  • "offline_mode": true,
  • "offline_mode_catalog_backup": true,
  • "offline_mode_prices_backup": true,
  • "printer_management": {

    • "air_print": true,
    • "star_print_resolution": 0,
    • "air_print_paper_width": 0,
    • "air_print_height_factor": 0,
    • "air_print_width_factor": 0

    },
  • "qualaroo_user_nps_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_quarterly_nps_survey": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string"

    },
  • "qualaroo_manual_app_restart_feedback": {

    • "alias": "string",
    • "enabled": true

    },
  • "qualaroo_associate_sff_survey": {

    • "alias": "string",
    • "enabled": true

    },
  • "reason_codes_enabled": true,
  • "serialized_inventory": {

    • "serial_number_regex": "string"

    },
  • "send_email_receipt_from_order_history": true,
  • "survey_selling": {

    • "alias": "string",
    • "enabled": true,
    • "label": "string",
    • "minimumTransactionsToSurvey": 0

    }

  },
• "commerce_components": {

  • "barcode_types": [

    • "CodeTypeAll"

    ],
  • "document_printer_types": {

    • "sales_receipt": "labelPrinter",
    • "refund_note": "labelPrinter",
    • "shipping_label": "labelPrinter",
    • "packing_slip": "labelPrinter",
    • "invoice": "labelPrinter",
    • "exchange_receipt": "labelPrinter",
    • "return_receipt": "labelPrinter",
    • "default": "labelPrinter"

    },
  • "gift_card_product_id": "string",
  • "gift_card_regexp": "string",
  • "template_render_lambda_url": "string",
  • "warranty_lambda_url": "string",
  • "mto_configurator": {

    • "base_url": "string",
    • "mto_identifier": "string",
    • "repair_identifier": "string",
    • "extended_attribute_name": "string"

    }

  },
• "return_process_configuration": {

  • "blind_return_enabled": true,
  • "quality_inspection_options": [

    • {

      • "code": 0,
      • "option": "string"

      }

    ],
  • "return_reasons": [

    • {

      • "code": 0,
      • "reason": "string",
      • "reasons": { }

      }

    ]

  },
• "ui_configurations": {

  • "display_product_identifier": "product_id",
  • "seconds_until_logout_on_inactivity": 0,
  • "display_address_line_name": true,
  • "show_preorders_filter": true,
  • "suggested_email_domains": [

    • "string"

    ],
  • "tax_exemption_enabled": true,
  • "use_new_om_ui": true,
  • "hide_selling": true,
  • "logo": "string"

  },
• "customizations": {

  • "address_completion": "string",
  • "hang_tag_printing_enabled": true,
  • "hang_tag_pricebooks": [

    • "string"

    ],
  • "gift_card_pin": true,
  • "gift_receipt_printing_enabled": true,
  • "membership_customers_enabled": true,
  • "stage_switch_enabled": true,
  • "cart_management": [

    • "orderDiscount"

    ],
  • "customization_framework": {

    • "customer_extended_attributes": true

    },
  • "email_opt_in": {

    • "privacy_policy_url": "string"

    },
  • "newstore_checkout_button_share_configuration": [

    • "SMS"

    ],
  • "disabled_contact_buttons": [

    • "CALL"

    ],
  • "editable_extended_attributes": {

    • "order": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default"

        }

      ],
    • "item": [

      • {

        • "attribute_name": "string",
        • "validationRegex": "string",
        • "label": { },
        • "prompt": { },
        • "error_mesage": { },
        • "keyboard_type": "default",
        • "sibling": "string"

        }

      ]

    },
  • "displayed_extended_attributes": {

    • "product_detail": [

      • {

        • "attribute_name": "string",
        • "label": { }

        }

      ]

    },
  • "customer_identifier": {

    • "scanner_code_type": 0,
    • "regex": "string",
    • "extended_attribute_field": "string"

    },
  • "customer_profile_scanner_identifiers": [

    • {

      • "scanner_code_type": 0,
      • "regex": "string"

      }

    ],
  • "customer_profile_auto_populate_fields": [

    • {

      • "regex": "string",
      • "field_path": "string"

      }

    ]

  },
• "release_toggles": {

  • "allow_multipackage_packing": true,
  • "bluetooth_scanner_enabled": true,
  • "cash_rounding_enabled": true,
  • "catalog_product_quantity_picker": true,
  • "cloud_translations": true,
  • "drawer_navigation": true,
  • "fiscal_printer_management_enabled": true,
  • "login_v2": true,
  • "new_hang_tag_template": true,
  • "new_customer_profile": true,
  • "new_printer_management": true,
  • "new_cash_management": true,
  • "new_cash_experience": true,
  • "new_cash_refund_experience": true,
  • "new_tax_exemption": true,
  • "use_data_scanner_view_controller": true,
  • "runner_enabled": true,
  • "priority_orders_enabled": true,
  • "push_notifications": true,
  • "use_traditional_cash_refund_ids": true,
  • "use_short_pick_reasons": true,
  • "disable_split_tender_cancellations": true,
  • "async_terminal_payments": true,
  • "ship_to_store_enabled": true

  },
• "external_integration": {

  • "post_login_callback_url": "string",
  • "post_login_callback_urls": [

    • {

      • "identity_provider": "external1",
      • "url": "https://example.com/callback1"

      },
    • {

      • "identity_provider": "loyalty",
      • "url": "https://example.com/callback2"

      },
    • {

      • "identity_provider": "url3",
      • "url": "https://example.com/callback3"

      }

    ],
  • "cart.more.loyaltyProgram": {

    • "url": "string",
    • "is_deeplink": true,
    • "identity_provider": "string"

    }

  },
• "last_published_release": "string"

}