Impact.com

App · 20 actions

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

Actions

ActionWhat it does
Accept or decline contractAnswer a partner's pending contract proposal.
Create dealCreate a deal partners can promote, such as a sale, free shipping, a gift with purchase or a rebate.
Create partner groupCreate a partner group in a program, optionally with partners in it.
Create promo codeCreate a promo code and assign it to a partner, so sales that use it credit them.
Create tracking linkMake a tracking link for a partner, optionally to a specific page of your site.
Delete dealDelete a deal for good.
Delete partner groupDelete a partner group.
Expire promo codeStop a promo code from working.
List action inquiriesList the claims partners raised about missing or incorrect actions, newest first.
List actionsList the conversions (actions) a program recorded, newest first.
List contractsList a program's partner contracts.
List dealsList your deals, such as sales and free shipping offers.
List partner groupsList a program's partner groups and the partners in each.
List partnersList your partners, oldest first, optionally only those in one program or group.
List programsList your impact.com programs, sorted by program ID.
List promo codesList your promo codes and the partners they credit.
Resolve action inquiryApprove or decline a partner's claim about a missing or incorrect action.
Reverse actionReverse an action, such as a returned order.
Submit conversionSend impact.com a sale or other conversion so the right partner gets credit for it.
Update partner groupRename a partner group, or add or remove partners.

Accept or decline contract

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

Inputs

Programprogram_idnumberRequired
The impact.com program.
Pending contractcontract_idtextRequired
The pending contract to answer.
DecisiondecisiontextRequired
Accept or decline the partner.One of: ACCEPT, DECLINE.
Partner groupsgroup_idslist
Partner groups to put the partner in.
Also accept intoadditional_program_idslist
Other programs of yours to accept the partner into as well, on their public terms. Only used when you accept.
Reasonreasontext
Why you're declining. Only used when you decline.

Outputs

