Advance Auto Parts · Schema

LoyaltyTransaction

A Speed Perks points transaction.

AutomotiveE-CommerceParts CatalogRetailSupply ChainFortune 500

Properties

Name Type Description
id string Transaction ID.
type string Transaction type.
points integer Points earned or redeemed.
description string Transaction description.
date string Transaction date.
View JSON Schema on GitHub

JSON Schema

commerce-api-loyaltytransaction-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "LoyaltyTransaction",
  "description": "A Speed Perks points transaction.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Transaction ID.",
      "example": "txn-001"
    },
    "type": {
      "type": "string",
      "description": "Transaction type.",
      "enum": [
        "earn",
        "redeem",
        "expire",
        "adjust"
      ]
    },
    "points": {
      "type": "integer",
      "description": "Points earned or redeemed.",
      "example": 100
    },
    "description": {
      "type": "string",
      "description": "Transaction description."
    },
    "date": {
      "type": "string",
      "format": "date-time",
      "description": "Transaction date."
    }
  }
}