Data Reference

What data you receive from Sync As A Service.

Data Format

We provide line-item level purchase data — each product/SKU is a separate record with its order context. Available as JSON (API) or CSV (export).

Fields

Field	Description	Example
Retailer	Retailer name	Amazon
Retailer Order ID	Retailer's order number	112-3456789-0123456
Order Date	Purchase date (ISO 8601)	2024-12-05T14:20:00Z
Item Name	Product name/title	Organic Dog Food - 30lb
Brand	Product brand	PetNature
Dept	Department/group	Pet Supplies
Category	Product category	Dog Food
SubCategory	Product sub-category	Dry Food
SKU	Retailer's product identifier	B0DGJ7HYG1 (Amazon ASIN)
Quantity	Units purchased	1
Price	Unit price	45.99
Currency	Currency code	USD
Shipment Status	Human-readable delivery status	Delivered Dec 8
Order Total	Total order amount	45.99

Each record = one item/SKU. Multi-item orders appear as multiple records sharing the same Retailer Order ID.

---

CSV Export

Request CSV format via the API:

GET /sync/orders?format=csv

Returns a downloadable file:

Retailer,Retailer Order ID,Order Date,Item Name,Brand,Dept,Category,SubCategory,SKU,Quantity,Price,Currency,Shipment Status,Order Total
Amazon,112-3456789-0123456,2024-12-05T14:20:00Z,"Organic Dog Food - Chicken & Rice 30lb",PetNature,Pet Supplies,Dog Food,Dry Food,B0DGJ7HYG1,1,45.99,USD,"Delivered Dec 8",45.99
Amazon,112-3456789-0123456,2024-12-05T14:20:00Z,Stainless Steel Dog Bowl,PawPerfect,Pet Supplies,Feeding,Bowls,B09Y987654,1,12.99,USD,"Delivered Dec 8",12.99
Walmart,456-1234567-8901234,2024-12-01T16:30:00Z,Stainless Steel Water Bottle,HydroMax,Kitchen,Drinkware,,001234567890,2,7.99,USD,"Delivered Dec 3",15.98

---

JSON Response

The API returns the same data as JSON by default:

[
  {
    "retailerName": "Amazon",
    "retailerOrderId": "112-3456789-0123456",
    "orderDate": "2024-12-05T14:20:00Z",
    "total": 45.99,
    "currency": "USD",
    "shipmentStatus": "delivered",
    "shipmentText": "Delivered Dec 8",
    "items": [
      {
        "name": "Organic Dog Food - Chicken & Rice 30lb",
        "quantity": 1,
        "price": 45.99,
        "sku": "B0DGJ7HYG1",
        "brandName": "PetNature",
        "department": "Pet Supplies",
        "category": "Dog Food",
        "subCategory": "Dry Food"
      }
    ]
  }
]

See API Reference for query parameters (filtering by retailer, date range, pagination).

---

Field Availability

Not all fields are guaranteed for every record:

Field	Availability
Retailer	Always
Order Date	Always
Item Name	Usually (~95%)
Price	Usually (~90%)
Brand	Often (~70%)
SKU	Often (~70%)
Dept / Category	Often (~60%)
Shipment Status	Often (~60%)

---

Retailer Data

Connected retailer accounts (from /sync/connections):

{
  "displayName": "Amazon",
  "logo": "https://media.brandclub.com/retailer_logo/1.webp",
  "status": "valid",
  "lastSyncAt": "2024-12-09T10:30:00Z"
}

Connection Statuses:

Status	Meaning	User Action
valid	Connected and working	Can sync
invalid	Credentials expired or incorrect	Needs reconnect
pending	Currently validating	Wait

---

Supported Retailers

Currently supported:

• Amazon (including Amazon Fresh, Whole Foods)

• Walmart

• Target

• Costco

• Kroger (and family: Fred Meyer, Ralphs)

• Safeway (and Albertsons family)

• Best Buy

• Home Depot

• Sephora

• Chewy

• PetSmart

15+ retailers with more being added regularly.

---

Personally Identifiable Information (PII)

What's Included

Minimal PII:

• User's name (if available)

• Phone number (for authentication only)

• Email (if available)

Not Included

• Credit card numbers

• Billing or shipping addresses

• Payment methods

• Recipient information

---

Data Freshness

• Initial sync: Within minutes of connection

• Recurring sync: Every 24 hours

• Manual sync: On-demand via API

• Historical data: Up to 12 months (retailer-dependent)

---

Example Use Cases

Rewards & Loyalty:

// Award points for qualifying purchases
orders.forEach((order) => {
  order.items.forEach((item) => {
    if (qualifyingBrands.includes(item.brandName)) {
      awardPoints(user, item.price * item.quantity * 10);
    }
  });
});

Purchase Verification:

// Validate purchase for rebate/reimbursement
const qualifying = orders.some(
  (order) =>
    order.items.some((item) => item.sku === targetSku) &&
    order.shipmentStatus === "delivered"
);

Spending Analytics:

// Categorize spending by department
const deptSpend = orders.reduce((acc, order) => {
  order.items.forEach((item) => {
    const dept = item.department || "Other";
    acc[dept] = (acc[dept] || 0) + item.price * item.quantity;
  });
  return acc;
}, {});

Aggregating to Order Level

If you need order-level totals, group by retailerOrderId:

const orderGroups = orders.reduce((acc, order) => {
  const id = order.retailerOrderId;
  if (!acc[id]) {
    acc[id] = {
      retailerOrderId: id,
      retailerName: order.retailerName,
      orderDate: order.orderDate,
      items: [],
      total: 0,
    };
  }
  acc[id].items.push(...order.items);
  acc[id].total += order.total;
  return acc;
}, {});