dataobject
The response from Impact.com.
Example output
{
  "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

Programprogram_idnumberRequired
The impact.com program.
NamenametextRequired
The deal's name.
TypetypetextRequired
What the deal offers.One of: GENERAL_SALE (General sale), FREE_SHIPPING (Free shipping), GIFT_WITH_PURCHASE (Gift with purchase), REBATE.
ScopescopetextRequired
What the deal applies to.One of: ENTIRE_STORE (Entire store), PRODUCT, CATEGORY.
Descriptiondescriptiontext
A description partners may see.
Start datestart_datedate and time
When the deal starts.
End dateend_datedate and time
When the deal ends.
Product nameproduct_nametext
The product the deal is for. Needed when it applies to one product.
Categoriescategoriestext
The product categories the deal is for, separated by commas. Needed when it applies to categories.
Discount typediscount_typetext
For a sale: whether the discount is a percentage or a fixed amount.One of: PERCENT, FIXED.
Discount percentdiscount_percentnumber
For a percentage discount: the percentage off.From 0 to 100.
Discount amountdiscount_amountnumber
For a fixed discount: the amount off.At least 0.
Discount currencydiscount_currencytext
The three-letter currency code of the amount off, such as `USD`.
Giftgifttext
For a gift with purchase: the gift. Needed for that kind of deal.
Rebate amountrebate_amountnumber
For a rebate: the rebate amount. Needed for that kind of deal.At least 0.
Rebate currencyrebate_currencytext
The three-letter currency code of the rebate, such as `USD`.
Default promo codedefault_promo_codetext
A promo code partners can share for this deal.
Only for partnerspartner_idslist
Offer the deal only to these partners.
Only for partner groupsgroup_idslist
Offer the deal only to these partner groups.

Outputs

dataobject
The response from Impact.com.
Example output
{
  "data": {
    "Id": "example",
    "Status": "example",
    "Uri": "example"
  }
}

Create partner group

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

Inputs

Programprogram_idnumberRequired
The impact.com program.
NamenametextRequired
The group's name.
Partnerspartner_idslist
Partners to put in the group.

Outputs

dataobject
The response from Impact.com.
Example output
{
  "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

Programprogram_idnumberRequired
The impact.com program.
Partnerpartner_idnumberRequired
The partner.
CodecodetextRequired
The promo code.
Credit policycredit_policytextRequired
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).
Matchmatchtext
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 datestart_datedate and time
When the code starts working.
End dateend_datedate and time
When the code stops working.
Dealdeal_idnumber
A deal to link the code to.

Outputs

dataobject
The response from Impact.com.
Example output
{
  "data": {
    "Id": "example",
    "Status": "example",
    "Uri": "example"
  }
}

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

Inputs

Programprogram_idnumberRequired
The impact.com program.
Partnerpartner_idnumberRequired
The partner.
Landing pagelanding_pagetext
The page on your site the link opens. Your program's default page if left empty.
Link typelink_typetext
A regular link, or a vanity link with a custom path.One of: Regular, Vanity.
Custom pathcustom_pathtext
The custom path for a vanity link, such as `spring-sale`.

Outputs

dataobject
The response from Impact.com.
Example output
{
  "data": {
    "TrackingURL": "example"
  }
}

Delete deal

Delete a deal for good.

Inputs

Dealdeal_idnumberRequired
The deal to delete.

Outputs

dataobject
The response from Impact.com.
Example output
{
  "data": {
    "Status": "example"
  }
}

Delete partner group

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

Inputs

Programprogram_idnumberRequired
The impact.com program.
Partner groupgroup_idnumberRequired
The partner group.

Outputs

dataobject
The response from Impact.com.
Example output
{
  "data": {
    "Status": "example"
  }
}

Expire promo code

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

Inputs

Promo codepromo_code_idnumberRequired
The promo code to expire.

Outputs

dataobject
The response from Impact.com.
Example output
{
  "data": {
    "Id": "example",
    "Status": "example",
    "Uri": "example"
  }
}

List action inquiries

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

Inputs

Programprogram_idnumberRequired
The impact.com program.
Statusstatustext
Only include inquiries with this outcome.One of: UNRESOLVED (Waiting for an answer), VALID (Approved), DECLINED, INCOMPLETE (More information asked for).
Partnerpartner_idnumber
The partner.
Order IDorder_idtext
Only include inquiries about this order number.
Start datestart_datedate and time
Only include records raised on or after this time.
End dateend_datedate and time
Only include records raised on or before this time.
Pagepagenumber
Which page of results to read, starting at 1.At least 1.
Page sizepage_sizenumber
How many records to read on each page.At least 1.

Outputs

dataobject
The response from Impact.com.
Example output
{
  "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

Programprogram_idnumberRequired
The impact.com program.
Statestatetext
Only include actions in this state.One of: PENDING, APPROVED, REVERSED.
Start datestart_datedate and time
Only include records last changed on or after this time.
End dateend_datedate and time
Only include records last changed on or before this time.
Event startevent_startdate and time
Only include records that happened on or after this time.
Event endevent_enddate and time
Only include records that happened on or before this time.
Approved startapproved_startdate and time
Only include records approved on or after this time.
Approved endapproved_enddate and time
Only include records approved on or before this time.
Pagepagenumber
Which page of results to read, starting at 1.At least 1.
Page sizepage_sizenumber
How many records to read on each page.From 2000 to 20000.

Outputs

dataobject
The response from Impact.com.
Example output
{
  "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

Programprogram_idnumberRequired
The impact.com program.
Statusstatustext
Only include contracts with this status.One of: ACTIVE, PENDING, UPCOMING, EXPIRED, DECLINED.
Partnerpartner_idnumber
The partner.
Updated afterupdated_afterdate and time
Only include contracts changed after this time.
Updated beforeupdated_beforedate and time
Only include contracts changed before this time.
Pagepagenumber
Which page of results to read, starting at 1.At least 1.
Page sizepage_sizenumber
How many records to read on each page.At least 1.

Outputs

dataobject
The response from Impact.com.
Example output
{
  "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

Programprogram_idnumber
The impact.com program.
Statestatetext
Only include deals in this state.One of: ACTIVE, PENDING, EXPIRED.
Typetypetext
Only include deals of this kind.One of: GENERAL_SALE (General sale), FREE_SHIPPING (Free shipping), GIFT_WITH_PURCHASE (Gift with purchase), REBATE, BOGO.
Scopescopetext
Only include deals that apply to this much of your store.One of: ENTIRE_STORE (Entire store), PRODUCT, CATEGORY.
Pagepagenumber
Which page of results to read, starting at 1.At least 1.
Page sizepage_sizenumber
How many records to read on each page.At least 1.

Outputs

dataobject
The response from Impact.com.
Example output
{
  "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

Programprogram_idnumberRequired
The impact.com program.
Pagepagenumber
Which page of results to read, starting at 1.At least 1.
Page sizepage_sizenumber
How many records to read on each page.At least 1.

Outputs

dataobject
The response from Impact.com.
Example output
{
  "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

Programprogram_idnumber
The impact.com program.
Partner groupgroup_idnumber
Only include partners in this partner group.
Partnerspartner_idslist
Only include these partners.
Statestatetext
Only include partners whose account is in this state.One of: ACTIVE, PENDING, EXPIRED, DECLINED, SUSPENDED, DEACTIVATED, CLOSING, CLOSED, NOT_APPLICABLE (Not applicable).
Relationshiprelationshiptext
Only include partners with, or without, a contract with you.One of: ACTIVE (Has a contract with you), INACTIVE (No contract with you).
Start datestart_datedate and time
Only include records changed on or after this time.
End dateend_datedate and time
Only include records changed on or before this time.
Pagepagenumber
Which page of results to read, starting at 1.At least 1.
Page sizepage_sizenumber
How many records to read on each page.At least 1.

Outputs

dataobject
The response from Impact.com.
Example output
{
  "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

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

Outputs

dataobject
The response from Impact.com.
Example output
{
  "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

Programprogram_idnumber
The impact.com program.
Codecodetext
Only include this promo code.
Statestatetext
Only include active or inactive codes.One of: ACTIVE, INACTIVE.
Pagepagenumber
Which page of results to read, starting at 1.At least 1.
Page sizepage_sizenumber
How many records to read on each page.At least 1.

Outputs

dataobject
The response from Impact.com.
Example output
{
  "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

Inquiryinquiry_idnumberRequired
The open inquiry to resolve.
DecisiondecisiontextRequired
Approve the claim, decline it, or send it back for more information.One of: VALID (Approve), DECLINED (Decline), INCOMPLETE (Ask for more information).
Decline reasondecline_reasontext
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 typeevent_type_idnumber
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.
Notesnotestext
A note the partner sees with your decision.
Transaction amounttransaction_amountnumber
Use this sale amount instead of the one the partner gave.
Final payoutfinal_payoutnumber
Pay the partner exactly this amount instead of the calculated payout.
Transaction datetransaction_datedate and time
Use this as the date of the sale.

Outputs

dataobject
The response from Impact.com.
Example output
{
  "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

Actionaction_idtextRequired
The action to reverse. The list shows actions from the last 7 days.
ReasonreasontextRequired
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

dataobject
The response from Impact.com.
Example output
{
  "data": {
    "QueuedUri": "example",
    "Status": "example"
  }
}

Submit conversion

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

Inputs

Programprogram_idnumberRequired
The impact.com program.
Event typeevent_type_idnumber
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 codeevent_type_codetext
The code you gave the event type in impact.com, if you use codes instead of the event type.
Event dateevent_datedate and timeRequired
When the conversion happened.
Order IDorder_idtextRequired
Your own order number for the conversion.
Click IDclick_idtext
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 IDcustomer_idtext
Your own ID for the customer. Don't use an email address or other personal details.
Promo codepromo_codetext
The promo code used on the order.
Partnerpartner_idnumber
Give the credit to this partner directly. Use only when nothing else ties the sale to a partner.
Customer statuscustomer_statustext
The customer's status, such as `NEW` or `EXISTING`, as set up for the event type.
Amountamountnumber
The order total.
Currencycurrencytext
The three-letter currency code of the amounts, such as `USD`.
Order discountorder_discountnumber
The discount on the whole order.
Notenotetext
A note to show in your reports.

Outputs

dataobject
The response from Impact.com.
Example output
{
  "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

Programprogram_idnumberRequired
The impact.com program.
Partner groupgroup_idnumberRequired
The partner group.
Namenametext
A new name for the group.
Partners to addadd_partner_idslist
Partners to add to the group.
Partners to removeremove_partner_idslist
Partners to take out of the group.

Outputs

dataobject
The response from Impact.com.
Example output
{
  "data": {
    "Id": "example",
    "Status": "example",
    "Uri": "example"
  }
}

On this page