Skip to main content

Rakuten Advertising

Rakuten Advertising (formerly LinkShare) is an affiliate marketing network that connects publishers with advertisers. The Rakuten Advertising connector reads a publisher's transactions, contributed conversions, partnerships, advertisers, offers, commissioning lists, coupons, product search results, text and banner links, and payment reports, and generates affiliate deep links.

Rakuten Advertising icon

Power end-to-end data operations for your Rakuten Advertising API with Nexla. Our bi-directional Rakuten Advertising connector is purpose-built for Rakuten Advertising, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Rakuten Advertising or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Rakuten Advertising workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites​

Nexla connects to the Rakuten Advertising publisher APIs with a token key from a Developer Portal application and your Site ID (SID). For each session, Nexla exchanges them for a one-hour API access token and renews it automatically.

  1. Publisher account. You need a Rakuten Advertising publisher account. Your Site ID (SID), the publisher account ID, is shown in the publisher dashboard.

  2. Application. Sign in to the Rakuten Advertising Developer Portal, open Applications, and click Add Application. Name the application, and copy its Client ID and Client Secret.

  3. Token key. The token key is your client ID and client secret joined by a colon and Base64-encoded. On Linux or macOS, run:

    echo -n '<client_id>:<client_secret>' | base64

    In Windows PowerShell, run:

    [Convert]::ToBase64String([Text.Encoding]::UTF8.GetBytes('<client_id>:<client_secret>'))

    Rakuten says the result is an 87-character string ending in =.

  4. Web security token (optional). The three payment report templates use Rakuten's Advanced Reports API, which needs a separate web security token. In the publisher dashboard, go to Support > APIs > Manage Tokens > Security Token, or open the token page directly, and copy it.

For details, see Rakuten Advertising's Access Tokens guide.

Data needs an approved advertiser partnership

Most templates return data only for advertisers you have an approved partnership with. Until at least one advertiser approves your application, transactions, offers, coupons, links, products, and payment reports come back empty. Use List Advertisers and Search Advertisers by Name to find advertisers to apply to.

Rakuten Advertising API rate limits

Rakuten limits each API to 100 calls per minute, and the Advanced Reports API (the payment report templates) to 500 calls per day. Templates that page through results make one call per page.

Authenticate​

Credentials required​

POSTs scope=<SID> to api.linksynergy.com/token with Authorization: Bearer <token key>, then sends the returned access_token as Bearer on every call.

FieldRequiredSecretDescription
Token KeyYesYesBase64 of client_id:client_secret from your Developer Portal application (echo -n id:secret | base64). Sent as Bearer to /token to get a 1-hour access token.
Site ID (SID)YesNoYour Rakuten Advertising publisher account ID (SID), sent as scope when requesting the access token. Shown in the publisher dashboard.
Web Security Token (Advanced Reports)NoYesOnly for payment reports (Advanced Reports API). Publisher dashboard > Support > APIs > Manage Tokens > Security Token. Not the Bearer token.

Create a credential in Nexla​

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Paste the Base64-encoded token key into the Token Key field. Enter the token key, not the client ID or client secret on their own. Nexla sends it as Authorization: Bearer <token key> when it requests an access token.

    The token key contains your client secret and should be kept secure. If it is exposed, regenerate the client secret for the application in the Rakuten Advertising Developer Portal, build a new token key, and update this credential.

  4. Enter your publisher account ID in the Site ID (SID) field. Nexla sends it as the scope of the access token request, so the token reads data for this account.

  5. Optionally, paste your web security token into the Web Security Token (Advanced Reports) field. It is needed only for the Payment History Summary, Advertiser Payments in a Payment, and Payment Details by Invoice templates. It is not the token key or the access token.

  6. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Nexla tests the credential by requesting an access token and reading one of your partnerships.

Nexla requests the access token by sending scope=<SID> in the request body, as in Rakuten's example request. Rakuten's guide also mentions a grant_type=password parameter, which Nexla does not send. If the credential test fails while your token key and SID are correct, check both values against the Developer Portal and the publisher dashboard, and contact Nexla support if it still fails.

Use as a data source​

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Rakuten Advertising connector tile, then select the credential that will be used to connect to your Rakuten Advertising publisher account, and click Next; or, create a new Rakuten Advertising credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Rakuten Advertising endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below, grouped by area.

Templates that say Nexla reads every page request one page after another until a page comes back short or empty; all other templates make a single request. Several Rakuten APIs return XML or CSV rather than JSON; Nexla parses each format into records. Templates that need an advertiser ID (MID) read data for that one advertiser; use List Partnerships, List Advertisers, or Search Advertisers by Name to find it.

