--- updatedAt: 2026-06-10T23:36:08.000Z agentTools: projectIndex: https://docs.talkdesk.com/llms.txt --- # Update order attributes Partially update attributes of a customer's order. Currently only the `tags` field is supported. Tags are prepended in front of the existing tags. Duplicates are removed case-insensitively, keeping the first occurrence (new tags win). More fields will be added in future iterations. Required fields: - customer_id - order_id - tags (non-empty list) A successful request returns the order with the updated attributes. This operation is only supported for Shopify integrations. ## Scope `erc-ecommerce-orders:write` # OpenAPI definition ```json { "openapi": "3.0.2", "info": { "title": "Public API", "version": "5.12.71", "description": "Documents public API endpoints. Scopes are given to external software, that we don't control", "contact": { "name": "Talkdesk", "url": "https://talkdesk.com" } }, "servers": [ { "url": "https://api.talkdeskapp.com", "description": "United States (td-us-1)" }, { "url": "https://api.talkdeskapp.eu", "description": "Europe (td-eu-1)" }, { "url": "https://api.talkdeskappca.com", "description": "Canada (td-ca-1)" }, { "url": "https://api.talkdeskapp.co.uk", "description": "United Kingdom (td-uk-1)" } ], "tags": [ { "name": "Retail Experience Cloud Bridge", "description": "Retail Experience Cloud Bridge API endpoints" } ], "paths": { "/erc/ecommerce/customers/{customer_id}/orders/{order_id}": { "patch": { "operationId": "erc-ecommerce-customers-customer-id-orders-order-id-patch", "tags": [ "Retail Experience Cloud Bridge" ], "summary": "Update order attributes", "description": "Partially update attributes of a customer's order.\n\nCurrently only the `tags` field is supported. Tags are prepended in front\nof the existing tags. Duplicates are removed case-insensitively, keeping\nthe first occurrence (new tags win). More fields will be added in future\niterations.\n\nRequired fields:\n- customer_id\n- order_id\n- tags (non-empty list)\n\nA successful request returns the order with the updated attributes.\n\nThis operation is only supported for Shopify integrations.\n", "security": [ { "GA": [ "erc-ecommerce-orders:write" ] } ], "parameters": [ { "name": "customer_id", "in": "path", "required": true, "description": "The customer ID", "schema": { "type": "string", "minLength": 1, "maxLength": 255, "example": "customer123" } }, { "name": "order_id", "in": "path", "required": true, "description": "The order ID", "schema": { "type": "string", "minLength": 1, "maxLength": 255, "example": "order123" } }, { "name": "brand", "in": "query", "description": "The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.\n", "required": false, "schema": { "type": "string", "maxLength": 50, "minLength": 1, "example": "Brand A" } } ], "requestBody": { "required": true, "description": "The order attributes to update", "content": { "application/json": { "schema": { "type": "object", "required": [ "tags" ], "properties": { "tags": { "type": "array", "description": "Tags to prepend (deduplicated, case-insensitive) to the order's existing tags. Must contain at least one non-blank tag.", "minItems": 1, "items": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "\\S" }, "example": [ "priority", "vip" ] } } }, "example": { "tags": [ "priority", "vip" ] } } } }, "responses": { "200": { "description": "The order information updated with the new attributes", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "order_number" ], "properties": { "id": { "type": "string", "description": "The ID of the order", "example": "order456" }, "order_number": { "type": "string", "description": "The number of the order (usually the order identifier that the customer knows)", "example": "#Y34DHR" }, "customer_id": { "type": "string", "description": "The ID of the customer that created this order", "example": "customer123" }, "brand": { "type": "string", "description": "The brand associated with the order", "example": "brand" }, "purchase_datetime": { "type": "string", "description": "The timestamp date when the order was created", "format": "date-time", "example": "2021-09-14T12:16:50.078Z" }, "delivery_type": { "type": "string", "description": "Represents the type of delivery for a given order", "enum": [ "UNKNOWN", "LOCAL_DELIVERY", "LOCAL_PICKUP", "SHIPPING" ], "example": "SHIPPING" }, "shipping_address": { "type": "object", "description": "Represents an address of a customer or order", "properties": { "first_name": { "type": "string", "description": "The first name of the person associated with the address", "example": "John" }, "last_name": { "type": "string", "description": "The last name of the person associated with the address", "example": "Doe" }, "phone_number": { "type": "string", "description": "The phone number of the person associated with the address", "example": "+351910000000" }, "address": { "type": "string", "description": "The first line of the address", "example": "Lisbon" }, "zip_code": { "type": "string", "description": "The zip-code of the address", "example": "20000000" }, "city": { "type": "string", "description": "The city of the address", "example": "Lisbon" }, "region_code": { "type": "string", "description": "The region (country subdivision) code according to ISO 3166-2 standard", "example": "PT-11" }, "country_code": { "type": "string", "description": "The country code of the address, according to the ISO 3166-1 alpha-2 codes", "example": "PT" } } }, "billing_address": { "type": "object", "description": "Represents an address of a customer or order", "properties": { "first_name": { "type": "string", "description": "The first name of the person associated with the address", "example": "John" }, "last_name": { "type": "string", "description": "The last name of the person associated with the address", "example": "Doe" }, "phone_number": { "type": "string", "description": "The phone number of the person associated with the address", "example": "+351910000000" }, "address": { "type": "string", "description": "The first line of the address", "example": "Lisbon" }, "zip_code": { "type": "string", "description": "The zip-code of the address", "example": "20000000" }, "city": { "type": "string", "description": "The city of the address", "example": "Lisbon" }, "region_code": { "type": "string", "description": "The region (country subdivision) code according to ISO 3166-2 standard", "example": "PT-11" }, "country_code": { "type": "string", "description": "The country code of the address, according to the ISO 3166-1 alpha-2 codes", "example": "PT" } } }, "items_number": { "type": "integer", "description": "The number of order items", "example": 3 }, "price_summary": { "type": "object", "required": [ "original_total_amount", "final_total_amount" ], "properties": { "original_total_amount": { "description": "The original total amount of the order, i.e. before applying discounts, shipping and taxes", "allOf": [ { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": "number", "description": "The amount of money", "format": "double", "example": 10.5 }, "currency": { "type": "string", "description": "The currency of the money amount", "example": "EUR" } } } ] }, "discounts_amount": { "description": "The amount of the order discounts", "allOf": [ { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": "number", "description": "The amount of money", "format": "double", "example": 10.5 }, "currency": { "type": "string", "description": "The currency of the money amount", "example": "EUR" } } } ] }, "shipping_amount": { "description": "The amount of the order shipping costs", "allOf": [ { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": "number", "description": "The amount of money", "format": "double", "example": 10.5 }, "currency": { "type": "string", "description": "The currency of the money amount", "example": "EUR" } } } ] }, "taxes_amount": { "description": "The amount of the order taxes", "allOf": [ { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": "number", "description": "The amount of money", "format": "double", "example": 10.5 }, "currency": { "type": "string", "description": "The currency of the money amount", "example": "EUR" } } } ] }, "final_total_amount": { "description": "The final total amount of the order, i.e. after applying discounts, shipping and taxes", "allOf": [ { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": "number", "description": "The amount of money", "format": "double", "example": 10.5 }, "currency": { "type": "string", "description": "The currency of the money amount", "example": "EUR" } } } ] }, "net_payment_amount": { "description": "The net payment for the order", "allOf": [ { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": "number", "description": "The amount of money", "format": "double", "example": 10.5 }, "currency": { "type": "string", "description": "The currency of the money amount", "example": "EUR" } } } ] }, "total_outstanding_amount": { "description": "The total amount not yet transacted for the order", "allOf": [ { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": "number", "description": "The amount of money", "format": "double", "example": 10.5 }, "currency": { "type": "string", "description": "The currency of the money amount", "example": "EUR" } } } ] }, "total_refunded_amount": { "description": "The total amount that was refunded", "allOf": [ { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": "number", "description": "The amount of money", "format": "double", "example": 10.5 }, "currency": { "type": "string", "description": "The currency of the money amount", "example": "EUR" } } } ] } } }, "payment_details": { "type": "object", "properties": { "card_brand": { "type": "string", "description": "The payment card brand of the order", "example": "Visa" }, "card_brand_image_url": { "type": "string", "description": "The icon of payment card brand", "example": "https://external-integration.url.com/payment_card_brand_icon.svg" }, "card_number": { "type": "string", "description": "The number of payment card", "example": "**** **** **** *567" } } }, "order_extra_info": { "type": "object", "properties": { "highlighted_item_image_url": { "type": "string", "description": "The image of most expensive item ", "example": "https://external-integration.url.com/payment_card_brand_icon.jpg" } } }, "status": { "type": "string", "description": "The status of the order. Each integration has its own set of possible status values", "example": "CONFIRMED" }, "cancellation_status": { "type": "string", "description": "The cancellation status of the order", "example": "CANCELLATION_REQUESTED" }, "fulfillment_status": { "type": "string", "description": "The fulfillment status of the order", "example": "FULFILLED" }, "payment_status": { "type": "string", "description": "The payment status of the order", "example": "PAID" }, "delivery_status": { "type": "string", "description": "The delivery status of the order", "example": "DELIVERED" }, "return_status": { "type": "string", "description": "The return status of the order", "example": "RETURN_IN_PROGRESS" }, "custom_fields": { "type": "object", "description": "The custom fields associated with the provider", "additionalProperties": true }, "is_refundable": { "type": "boolean", "description": "Indicates whether the current order is refundable", "example": true }, "is_returnable": { "type": "boolean", "description": "Indicates whether the current order is returnable", "example": true }, "is_cancellable": { "type": "boolean", "description": "Indicates whether the current order can be cancelled", "example": true }, "is_change_shipping_address_allowed": { "type": "boolean", "description": "Indicates whether the shipping address of the order can be changed", "example": false }, "tags": { "type": "array", "description": "The list of tags associated with the order", "items": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "\\S" }, "example": [ "priority", "vip" ] } } }, "examples": { "Valid Order": { "value": { "id": "order456", "order_number": "#1131", "customer_id": "customer123", "brand": "brand", "purchase_datetime": "2022-12-12T16:59:18.000Z", "delivery_type": "SHIPPING", "shipping_address": { "first_name": "John", "last_name": "Doe", "phone_number": "+351910000000", "address": "Rua da Alagoa, Lote 16", "zip_code": "3620-360", "city": "Moimenta da Beira", "region_code": "PT-18", "country_code": "PT" }, "tags": [ "priority", "vip", "existing-tag" ], "items_number": 1 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } }, "examples": { "Generic Bad Request": { "value": { "code": "1974000", "message": "Bad request." } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } }, "examples": { "Invalid JWT": { "value": { "code": "1974010", "message": "Invalid JWT." } }, "Account not configured to use ERC E-Commerce APIs": { "value": { "code": "1974011", "message": "Account not configured to use ERC E-Commerce APIs." } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } }, "example": { "code": "1974030", "message": "Required scopes are missing." } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } }, "example": { "code": "1974040", "message": "Resource not found." } } } }, "405": { "description": "Method not supported", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } }, "example": { "code": "1974050", "message": "Method not allowed." } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } }, "example": { "code": "1974220", "message": "Unprocessable entity" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } }, "example": { "code": "1975000", "message": "Internal Server Error." } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } }, "example": { "code": "1975020", "message": "Bad Gateway." } } } } } } } }, "components": { "securitySchemes": { "GA": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://{account_name}.talkdeskid.com/oauth/authorize", "tokenUrl": "https://{account_name}.talkdeskid.com/oauth/token", "scopes": { "account:read": "Show account details", "apps:read": "Get details about app installations for an account", "apps:write": "Update an app installation state programatically", "attributes:read": "List attributes or attribute categories for an account and get details for a specific attribute", "attributes:write": "Create, update and remove attributes or attributes categories for an account", "bulk-imports:read": "Get list of imports and export errors into CSV file", "bulk-imports:write": "Create and update import data", "messages:write": "Ability to send messages from the API", "callback:write": "Request a new direct callback", "contacts-integrations:read": "Get details for contacts' integrations", "contacts:read": "Get details for contact(s)", "contacts:write": "Create, update or delete contacts", "contact-gdpr:write": "GDPR Contacts", "continuity-settings:read": "Read business continuity settings", "continuity-settings:write": "Change business continuity settings", "continuity-settings-activation:read": "Read information on activation of the continuity settings", "continuity-settings-activation:write": "Edit information on activation of the continuity settings", "data-reports:read": "Download previously generated data reports", "data-reports:write": "Create new data reports", "data-tables:read": "Fetch and list data tables", "data-tables:write": "Create and update data tables", "data-tables-exports:read": "List and download data table exports", "data-tables-exports:write": "Create and cancel data table exports", "events:read": "Get details from received events", "express-provisioning:read": "Express-provisioning validate if account exists", "express-provisioning:write": "Provisioning of an account", "express-accounts-usage:read": "Read usage information for an account", "express-accounts:read": "Read account information", "express-accounts-contracts:read": "Get contract info for express accounts", "express-accounts-contracts-actions:write": "Create contract actions for express accounts", "express-accounts-contracts-actions:read": "Read contract actions of express accounts", "express-products:read": "Read product information", "express-accounts-subscriptions:read": "Read subscription information for an account", "express-accounts-invoices:read": "Read invoice information for an account", "erc-ecommerce-shopify-webhooks-handler-credentials:write": "Create or update Shopify webhook handler credentials", "erc-ecommerce-shopify-webhooks-handler-credentials:read": "Read Shopify webhook handler credentials", "flows-interactions:start": "Starts an interaction associated with a flow", "flows-platform:submit": "Trigger an automation flow associated with an account", "fsi-accounts:read": "List of accounts associated with a contact", "fsi-contacts:write": "Update contact information", "fsi-contacts:read": "List and get contact details", "fsi-cards:read": "List of cards from a account", "fsi-cards:write": "Update the status for a card", "fsi-payments:read": "List of payments from a specific account", "fsi-transactions:read": "List of transactions for a specific account", "fsi-payoff:read": "Get the payoff for an FSI account", "fsi-transfers:write": "Create an FSI Transfer", "fsi-stop-payment:write": "Cancel a payment before it’s been processed", "fsi-travel-notification:write": "Create a new endpoint for Travel Notifications", "fsi-checks:read": "Search for a check", "fsi-set-ach-transfer:write": "FSI Set ACH Transfer", "fsi-unlock-account:write": "Unlock account for a banking customer", "fsi-decrypt:read": "The decryption based on AES algorithm", "fsi-write-back:write": "FSI Write Data Back", "fsi-spend-limit:read": "Daily limit for reading debit cards", "fsi-spend-limit:write": "Modify the daily limit of debit cards", "guardian-call-quality:read": "Read Guardian call quality data.", "guardian-sessions:read": "Read Sessions Guardian data.", "guardian-users:read": "Read Users Guardian data.", "guardian-cases:read": "Read Cases Guardian data.", "identity-activity:read": "Identity activity read access", "identity-email-validation:read": "Identity Email Validation read access", "identity-ip-validation:read": "Identity IP Validation read access", "identity-phone-validation:read": "Identity Phone Validation read access", "openid": "User info endpoint", "recordings:read": "Get recording files", "recordings:delete": "Delete recording files", "refresh_token": "Token refresh flow", "reports:read": "List previously generated reports and download them", "reports:write": "Create new reports or delete existing ones", "queues:read": "List CCAAS queues", "queues:write": "Create/update CCAAS queues details", "queues-users:read": "List users assigned to a CCAAS queue", "users:read": "List users for an account and get details for a specific user", "users:write": "Create, Update and Delete users", "interactions:control-recordings": "Control the recording status of an interaction", "fsi-workspace-contact-synchronization:write": "Synchronize Talkdesk contact with fsi member information", "voicebiometrics-enroll:write": "Update and delete Voice Biometrics enroll data", "voicebiometrics-consent:read": "VoiceBiometrics consent read access", "voicebiometrics-consent:write": "VoiceBiometrics consent write access", "live-queries:read": "Read and list queries from Live API", "live-subscriptions:read": "Read subscriptions from Live API", "live-subscriptions:write": "Create a new subscription for Live API", "wfm-aion-public:write": "Create, Update and Delete WFM Aion related data by an external client.", "wfm-request-management-public:write": "Create, Update and Delete WFM Request Management related data by an external client.", "wfm-request-management-public:read": "Read WFM Request Management related data by an external client.", "account-wallets:read": "Get information about account wallets", "bucket-configurations:read": "Get all bucket configurations", "cases-public:write": "Create,update and delete case data", "cases-public:read": "Read case", "case-notes-public:read": "Read case note data", "case-notes-public:write": "Create, edit, and delete case note data", "case-fields-public:read": "Read case field", "do-not-call-lists:manage": "Update a DNCL by adding or deleting a entry on a do not call list", "do-not-call-lists:read": "Read entries in a do not call list", "record-lists:manage": "Ability to view, add and update records of a Record List", "record-lists:write": "Create and update record lists for an account", "role-permissions:skip": "Skip role permissions validation", "campaigns:write": "Create, update and delete campaigns", "campaigns:read": "List and view available campaigns", "schedule-callbacks:read": "List schedule callbacks", "schedule-callbacks:write": "schedule a callbacks or reschedule a callbacks", "po-record-list-automations:write": "Custom record list automations for proactive outbound clients", "prompts:read": "Read prompts", "prompts:write": "Create a prompt", "prompts:delete": "Delete a prompt", "prompts:download": "Get prompt download link", "webhooks-trigger:write": "Create, update and delete a webhook trigger", "cfm-public:write": "Collect feedback data", "digital-connect:read": "List and Get digital-connect Resources", "digital-connect:write": "Create, Update and Delete digital-connect Resources", "entitymapper-contact-interactions:write": "Update interaction's contact mappings", "locations-directory:read": "Read locations information", "locations-directory:write": "Write/update locations information and custom fields", "locations-directory:support": "Create/Update/Delete locations-directory support features", "staffs-directory:read": "Read staffs information", "staffs-directory:write": "Write/update staffs information", "automated-notifications-management:read": "Read Automated Notifications related account information", "automated-notifications-management:write": "Write Automated Notifications related account information", "automated-notifications:read": "Read Automated Notifications event information", "automated-notifications:write": "Write Automated Notifications event information", "automated-notifications-bridge:write": "Write permissions for automated-notifications-bridge webhooks", "automated-notifications-subscriptions:read": "Read Automated Notifications subscriptions related to a topic/channel", "automated-notifications-subscriptions:write": "Write (subscribe/unsubscribe) Automated Notifications subscriptions related to a topic/channel", "entitymapper-map:write": "Write mappings with external entities", "entitymapper-contacts:read": "Search Talkdesk contact", "entitymapper-contacts:write": "Write Talkdesk contact", "appointment-scheduling-va:read": "Read appointment scheduling va entries", "hls-coverage:read": "Read healthcare & life sciences coverage information", "hls-balance:read": "Read healthcare & life sciences balance information", "hls-patient:read": "Read healthcare & life sciences patient information", "hls-providers:call-answered": "Write healthcare & life sciences call answered information", "hls-appointment:read": "Read healthcare & life sciences patient appointments", "hls-medication-order:read": "Read healthcare & life sciences patient medication orders", "hls-appointment:write": "Write healthcare & life sciences patient appointments", "hls-contact:write": "Write healthcare & life sciences data into talkdesk contact", "hls-provider:read": "Read healthcare & life sciences provider appointments", "hls-phone-action:write": "Write healthcare & life sciences phone action", "hls-click-to-call:write": "Write healthcare & life sciences click-to-call action", "hls-epic-outgoing-sms:write": "Trigger outgoing SMS from Epic", "hls-epic-agent-status-sync:write": "Trigger agent status sync from Epic", "hls-inbasket-message:write": "Send in-basket message to Epic", "hls-popup-intent:write": "Save intent of a patient", "hls-prescription:read": "Read healthcare & life sciences prescription information", "hls-prescription:write": "Write healthcare & life sciences prescription information", "hls-encounter:read": "Read healthcare & life sciences patient encounters", "hls-service-request:read": "Read healthcare & life sciences patient service requests", "hls-procedure:read": "Read healthcare & life sciences patient procedures", "hls-payers-connections:read": "Read healthcare & life sciences payers information", "hls-payers-connections:write": "Write healthcare & life sciences payers information", "hls-symptom-checker:write": "Symptom checker for patient", "hls-patient:write": "Write healthcare & life sciences patient information", "hls-epic:call-answered": "Write healthcare & life sciences call answered information", "hls-sycurio:integrate": "Integrate with Sycurio platform", "hls-patient-case:write": "Write healthcare & life sciences patient case information", "hls-outstanding-order:read": "Read healthcare & life sciences outstanding orders", "hls-medication-order:write": "Write healthcare & life sciences medication order(request)", "hls-medication-statement:write": "Write healthcare & life sciences medication statement", "hls-medication-statement:read": "Read healthcare & life sciences medication statement", "hls-hl7-events:write": "Write healthcare providers HL7 events", "erc-ecommerce-connections-orders:write": "Update e-commerce connections orders info", "erc-ecommerce-connections-customers:read": "Read e-commerce connections customers info", "erc-ecommerce-connections-customers:write": "Write e-commerce connections customers info", "erc-ecommerce-connections-orders:read": "Read e-commerce connections orders info", "erc-ecommerce-connections-products:read": "Read e-commerce connections products info", "erc-ecommerce-customers:read": "Read e-commerce customers info", "erc-ecommerce-customers:write": "Write e-commerce customers info", "erc-ecommerce-return-reasons:read": "Read e-commerce return reasons", "erc-ecommerce-return:read": "Read e-commerce return info", "erc-ecommerce-return:write": "Write e-commerce return info", "erc-ecommerce-cart:write": "Sync e-commerce cart items", "erc-ecommerce-products:read": "Search e-commerce catalog products", "erc-ecommerce-orders:read": "Show e-commerce integrations orders info", "erc-ecommerce-orders:write": "Update e-commerce integrations orders info", "erc-ecommerce-recall:write": "Write e-commerce recall contacts", "industries-settings-public:write": "Write industries settings", "industries-contexts:write": "Create, update, and delete context values", "fsi-insurance-connections-automated-notifications:write": "Write Automated Notifications event information", "fsi-insurance-connections-contacts:write": "Sync Talkdesk contacts", "fsi-insurance-connections-claims:read": "Read claims by id from FSI Insurance", "fsi-insurance-integrations-policies:read": "Read policies from FSI Insurance", "fsi-insurance-integrations-accounts:read": "Read accounts from FSI Insurance", "fsi-insurance-integrations-claims:write": "Write claims from FSI Insurance", "fsi-insurance-integrations-billing:read": "Read billing info from FSI Insurance", "fsi-insurance-integrations-claims:read": "Read claims from FSI Insurance", "fsi-insurance-integrations-contacts:write": "Update contact details from FSI Insurance", "fsi-insurance-integrations-send-docs:read": "Send document deliveries from FSI Insurance", "fsi-insurance-integrations-data-back:write": "Write contact event data back to FSI Insurance", "automated-notifications-interactions:read": "Read Automated Notifications related with interactions", "industries-scheduler-teams:read": "Read teams from industries-scheduler", "industries-scheduler-availabilities:read": "Get users availabilities by email", "industries-scheduler-appointment:write": "Create cancel event on specialist's calendar", "industries-scheduler-appointment:read": "Read appointments from industries-scheduler", "industries-messaging-service:write": "Write messages in industries-messaging-service", "interaction-custom-fields:write": "Allows to populate interaction custom fields", "user-session-public:end": "Terminate a user session", "industries-settings-public:read": "Read industries settings", "industries-contexts:read": "Read context values", "dialer-integrations-records:read": "Read dialer integrations campaign records", "scim": "Access SCIM-related routes", "hls-epic-my-chart-reset-password:write": "Trigger Epic MyChart password reset (Deprecated - use hls-patient-password-reset:write)", "hls-patient-password-reset:write": "Trigger patient password reset for healthcare portal", "locations-directory-bulk-operation:write": "Write locations directory data", "locations-directory-batch-operation:write": "Apply a batch of locations directory create/update/delete operations", "hls-patient-location:read": "Read loction patient data", "hls-patient-practice:read": "Read healthcare & life sciences patient practices", "hls-guarantor:read": "Read guarantor identifiers from providers", "hls-guarantor-billing:read": "Read guarantor billing summary from providers", "hls-guarantor-password-reset:write": "Trigger guarantor password reset for healthcare portal", "hls-patient-billing:read": "Read patient billing details from providers", "hls-interaction-overrides:write": "Write healthcare & life sciences interaction-specific configuration overrides", "industries-workflows:read": "Read industries workflow schedules and workflows", "industries-workflows:write": "Create, update, start, and delete industries workflow schedules and workflows", "digital-messaging-adapter:write": "Write or update Digital Messaging Adapter data" } } } } } }, "externalDocs": { "description": "External Documentation", "url": "https://api-docs.talkdeskapp.com/external_docs" } } ```