Associate App Configuration API (v1)
Download OpenAPI specification:Download
Use this API to retrieve and adjust the Associate App configuration.
Response samples
- 200
Content type
application/json
{- "capabilities": {
- "mixed_cart": true,
- "cash_management": true,
- "offline_mode": true,
- "cash_for_endless_aisle_orders_enabled": true
}, - "commerce_components": {
- "template_render_lambda_url": "string",
- "gift_card_product_id": "string",
- "gift_card_regexp": "string",
- "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"
}
}, - "return_process_configuration": {
- "return_reasons": [
- {
- "code": 0,
- "reason": "string",
- "reasons": { }
}
], - "quality_inspection_options": [
- {
- "code": 0,
- "option": "string"
}
], - "blind_return_enabled": true
}, - "ui_configurations": {
- "display_product_identifier": "product_id",
- "show_preorders_filter": true,
- "suggested_email_domains": [
- "string"
], - "tax_exemption_enabled": true,
- "seconds_until_logout_on_inactivity": 0
}
}Modify Associate App configuration
- Changes the Associate App configuration. Replaces complete configuration. If configuration does not exist for a tenant, it will be created.
Responses
Response samples
- 200
Content type
application/json
{- "capabilities": {
- "mixed_cart": true,
- "cash_management": true,
- "offline_mode": true,
- "cash_for_endless_aisle_orders_enabled": true
}, - "commerce_components": {
- "template_render_lambda_url": "string",
- "gift_card_product_id": "string",
- "gift_card_regexp": "string",
- "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"
}
}, - "return_process_configuration": {
- "return_reasons": [
- {
- "code": 0,
- "reason": "string",
- "reasons": { }
}
], - "quality_inspection_options": [
- {
- "code": 0,
- "option": "string"
}
], - "blind_return_enabled": true
}, - "ui_configurations": {
- "display_product_identifier": "product_id",
- "show_preorders_filter": true,
- "suggested_email_domains": [
- "string"
], - "tax_exemption_enabled": true,
- "seconds_until_logout_on_inactivity": 0
}
}