# Configure Retail App - REST API This page explains how to establish REST API integration between Customer v2 and an external service. The API's can be used in multiple flows and can be configured with variable placeholders to allow reuse in multiple scenarios. Follow a step-by-step tutorial to connection. ## Before You Begin * Confirm you know the **API** you want to connect to and the **authorization requirements** needed perform API calls. * Think about what information returned from the API call is relevant to complete the flow and how to parse it for the user. ## Accessing the REST API Configuration 1. Sign in to **iX Hello Customer v2**. 2. In the left navigation menu, go to **Integrations → REST API**. 3. Select **Create connection** or open an existing REST API to edit. The detail page includes: 1. A **header** displaying the Name and the description. Click **edit** to update the base URL and authorization values. 2. A **list view** of configured methods for this API.

Setting	Value
Name	RetailAPI
Description	Retail Demo API - Customer service for jacket returns and exchanges

{% hint style="info" %} Customer v2 doesn't support editing the Name and Description of the REST API after creation. Ensure they are correct before saving. {% endhint %} 4. Click **Save** to create the REST API and continue to the base URL and authorization type.

Setting	Value
Base URL	https://blsmr065q1.execute-api.us-east-1.amazonaws.com/prod/
Authorization Type	No Authorization

## Configuring the Method request ### Step 1: checkInventoryMethod Setup of the overarching settings that will be used by all methods

Setting	Description
Name	checkInventory
Description	A description to provide further information.
Request type	POST
Method path *	inventory
Query String *	NA
Request Headers *	Request headers are key-value pairs used to transfer metadata about the request. {"Content-Type":"application/json"}
Request Body *	The request body contains the actual data being transferred between the client and the server, in JSON format. {"product_name":"{{product_name}}","size":"{{size}}","color":"{{color}}"}
Result Type	Entry
Result Path	NA
Record Path	$
Record Template	NA
Record Limit	10
Valid Result Template	NA
Empty Result Template	NA

{% hint style="info" %} Enter a \ in a required setting to use the default value of that setting. {% endhint %}

### Step 2: checkInventoryAllMethod Setup of the overarching settings that will be used by all methods

Setting	Description
Name	checkInventoryAll
Description	A description to provide further information.
Request type	POST
Method path *	inventory
Query String *	NA
Request Headers *	Request headers are key-value pairs used to transfer metadata about the request. {"Content-Type":"application/json"}
Request Body *	The request body contains the actual data being transferred between the client and the server, in JSON format. {"product_name":"{{product_name}}"}
Result Type	Entry
Result Path	NA
Record Path	$
Record Template	NA
Record Limit	10
Valid Result Template	NA
Empty Result Template	NA

### Step 3: generateReturnLabelMethod Setup of the overarching settings that will be used by all methods

Setting	Description
Name	generateReturnLabel
Description	A description to provide further information.
Request type	POST
Method path *	return-label
Query String *	NA
Request Headers *	Request headers are key-value pairs used to transfer metadata about the request. {"Content-Type":"application/json"}
Request Body *	The request body contains the actual data being transferred between the client and the server, in JSON format. {"order_id":"{{order_id}}","item_sku":"{{item_sku}}","customer_email":"{{customer_email}}","return_reason":"{{return_reason}}"}
Result Type	Entry
Result Path	NA
Record Path	$
Record Template	NA
Record Limit	10
Valid Result Template	NA
Empty Result Template	NA

### Step 4: getUserDataMethod Setup of the overarching settings that will be used by all methods

Setting	Description
Name	getUserData
Description	A description to provide further information.
Request type	GET
Method path *	user-data
Query String *	ani={{ani}}
Request Headers *	Request headers are key-value pairs used to transfer metadata about the request.
Request Body *	The request body contains the actual data being transferred between the client and the server, in JSON format. {"order_id":"{{order_id}}","item_sku":"{{item_sku}}","customer_email":"{{customer_email}}","return_reason":"{{return_reason}}"}
Result Type	Entry
Result Path	NA
Record Path	$
Record Template	NA
Record Limit	10
Valid Result Template	NA
Empty Result Template	NA

### Step 5: processExchangeMethod Setup of the overarching settings that will be used by all methods

