# Impact.com

> Track partner sales, answer partner applications and claims, and manage deals, promo codes and partner groups in impact.com.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/impact-com

## Actions

### Accept or decline contract

Answer a partner's pending contract proposal. The first answer is final.

**Inputs**

- Program (`program_id`, number, required): The impact.com program.
- Pending contract (`contract_id`, text, required): The pending contract to answer.
- Decision (`decision`, text, required): Accept or decline the partner. One of: `ACCEPT`, `DECLINE`.
- Partner groups (`group_ids`, list): Partner groups to put the partner in.
- Also accept into (`additional_program_ids`, list): Other programs of yours to accept the partner into as well, on their public terms. Only used when you accept.
- Reason (`reason`, text): Why you're declining. Only used when you decline.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "Status": "example"
  }
}
```

### Create deal

Create a deal partners can promote, such as a sale, free shipping, a gift with purchase or a rebate.

**Inputs**

- Program (`program_id`, number, required): The impact.com program.
- Name (`name`, text, required): The deal's name.
- Type (`type`, text, required): What the deal offers. One of: `GENERAL_SALE` (General sale), `FREE_SHIPPING` (Free shipping), `GIFT_WITH_PURCHASE` (Gift with purchase), `REBATE`.
- Scope (`scope`, text, required): What the deal applies to. One of: `ENTIRE_STORE` (Entire store), `PRODUCT`, `CATEGORY`.
- Description (`description`, text): A description partners may see.
- Start date (`start_date`, date and time): When the deal starts.
- End date (`end_date`, date and time): When the deal ends.
- Product name (`product_name`, text): The product the deal is for. Needed when it applies to one product.
- Categories (`categories`, text): The product categories the deal is for, separated by commas. Needed when it applies to categories.
- Discount type (`discount_type`, text): For a sale: whether the discount is a percentage or a fixed amount. One of: `PERCENT`, `FIXED`.
- Discount percent (`discount_percent`, number): For a percentage discount: the percentage off. From 0 to 100.
- Discount amount (`discount_amount`, number): For a fixed discount: the amount off. At least 0.
- Discount currency (`discount_currency`, text): The three-letter currency code of the amount off, such as `USD`.
- Gift (`gift`, text): For a gift with purchase: the gift. Needed for that kind of deal.
- Rebate amount (`rebate_amount`, number): For a rebate: the rebate amount. Needed for that kind of deal. At least 0.
- Rebate currency (`rebate_currency`, text): The three-letter currency code of the rebate, such as `USD`.
- Default promo code (`default_promo_code`, text): A promo code partners can share for this deal.
- Only for partners (`partner_ids`, list): Offer the deal only to these partners.
- Only for partner groups (`group_ids`, list): Offer the deal only to these partner groups.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "Id": "example",
    "Status": "example",
    "Uri": "example"
  }
}
```

### Create partner group

Create a partner group in a program, optionally with partners in it.

**Inputs**

- Program (`program_id`, number, required): The impact.com program.
- Name (`name`, text, required): The group's name.
- Partners (`partner_ids`, list): Partners to put in the group.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "Id": "example",
    "Status": "example",
    "Uri": "example"
  }
}
```

### Create promo code

Create a promo code and assign it to a partner, so sales that use it credit them.

**Inputs**

- Program (`program_id`, number, required): The impact.com program.
- Partner (`partner_id`, number, required): The partner.
- Code (`code`, text, required): The promo code.
- Credit policy (`credit_policy`, text, required): When the partner gets credit for a sale that uses the code. One of: `ALWAYS` (Whenever the code is used), `INVOLVED` (Only if the partner sent the customer), `WINNER` (Only if the partner sent the last click).
- Match (`match`, text): Whether the code must match exactly or is a pattern (a regular expression). Exact if left empty. One of: `LI` (Exact code), `RE` (Pattern (regular expression)).
- Start date (`start_date`, date and time): When the code starts working.
- End date (`end_date`, date and time): When the code stops working.
- Deal (`deal_id`, number): A deal to link the code to.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "Id": "example",
    "Status": "example",
    "Uri": "example"
  }
}
```

### Create tracking link

Make a tracking link for a partner, optionally to a specific page of your site.

**Inputs**

- Program (`program_id`, number, required): The impact.com program.
- Partner (`partner_id`, number, required): The partner.
- Landing page (`landing_page`, text): The page on your site the link opens. Your program's default page if left empty.
- Link type (`link_type`, text): A regular link, or a vanity link with a custom path. One of: `Regular`, `Vanity`.
- Custom path (`custom_path`, text): The custom path for a vanity link, such as `spring-sale`.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "TrackingURL": "example"
  }
}
```

### Delete deal

Delete a deal for good.

**Inputs**

- Deal (`deal_id`, number, required): The deal to delete.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "Status": "example"
  }
}
```