Transactions and conversions​

Transactions by Process Date

Lists the commissionable sales and returns Rakuten processed in a date window, with order ID, advertiser, SKU, sale amount, commission, and u1 value.

  • Calls GET /events/1.0/transactions?process_date_start={Processed From}&process_date_end={Processed To}.
  • Nexla requests one page after another until a page comes back short or empty.
  • Processed From (required; default {now-29}): Start of the process-date window, YYYY-MM-DD HH:mm:ss UTC. At most 30 days ago.
  • Processed To (required; default {now}): End of the process-date window, YYYY-MM-DD HH:mm:ss UTC. Window max 30 days.
  • The window can span at most 30 days and must start within the last 30 days. Dates are in UTC, in yyyy-MM-dd HH:mm:ss format; the default window is the last 29 days.
  • See the Rakuten Advertising API reference for the response fields.

Transactions by Order Date

Lists transactions by the date the shopper placed the order, with order ID, advertiser, SKU, sale amount, commission, and u1 value. Use it to read orders older than the process-date window allows.

  • Calls GET /events/1.0/transactions?transaction_date_start={Ordered From}&transaction_date_end={Ordered To}.
  • Nexla requests one page after another until a page comes back short or empty.
  • Ordered From (required; default {now-29}): Start of the order-date window, YYYY-MM-DD HH:mm:ss UTC. At most 100 days ago.
  • Ordered To (required; default {now}): End of the order-date window, YYYY-MM-DD HH:mm:ss UTC. Window max 30 days.
  • The window can span at most 30 days and must start within the last 100 days. Dates are in UTC, in yyyy-MM-dd HH:mm:ss format; the default window is the last 29 days.
  • See the Rakuten Advertising API reference for the response fields.

Contributed Conversions

Lists orders your clicks contributed to, even when another publisher earned the commission, with order ID, advertiser, position in the shopper's journey, u1 value, and order date. The default window is the last 30 days.

  • Calls GET /v1/publishers/contributed-conversions?start_date={Start Date}&end_date={End Date}.
  • Nexla requests one page after another until a page comes back short or empty.
  • Start Date (required; default {now-30}): Conversion transaction date from, YYYY-MM-DD.
  • End Date (required; default {now}): Conversion transaction date to, YYYY-MM-DD.
  • See the Rakuten Advertising API reference for the response fields.

Advertisers and partnerships​

List Partnerships

Lists the advertisers you have a partnership with, or have applied to, in one partnership status, with network, categories, and the dates you applied, were approved, and last changed status.

  • Calls GET /v1/partnerships?partner_status={Partnership Status}.
  • Nexla requests one page after another until a page comes back short or empty.
  • Partnership Status (required; default active): Partnership status to return. Options: Active (active), Pending (pending), Extended (extended), Temporarily declined (temp-decline), Temporarily removed (temp-remove), Permanently declined (permanent-decline), Permanently removed (permanent-remove), Self-removed (self-removed).
  • See the Rakuten Advertising API reference for the response fields.

Get Partnership

Returns your partnership with one advertiser: status, network, categories, and the apply, approval, and last status-change dates.

  • Calls GET /v1/partnerships/{Advertiser ID (MID)}.
  • Advertiser ID (MID) (required): The numeric advertiser ID (MID). Use List Partnerships or List Advertisers to find it.
  • See the Rakuten Advertising API reference for the response fields.

List Advertisers

Lists the advertisers in the Rakuten Advertising network, partnered or not, with name, URL, description, network, categories, shipping countries, and whether deep links are allowed.

  • Calls GET /v2/advertisers.
  • Nexla requests one page after another until a page comes back short or empty.
  • See the Rakuten Advertising API reference for the response fields.

Get Advertiser

Returns one advertiser: whether you can partner with it, name, URL, description, policies (such as ships-to countries and deep link support), and contact details.

  • Calls GET /v2/advertisers/{Advertiser ID (MID)}.
  • Advertiser ID (MID) (required): The numeric advertiser ID (MID). Use List Partnerships or List Advertisers to find it.
  • See the Rakuten Advertising API reference for the response fields.

Search Advertisers by Name

Returns the advertiser IDs (MIDs) and names that match a full or partial name, including programs you are not approved for. Use it to find a MID before running other templates.

  • Calls GET /advertisersearch/1.0?merchantname={Advertiser Name}.
  • Advertiser Name (required): A full or partial advertiser name, for example macy.
  • Uses Rakuten's legacy Advertiser Search API, which returns XML.
  • See the Rakuten Advertising API reference for the response fields.