Setting	Description
Name	processExchange
Description	A description to provide further information.
Request type	POST
Method path *	exchange
Query String *	NA
Request Headers *	Request headers are key-value pairs used to transfer metadata about the request. {"Content-Type":"application/json"}
Request Body *	The request body contains the actual data being transferred between the client and the server, in JSON format. {"order_id":"{{order_id}}","original_item_sku":"{{original_item_sku}}","new_item_sku":"{{new_item_sku}}","customer_id":"{{customer_id}}","customer_email":"{{customer_email}}"}
Result Type	Entry
Result Path	NA
Record Path	$
Record Template	NA
Record Limit	10
Valid Result Template	NA
Empty Result Template	NA

### Step 6: registerUserMethod Setup of the overarching settings that will be used by all methods

Setting	Description
Name	registerUser
Description	A description to provide further information.
Request type	POST
Method path *	user-data
Query String *	NA
Request Headers *	Request headers are key-value pairs used to transfer metadata about the request. {"Content-Type":"application/json"}
Request Body *	The request body contains the actual data being transferred between the client and the server, in JSON format. {"ani":"{{ani}}","name":"{{name}}","email":"{{email}}","loyalty_status":"{{loyalty_status}}"}
Result Type	Entry
Result Path	NA
Record Path	$
Record Template	NA
Record Limit	10
Valid Result Template	NA
Empty Result Template	NA

### Step 7: sendConfirmationMethod Setup of the overarching settings that will be used by all methods

Setting	Description
Name	sendConfirmation
Description	A description to provide further information.
Request type	POST
Method path *	sms
Query String *	NA
Request Headers *	Request headers are key-value pairs used to transfer metadata about the request. {"Content-Type":"application/json"}
Request Body *	The request body contains the actual data being transferred between the client and the server, in JSON format. {"phone_number":"{{phone_number}}","message_type":"confirmation","content":{"confirmation_number":"{{confirmation_number}}"}}
Result Type	Entry
Result Path	NA
Record Path	$
Record Template	NA
Record Limit	10
Valid Result Template	NA
Empty Result Template	NA

### Step 8: sendProductLinkMethod Setup of the overarching settings that will be used by all methods

Setting	Description
Name	sendProductLink
Description	A description to provide further information.
Request type	POST
Method path *	sms
Query String *	NA
Request Headers *	Request headers are key-value pairs used to transfer metadata about the request. {"Content-Type":"application/json"}
Request Body *	The request body contains the actual data being transferred between the client and the server, in JSON format. {"phone_number":"{{phone_number}}","message_type":"product_link","content":{"product_url":"{{product_url}}"}}
Result Type	Entry
Result Path	NA
Record Path	$
Record Template	NA
Record Limit	10
Valid Result Template	NA
Empty Result Template	NA

### Step 9: sendSMSMethod Setup of the overarching settings that will be used by all methods

Setting	Description
Name	sendSMS
Description	A description to provide further information.
Request type	POST
Method path *	sms
Query String *	NA
Request Headers *	Request headers are key-value pairs used to transfer metadata about the request. {"Content-Type":"application/json"}
Request Body *	The request body contains the actual data being transferred between the client and the server, in JSON format. {"phone_number":"{{phone_number}}","message_type":"{{message_type}}","content":{"product_url":"{{product_url}}","confirmation_number":"{{confirmation_number}}","message":"{{message}}"}}
Result Type	Entry
Result Path	NA
Record Path	$
Record Template	NA
Record Limit	10
Valid Result Template	NA
Empty Result Template	NA

## Next Steps Once you’ve configured and saved your REST API configuration, they can be selected and configured in an [API call node](/ixhc2/flows/flow-editor/api-call.md). Follow the [vNext Retail Bot](https://app.gitbook.com/o/-M8Qw0HjmL3rDRYUXBX0/s/Fe4cpY1jy0FJ4kgC7wSx/~/edit/~/changes/243/general/tutorials/vnext-retail-bot) tutorial to setup a REST API configuration in preparation for a Retail Bot. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.ixhello.com/ixhc2/general/tutorials/configure-retail-app-rest-api.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.