LogoLogo
  • Overview
  • What Ads Can Project Agora Commerce Serve?
  • Integration
    • API Introduction
    • Integration Workflow
      • Integration Summary
      • Integration Steps
    • Syncing Data
      • Syncing Data Via File Protocols
    • Syncing Catalog & Products
      • Syncing Catalog and Products Via File
    • Syncing Order Data
      • Syncing Order Data Via API
    • Reporting Clicks and Impressions
    • Integration Checklist
  • Integration Guides
    • HTTP Persistence & Ad Caching
    • Reference
    • Requesting Ads (the "Context" and its Parts)
    • Product Listing Ad Integration Guide
      • Requesting a Category Product Ad
      • Requesting a Search Term Product Ad
      • Requesting a Home Page Product Ad
    • Discovery Product Listing Ad Integration Guide
      • Requesting a Discovery Product Ad
    • Banner Ad Integration Guide
      • Banner Ad Content Standard
      • Requesting a Search Term Banner Ad
      • Requesting a Category Banner Ad
      • Requesting a Home Page Banner Ad
      • The Post Checkout Banner Ad Context
      • Graceful Fallback in the Event That No Ads Are Displayed
    • Banner X Ad Integration Guide
      • Banner X Ad Content Standard
      • Requesting a Category Banner X Ad
      • Requesting a Search Term Banner X Ad
      • Requesting a Home Page Banner X Ad
      • Banner X Ad Reference
      • Graceful Fallback in the Event That No Ads Are Displayed
Powered by GitBook
On this page
  • Why Sync Order Data
  • Order Attribution
  1. Integration

Syncing Order Data

Why Sync Order Data

Project Agora Commerce requires order data generate relevant ads and to disburse money properly to all entities involved in transactions (disbursement occurs only in the case of discounts. Project Agora Commerce charges only for impressions and clicks.).

Syncing orders is also valuable for advertiser and retailer dashboards in the Project Agora Commerce portal. Orders are used in sales, conversion, sale value and ROAS calculations. These are invaluable for advertiser teams to gauge their investment worth, and contribute additional spend.

Order Attribution

It's necessary that an explicit association between a single order item and a single ad id can be provided. The attribution responsibility on the integrator.

The below step is followed each time a new order is created. The integrator is required to store the adId relevant to each product ordered until the order is submitted. In an API push, the field is within the individual product's . orderItems object:

  "orderItems": [
            {
                  "gtin": "catpref--123456", 
                  "quantity": 3,
                  "regularUnitPrice": "9.99",
                  "totalOrderItemPriceAfterDiscounts": "9.99",
                  "adId": "display_zeowj3jV8VRxB1w_iEPy_upxFPc5ODkxNTY2UA=="                
                }
              ]

The quantity field should contain the quantity of the product that was ordered, and the reqularUnitPrice and totalOrderItemPriceAfterDiscounts should contain both the final price of the product as exists in the product feed.

The gtin field in orderItems element above is the <pa_id> of this product

The adId field contains the id which is returned as a response when requesting a Sponsored Product Listing, Discovery Product Listing, or a Banner ad

PreviousSyncing Catalog and Products Via FileNextSyncing Order Data Via API

Last updated 4 years ago