### Delete partner group

Delete a partner group. Its partners stay in the program.

**Inputs**

- Program (`program_id`, number, required): The impact.com program.
- Partner group (`group_id`, number, required): The partner group.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "Status": "example"
  }
}
```

### Expire promo code

Stop a promo code from working. impact.com keeps it as inactive.

**Inputs**

- Promo code (`promo_code_id`, number, required): The promo code to expire.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "Id": "example",
    "Status": "example",
    "Uri": "example"
  }
}
```

### List action inquiries

List the claims partners raised about missing or incorrect actions, newest first.

**Inputs**

- Program (`program_id`, number, required): The impact.com program.
- Status (`status`, text): Only include inquiries with this outcome. One of: `UNRESOLVED` (Waiting for an answer), `VALID` (Approved), `DECLINED`, `INCOMPLETE` (More information asked for).
- Partner (`partner_id`, number): The partner.
- Order ID (`order_id`, text): Only include inquiries about this order number.
- Start date (`start_date`, date and time): Only include records raised on or after this time.
- End date (`end_date`, date and time): Only include records raised on or before this time.
- Page (`page`, number): Which page of results to read, starting at 1. At least 1.
- Page size (`page_size`, number): How many records to read on each page. At least 1.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "ActionInquiries": [
      {
        "ActionId": "example",
        "CampaignId": "example",
        "CreationDate": "example",
        "ExpectedPayout": "example",
        "Id": "example",
        "InquiryType": "example",
        "MediaPartnerId": "example",
        "MediaPartnerName": "example",
        "OrderId": "example",
        "ResolutionDeadlineDate": "example",
        "ResolutionStatus": "example",
        "TransactionAmount": "example",
        "TransactionDate": "example",
        "Uri": "example"
      }
    ]
  }
}
```

### List actions

List the conversions (actions) a program recorded, newest first. With no dates, impact.com returns the last 7 days.

**Inputs**

- Program (`program_id`, number, required): The impact.com program.
- State (`state`, text): Only include actions in this state. One of: `PENDING`, `APPROVED`, `REVERSED`.
- Start date (`start_date`, date and time): Only include records last changed on or after this time.
- End date (`end_date`, date and time): Only include records last changed on or before this time.
- Event start (`event_start`, date and time): Only include records that happened on or after this time.
- Event end (`event_end`, date and time): Only include records that happened on or before this time.
- Approved start (`approved_start`, date and time): Only include records approved on or after this time.
- Approved end (`approved_end`, date and time): Only include records approved on or before this time.
- Page (`page`, number): Which page of results to read, starting at 1. At least 1.
- Page size (`page_size`, number): How many records to read on each page. From 2000 to 20000.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "Actions": [
      {
        "ActionTrackerId": "example",
        "ActionTrackerName": "example",
        "Amount": "example",
        "CampaignId": "example",
        "CampaignName": "example",
        "CreationDate": "example",
        "Currency": "example",
        "CustomerId": "example",
        "CustomerStatus": "example",
        "EventDate": "example",
        "Id": "example",
        "LockingDate": "example",
        "MediaPartnerId": "example",
        "MediaPartnerName": "example",
        "Oid": "example",
        "Payout": "example",
        "PromoCode": "example",
        "State": "example",
        "Uri": "example"
      }
    ]
  }
}
```

### List contracts

List a program's partner contracts. Choose Pending for applications waiting for your answer. With no status, only active contracts are listed.

**Inputs**