Advertisers by Application Status

Lists the advertisers whose programs you applied to, filtered by application status, with MID, name, categories, and offer commission terms.

  • Calls GET /linklocator/1.0/getMerchByAppStatus/{Application Status}.
  • Application Status (required; default approved): Application status to return. Options: Approved (approved), Approval extended (approval extended), Waiting (wait), Temporarily removed (temp removed), Temporarily rejected (temp rejected), Permanently removed (perm removed), Permanently rejected (perm rejected), Self-removed (self removed).
  • Uses Rakuten's Link Locator API, which returns XML.
  • See the Rakuten Advertising API reference for the response fields.

Offers and commissioning lists​

List Offers

Lists commission offers from partnered advertisers, with group offer ID (GOID), type, commission terms, return days, and start and end dates.

  • Calls GET /v1/offers?offer_status={Offer Status}.
  • Nexla requests one page after another until a page comes back short or empty.
  • Offer Status (required; default active): active returns offers that have started and that you opted in to; upcoming returns opted-in offers that start in the future; available returns offers you can opt in to. Options: Active (active), Available (available), Upcoming (upcoming).
  • See the Rakuten Advertising API reference for the response fields.

Get Offer

Returns one offer by its group offer ID (GOID): advertiser, status, type, commission terms, return days, auto-renewal, and start and end dates.

  • Calls GET /v1/offers/{Group Offer ID (GOID)}.
  • Group Offer ID (GOID) (required): The group offer ID. Use List Offers to find it.
  • See the Rakuten Advertising API reference for the response fields.

List Commissioning Lists

Lists the commissioning lists advertisers have added you to, with list ID and name, advertiser, the offers each list applies to, and last modified date.

  • Calls GET /v1/commissioninglists.
  • Nexla requests one page after another until a page comes back short or empty.
  • See the Rakuten Advertising API reference for the response fields.

Get Commissioning List

Returns one commissioning list: name, advertiser, the offers it applies to, and last modified date.

  • Calls GET /v1/commissioninglists/{List ID}.
  • List ID (required): The commissioning list ID. Use List Commissioning Lists to find it.
  • See the Rakuten Advertising API reference for the response fields.

List Coupons

Lists coupons and deals from partnered advertisers, with advertiser, description, coupon code, start and end dates, categories, promotion types, and click URL.

  • Calls GET /coupon/1.0.
  • Nexla requests one page after another until a page comes back short or empty.
  • Uses Rakuten's Coupon API, which returns XML.
  • See the Rakuten Advertising API reference for the response fields.

List Coupons by Advertiser

Lists coupons and deals from the partnered advertisers you choose, with description, coupon code, start and end dates, categories, and click URL.

  • Calls GET /coupon/1.0?mid={Advertiser IDs (MIDs)}.
  • Nexla requests one page after another until a page comes back short or empty.
  • Advertiser IDs (MIDs) (required): One or more advertiser IDs (MIDs), separated by |, for example 2149|38605.
  • Uses Rakuten's Coupon API, which returns XML.
  • See the Rakuten Advertising API reference for the response fields.

Search Products

Searches the product feeds of partnered advertisers, and returns matching products with name, SKU, advertiser, category, price, sale price, description, image URL, and click URL.

  • Calls GET /productsearch/1.0?keyword={Keywords}.
  • Nexla requests one page after another until a page comes back short or empty.
  • Keywords (required): The search terms. Every term must match, for example shirt steamer.
  • Uses Rakuten's Product Search API, which returns XML.
  • See the Rakuten Advertising API reference for the response fields.

Creative Categories

Lists the link (creative) categories one partnered advertiser uses, with category ID and name. Use the IDs to filter Text Links and Banner Links.

  • Calls GET /linklocator/1.0/getCreativeCategories/{Advertiser ID (MID)}.
  • Advertiser ID (MID) (required): The numeric advertiser ID (MID) of a partnered advertiser.
  • Uses Rakuten's Link Locator API, which returns XML.
  • See the Rakuten Advertising API reference for the response fields.

Text Links

