Swell · Schema

Swell Order

CommerceHeadless CommerceAPI-FirstB2CB2BSubscriptionsMarketplacesWholesaleStorefrontCheckoutPaymentsCartsOrdersCatalogInternationalization

Properties

Name Type Description
id string
number string Sequential, human-readable order number.
account_id string
status string
items array
billing object
shipping object
sub_total number
discount_total number
tax_total number
shipment_total number
grand_total number
payment_balance number
paid boolean
delivered boolean
refunded boolean
canceled boolean
coupon_code string
giftcards array
comments string
metadata object
test boolean
currency string
date_created string
date_updated string
View JSON Schema on GitHub

JSON Schema

swell-order-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/swell-io/main/json-schema/swell-order-schema.json",
  "title": "Swell Order",
  "type": "object",
  "properties": {
    "id": { "type": "string", "pattern": "^[a-f0-9]{24}$" },
    "number": { "type": "string", "description": "Sequential, human-readable order number." },
    "account_id": { "type": "string" },
    "status": {
      "type": "string",
      "enum": ["pending", "draft", "payment_pending", "delivery_pending", "hold", "complete", "canceled"]
    },
    "items": { "type": "array", "items": { "type": "object" } },
    "billing": { "type": "object" },
    "shipping": { "type": "object" },
    "sub_total": { "type": "number" },
    "discount_total": { "type": "number" },
    "tax_total": { "type": "number" },
    "shipment_total": { "type": "number" },
    "grand_total": { "type": "number" },
    "payment_balance": { "type": "number" },
    "paid": { "type": "boolean" },
    "delivered": { "type": "boolean" },
    "refunded": { "type": "boolean" },
    "canceled": { "type": "boolean" },
    "coupon_code": { "type": "string" },
    "giftcards": { "type": "array", "items": { "type": "object" } },
    "comments": { "type": "string" },
    "metadata": { "type": "object" },
    "test": { "type": "boolean" },
    "currency": { "type": "string" },
    "date_created": { "type": "string", "format": "date-time" },
    "date_updated": { "type": "string", "format": "date-time" }
  }
}