Swell · JSON Structure

Swell Order Structure

Type: object Properties: 19
CommerceHeadless CommerceAPI-FirstB2CB2BSubscriptionsMarketplacesWholesaleStorefrontCheckoutPaymentsCartsOrdersCatalogInternationalization

Swell Order Structure is a JSON Structure definition published by Swell, describing 19 properties. It conforms to the https://json-structure.org/meta/extended/v0/# meta-schema.

Properties

id number account_id status items billing shipping sub_total discount_total tax_total shipment_total grand_total payment_balance paid delivered refunded canceled currency date_created

Meta-schema: https://json-structure.org/meta/extended/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/extended/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/swell-io/main/json-structure/swell-order-structure.json",
  "title": "Swell Order",
  "type": "object",
  "properties": {
    "id": { "type": "string" },
    "number": { "type": "string" },
    "account_id": { "type": "string" },
    "status": { "type": "string" },
    "items": { "type": "array", "items": { "type": "object" } },
    "billing": { "type": "object" },
    "shipping": { "type": "object" },
    "sub_total": { "type": "decimal" },
    "discount_total": { "type": "decimal" },
    "tax_total": { "type": "decimal" },
    "shipment_total": { "type": "decimal" },
    "grand_total": { "type": "decimal" },
    "payment_balance": { "type": "decimal" },
    "paid": { "type": "boolean" },
    "delivered": { "type": "boolean" },
    "refunded": { "type": "boolean" },
    "canceled": { "type": "boolean" },
    "currency": { "type": "string" },
    "date_created": { "type": "string" }
  }
}