Lists text links from partnered advertisers, with link ID and name, MID, category, click URL, landing URL, and start and end dates.

  • Calls GET /linklocator/1.0/getTextLinks/{Advertiser ID (MID)}/{Creative Category ID}/{Links Starting On or After}/{Links Ending On or After}/-1/{page}, where {page} is the page number.
  • Nexla requests one page after another until a page comes back short or empty.
  • Advertiser ID (MID) (required; default -1): The advertiser ID (MID) of a partnered advertiser, or -1 for all partnered advertisers.
  • Creative Category ID (required; default -1): A category ID from Creative Categories, or -1 for all categories.
  • Links Starting On or After (required; default 01012000): Only links that start on or after this date (MMDDYYYY).
  • Links Ending On or After (required; default {now}): Only links that end on or after this date (MMDDYYYY); default today, so expired links are left out.
  • Dates use the MMddyyyy format. Uses Rakuten's Link Locator API, which returns XML.
  • See the Rakuten Advertising API reference for the response fields.

Banner Links

Lists banner links from partnered advertisers, with link ID and name, size, image URL, click URL, landing URL, and start and end dates.

  • Calls GET /linklocator/1.0/getBannerLinks/{Advertiser ID (MID)}/{Creative Category ID}/{Links Starting On or After}/{Links Ending On or After}/{Banner Size Code}/-1/{page}, where {page} is the page number.
  • Nexla requests one page after another until a page comes back short or empty.
  • Advertiser ID (MID) (required; default -1): The advertiser ID (MID) of a partnered advertiser, or -1 for all partnered advertisers.
  • Creative Category ID (required; default -1): A category ID from Creative Categories, or -1 for all categories.
  • Links Starting On or After (required; default 01012000): Only links that start on or after this date (MMDDYYYY).
  • Links Ending On or After (required; default {now}): Only links that end on or after this date (MMDDYYYY); default today, so expired links are left out.
  • Banner Size Code (required; default -1): A banner size code from Rakuten's Link Locator guide, or -1 for all sizes.
  • Dates use the MMddyyyy format. Uses Rakuten's Link Locator API, which returns XML.
  • See the Rakuten Advertising API reference for the response fields.

Generate Deep Link

Turns the URL of a product or landing page on a partnered advertiser's site into your affiliate tracking link. It creates no data in your account.

  • Calls POST /v1/links/deep_links.
  • Product URL (required): Product or landing page URL on the advertiser's site.
  • Advertiser ID (MID) (required): The numeric advertiser ID (MID) of a partnered advertiser.
  • u1 Tracking Value (optional): An optional value, such as a click or user ID, that Rakuten reports back on transactions from this link as u1.
  • The advertiser must allow deep links. Get Advertiser shows whether it does.
  • See the Rakuten Advertising API reference for the response fields.

Payment reports​

These templates use the Advanced Reports API and need the Web Security Token (Advanced Reports) in the credential.

Payment History Summary

Lists the payments Rakuten Advertising made to you in a date window, with payment ID, date, amount, and currency. The default window is the last 365 days.

  • Calls GET /advancedreports/1.0 with report ID 1 (payment history summary).
  • Returns the report as a CSV file, which Nexla parses into records. Needs the Web Security Token (Advanced Reports) in the credential; without it, Rakuten returns an error. Rakuten allows 500 Advanced Reports calls per day.
  • Start Date (required; default {now-365}): The report start date, in yyyyMMdd format. A report can cover at most 365 days.
  • End Date (required; default {now}): Report end date, YYYYMMDD.
  • See the Rakuten Advertising API reference for the response fields.

Advertiser Payments in a Payment

Breaks one payment down by advertiser, with advertiser, invoice ID, and commission amounts.

  • Calls GET /advancedreports/1.0 with report ID 22 (advertiser payment history).
  • Returns the report as a CSV file, which Nexla parses into records. Needs the Web Security Token (Advanced Reports) in the credential; without it, Rakuten returns an error. Rakuten allows 500 Advanced Reports calls per day.
  • Payment ID (required): The payment ID. Use Payment History Summary to find it.
  • See the Rakuten Advertising API reference for the response fields.

Payment Details by Invoice

Returns the order-level details of one advertiser invoice, with order ID, transaction date, and sale and commission amounts.

  • Calls GET /advancedreports/1.0 with report ID 23 (payment details).
  • Returns the report as a CSV file, which Nexla parses into records. Needs the Web Security Token (Advanced Reports) in the credential; without it, Rakuten returns an error. Rakuten allows 500 Advanced Reports calls per day.
  • Invoice ID (required): The invoice ID. Use Advertiser Payments in a Payment to find it.
  • See the Rakuten Advertising API reference for the response fields.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration​

Rakuten Advertising data sources can also be manually configured to ingest data from any valid Rakuten Advertising API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Rakuten Advertising data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.