Advance Auto Parts · Schema

Order

A placed order.

AutomotiveE-CommerceParts CatalogRetailSupply ChainFortune 500

Properties

Name Type Description
id string Order identifier.
status string Current order status.
total number Order total.
createdAt string Order creation timestamp.
items array Items in the order.
View JSON Schema on GitHub

JSON Schema

commerce-api-order-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Order",
  "description": "A placed order.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Order identifier.",
      "example": "order-001"
    },
    "status": {
      "type": "string",
      "description": "Current order status.",
      "enum": [
        "pending",
        "processing",
        "shipped",
        "delivered",
        "cancelled"
      ]
    },
    "total": {
      "type": "number",
      "description": "Order total.",
      "example": 109.98
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Order creation timestamp."
    },
    "items": {
      "type": "array",
      "description": "Items in the order.",
      "items": {
        "$ref": "#/$defs/CartItem"
      }
    }
  }
}