- Program (`program_id`, number, required): The impact.com program.
- Status (`status`, text): Only include contracts with this status. One of: `ACTIVE`, `PENDING`, `UPCOMING`, `EXPIRED`, `DECLINED`.
- Partner (`partner_id`, number): The partner.
- Updated after (`updated_after`, date and time): Only include contracts changed after this time.
- Updated before (`updated_before`, date and time): Only include contracts changed before this time.
- Page (`page`, number): Which page of results to read, starting at 1. At least 1.
- Page size (`page_size`, number): How many records to read on each page. At least 1.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "Contracts": [
      {
        "DateCreated": "example",
        "DateLastUpdated": "example",
        "EndDate": "example",
        "Id": "example",
        "PartnerId": "example",
        "StartDate": "example",
        "Status": "example",
        "TemplateTerms": {
          "Name": "example",
          "TemplateId": "example"
        },
        "Uri": "example"
      }
    ]
  }
}
```

### List deals

List your deals, such as sales and free shipping offers.

**Inputs**

- Program (`program_id`, number): The impact.com program.
- State (`state`, text): Only include deals in this state. One of: `ACTIVE`, `PENDING`, `EXPIRED`.
- Type (`type`, text): Only include deals of this kind. One of: `GENERAL_SALE` (General sale), `FREE_SHIPPING` (Free shipping), `GIFT_WITH_PURCHASE` (Gift with purchase), `REBATE`, `BOGO`.
- Scope (`scope`, text): Only include deals that apply to this much of your store. One of: `ENTIRE_STORE` (Entire store), `PRODUCT`, `CATEGORY`.
- Page (`page`, number): Which page of results to read, starting at 1. At least 1.
- Page size (`page_size`, number): How many records to read on each page. At least 1.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "Deals": [
      {
        "CampaignId": "example",
        "DefaultPromoCode": "example",
        "Description": "example",
        "EndDate": "example",
        "Id": "example",
        "Name": "example",
        "Scope": "example",
        "StartDate": "example",
        "State": "example",
        "Type": "example",
        "Uri": "example"
      }
    ]
  }
}
```

### List partner groups

List a program's partner groups and the partners in each.

**Inputs**

- Program (`program_id`, number, required): The impact.com program.
- Page (`page`, number): Which page of results to read, starting at 1. At least 1.
- Page size (`page_size`, number): How many records to read on each page. At least 1.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "Groups": [
      {
        "Id": "example",
        "MediaPartners": [
          {
            "PartnerId": "example",
            "PartnerName": "example"
          }
        ],
        "Name": "example",
        "Uri": "example"
      }
    ]
  }
}
```

### List partners

List your partners, oldest first, optionally only those in one program or group.

**Inputs**

- Program (`program_id`, number): The impact.com program.
- Partner group (`group_id`, number): Only include partners in this partner group.
- Partners (`partner_ids`, list): Only include these partners.
- State (`state`, text): Only include partners whose account is in this state. One of: `ACTIVE`, `PENDING`, `EXPIRED`, `DECLINED`, `SUSPENDED`, `DEACTIVATED`, `CLOSING`, `CLOSED`, `NOT_APPLICABLE` (Not applicable).
- Relationship (`relationship`, text): Only include partners with, or without, a contract with you. One of: `ACTIVE` (Has a contract with you), `INACTIVE` (No contract with you).
- Start date (`start_date`, date and time): Only include records changed on or after this time.
- End date (`end_date`, date and time): Only include records changed on or before this time.
- Page (`page`, number): Which page of results to read, starting at 1. At least 1.
- Page size (`page_size`, number): How many records to read on each page. At least 1.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "Partners": [
      {
        "Currency": "example",
        "DateCreated": "example",
        "DateLastUpdated": "example",
        "Description": "example",
        "Id": "example",
        "Name": "example",
        "PartnerType": "example",
        "State": "example",
        "Uri": "example",
        "Website": "example"
      }
    ]
  }
}
```

### List programs

List your impact.com programs, sorted by program ID.

**Inputs**

- State (`state`, text): Only include programs in this state. One of: `ACTIVE`, `AWAITING_REVIEW` (Awaiting review), `CANCELLED`, `CLOSED`, `DEACTIVATED`, `DELINQUENT`, `REJECTED`, `SETUP`, `SETUP_COMPLETE` (Setup complete).
- Page (`page`, number): Which page of results to read, starting at 1. At least 1.
- Page size (`page_size`, number): How many records to read on each page. At least 1.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "Campaigns": [
      {
        "Id": "example",
        "Name": "example",
        "ShortDescription": "example",
        "State": "example",
        "TrackingDomain": "example",
        "Type": "example",
        "Uri": "example"
      }
    ]
  }
}
```

### List promo codes

List your promo codes and the partners they credit.

**Inputs**

- Program (`program_id`, number): The impact.com program.
- Code (`code`, text): Only include this promo code.
- State (`state`, text): Only include active or inactive codes. One of: `ACTIVE`, `INACTIVE`.
- Page (`page`, number): Which page of results to read, starting at 1. At least 1.
- Page size (`page_size`, number): How many records to read on each page. At least 1.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "PromoCodes": [
      {
        "AssignedPartnerId": "example",
        "AssignedPartnerName": "example",
        "CampaignId": "example",
        "Code": "example",
        "CreditPolicy": "example",
        "DealId": "example",
        "DealName": "example",
        "EndDate": "example",
        "Id": "example",
        "StartDate": "example",
        "State": "example",
        "Type": "example",
        "Uri": "example"
      }
    ]
  }
}
```

