# Gorgias

This article provides a guide on how to connect your Gorgias account with your CheckoutChamp CRM.

{% hint style="info" %}
Gorgias CheckoutChamp Integration Documentation can be found [here](https://docs.gorgias.com/ecommerce-integrations/checkout-champ)
{% endhint %}

***

### Step 1: Obtain Gorgias API Credentials <a href="#gorgias-step1-obtaingorgiasapicredentials" id="gorgias-step1-obtaingorgiasapicredentials"></a>

#### Navigate to **Settings → REST API** to obtain these credentials. <a href="#gorgias-navigatetosettings-restapitoobtainthesecredentials" id="gorgias-navigatetosettings-restapitoobtainthesecredentials"></a>

<figure><img src="/files/2zdFAzOKJ8WdMQlJJwwV" alt=""><figcaption></figcaption></figure>

#### **Be sure to save/copy all fields as they will be required for the CRM setup.** <a href="#gorgias-besuretosave-copyallfieldsastheywillberequiredforthecrmsetup" id="gorgias-besuretosave-copyallfieldsastheywillberequiredforthecrmsetup"></a>

### Step 2: Setup the CRM Plugin <a href="#gorgias-step2-setupthecrmplugin" id="gorgias-step2-setupthecrmplugin"></a>

#### Navigate to **Admin** → **Plugins** → **Data Sources** and click on the green “**+Activate**” button on the Gorgias tile <a href="#gorgias-navigatetoadmin-plugins-datasourcesandclickonthegreen-activate-buttononthegorgiastile" id="gorgias-navigatetoadmin-plugins-datasourcesandclickonthegreen-activate-buttononthegorgiastile"></a>

&#x20;![](/files/pDcgHqVEo5cKq7IQHBpD)

&#x20;

#### **baseUrl** **-** your Gorgias Base API Url used to make requests to Gorgias’ API. <a href="#gorgias-baseurl-yourgorgiasbaseapiurlusedtomakerequeststogorgiasapi" id="gorgias-baseurl-yourgorgiasbaseapiurlusedtomakerequeststogorgiasapi"></a>

#### **userName** **-** your Gorgias REST API username as it shows in Gorgias. <a href="#gorgias-username-yourgorgiasrestapiusernameasitshowsingorgias" id="gorgias-username-yourgorgiasrestapiusernameasitshowsingorgias"></a>

#### **apiKey** **-** your Gorgias API key (required) <a href="#gorgias-apikey-yourgorgiasapikey-required" id="gorgias-apikey-yourgorgiasapikey-required"></a>

#### **IntegrationId -** read-only value that represents the Id of the Gorgias integration. <a href="#gorgias-integrationid-read-onlyvaluethatrepresentstheidofthegorgiasintegration" id="gorgias-integrationid-read-onlyvaluethatrepresentstheidofthegorgiasintegration"></a>

&#x20;

<figure><img src="/files/ddsfQTHiZEXpe86LHZgN" alt=""><figcaption></figcaption></figure>

&#x20;

&#x20;

#### Once the plugin is activated you should now see a new HTTP Integration and also a few macros to be used with this integration inside of Gorgias. <a href="#gorgias-oncethepluginisactivatedyoushouldnowseeanewhttpintegrationandalsoafewmacrostobeusedwiththisi" id="gorgias-oncethepluginisactivatedyoushouldnowseeanewhttpintegrationandalsoafewmacrostobeusedwiththisi"></a>

&#x20;

### Step 3: Verify that the Integration and Widget were successfully created. <a href="#gorgias-step3-verifythattheintegrationandwidgetweresuccessfullycreated" id="gorgias-step3-verifythattheintegrationandwidgetweresuccessfullycreated"></a>

**Integrations can be found in Settings → General → Integrations. You should see an HTTP integration named “CheckoutChamp Integration”.**

<figure><img src="/files/poi3REIdafzf3Y8D1hFD" alt=""><figcaption></figcaption></figure>

**The CheckoutChamp Integration pulls orders from the CRM based on email address used in the ticket.**

**If the customer exists the widget on the right will populate with the customer’s order data. Please see below.**

<figure><img src="/files/Qde24x4g1clJsf3AQ0NN" alt=""><figcaption></figcaption></figure>

### Step 4: Verify the Macros were successfully created. <a href="#gorgias-step4-verifythemacrosweresuccessfullycreated" id="gorgias-step4-verifythemacrosweresuccessfullycreated"></a>

**Macros can be found in Settings → Automation → Macros. Once on the Macro page you should see 11 CheckoutChamp macros.**

<figure><img src="/files/g4N9P7gb7oNB1FNxCcql" alt=""><figcaption></figcaption></figure>

**CheckoutChamp Full Refund** - Allows for a Gorgias rep to issue a refund for a particular order.

**CheckoutChamp Partial Refund** - Allows for a Gorgias rep to issue a partial refund for a particular order.

**CheckoutChamp Shipping Address Change** - Allows for a Gorgias rep to change shipping address details tied to an order.

**CheckoutChamp Billing Address Change** - Allows for a Gorgias rep to change billing address details tied to an order.

**CheckoutChamp Cancel Order** - Allows for a Gorgias rep to cancel an order. Can issue full refunds.

**CheckoutChamp Customer Note** - Allows for a Gorgias rep to add a note to a customer record in the CRM.

**CheckoutChamp Customer Update** - Allows for a Gorgias rep to update info on a CRM customer's record.

**CheckoutChamp Cancel Subscription** - Allows for a Gorgias rep to cancel a CRM Subscription.

**CheckoutChamp Pause Subscription** - Allows for a Gorgias rep to pause a CRM Subscription.

**CheckoutChamp Update Subscription Bill Cycle** - Allows for a Gorgias rep to update a CRM Subscription.

**CheckoutChamp Update Subscription Products** - Allows for a Gorgias rep to update a CRM Subscription.

{% hint style="info" %}
A note on Gorgias Operations. If a value in a text box is defaulted to 0, it is a true/false value. Enter 0 for false, 1 for true.
{% endhint %}

{% hint style="warning" %}
Troubleshooting: If the Gorgias Widget, or any macro, is accidentally deleted, delete the Gorgias plugin and repeat these steps to restore them.
{% endhint %}


---

# 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://help.checkoutchamp.com/crm/plugins/data-sources/gorgias.md?ask=<question>
```

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.