### Resolve action inquiry

Approve or decline a partner's claim about a missing or incorrect action.

**Inputs**

- Inquiry (`inquiry_id`, number, required): The open inquiry to resolve.
- Decision (`decision`, text, required): Approve the claim, decline it, or send it back for more information. One of: `VALID` (Approve), `DECLINED` (Decline), `INCOMPLETE` (Ask for more information).
- Decline reason (`decline_reason`, text): Why the claim is declined. Needed when you decline it. One of: `This transaction has been tracked successfully`, `Another marketing channel was credited with the sale`, `Another marketing channel was credited with the sale, due to a voucher/discount code used`, `Did not meet terms and conditions set by merchant`, `Transaction not completed - Order cancelled, changed, or returned`, `Transaction cannot be traced`, `Transaction not fully completed online`, `Enquiry does not provide complete information required for evaluation`, `Other`.
- Event type (`event_type_id`, number): The event type (for example Online Sale). The list shows event types your programs recorded in the last 7 days. Needed when you approve the claim.
- Notes (`notes`, text): A note the partner sees with your decision.
- Transaction amount (`transaction_amount`, number): Use this sale amount instead of the one the partner gave.
- Final payout (`final_payout`, number): Pay the partner exactly this amount instead of the calculated payout.
- Transaction date (`transaction_date`, date and time): Use this as the date of the sale.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "Id": "example",
    "Status": "example",
    "Uri": "example"
  }
}
```

### Reverse action

Reverse an action, such as a returned order. This cancels the partner's pending payout for it.

**Inputs**

- Action (`action_id`, text, required): The action to reverse. The list shows actions from the last 7 days.
- Reason (`reason`, text, required): Why the action is being reversed. One of: `ITEM_RETURNED` (Item returned), `ORDER_ERROR` (Order error), `REJECTED`, `CONS_FRAUD` (Customer fraud), `CONS_ERROR` (Customer error), `CONS_INFO_INVALID` (Customer details invalid), `ITEM_OUT_OF_STOCK` (Item out of stock), `NOT_COMPLIANCE_TERMS` (Partner broke the program terms), `CREDITED_DIFFERENT_MP` (Credited to a different partner), `PUB_ACT_DISPUTE` (Disputed by the partner), and 4 more.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "QueuedUri": "example",
    "Status": "example"
  }
}
```

### Submit conversion

Send impact.com a sale or other conversion so the right partner gets credit for it.

**Inputs**

- Program (`program_id`, number, required): The impact.com program.
- Event type (`event_type_id`, number): The event type (for example Online Sale). The list shows event types your programs recorded in the last 7 days. Fill in this or Event type code.
- Event type code (`event_type_code`, text): The code you gave the event type in impact.com, if you use codes instead of the event type.
- Event date (`event_date`, date and time, required): When the conversion happened.
- Order ID (`order_id`, text, required): Your own order number for the conversion.
- Click ID (`click_id`, text): The impact.com click ID from the visitor's tracking link. Fill in this, Customer ID, Promo code or Partner so impact.com knows who referred the sale.
- Customer ID (`customer_id`, text): Your own ID for the customer. Don't use an email address or other personal details.
- Promo code (`promo_code`, text): The promo code used on the order.
- Partner (`partner_id`, number): Give the credit to this partner directly. Use only when nothing else ties the sale to a partner.
- Customer status (`customer_status`, text): The customer's status, such as `NEW` or `EXISTING`, as set up for the event type.
- Amount (`amount`, number): The order total.
- Currency (`currency`, text): The three-letter currency code of the amounts, such as `USD`.
- Order discount (`order_discount`, number): The discount on the whole order.
- Note (`note`, text): A note to show in your reports.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "QueuedUri": "example",
    "Status": "example"
  }
}
```

### Update partner group

Rename a partner group, or add or remove partners. Fields left empty stay as they are.

**Inputs**

- Program (`program_id`, number, required): The impact.com program.
- Partner group (`group_id`, number, required): The partner group.
- Name (`name`, text): A new name for the group.
- Partners to add (`add_partner_ids`, list): Partners to add to the group.
- Partners to remove (`remove_partner_ids`, list): Partners to take out of the group.

**Outputs**

- `data` (object): The response from Impact.com.

**Example output**

```json
{
  "data": {
    "Id": "example",
    "Status": "example",
    "Uri": "example"
  }
}
```
