Order

The object exposed as order in every order-related email template (Invoices, Order received, Order shipped, Tracking number, Refund, Comment). Documented once here and referenced from each template page.

Fields

Field Type Notes
token string Order token (also the cart id).
email string Customer email.
mode string Live or Test.
status string Order status: InProgress, Processed, Disputed, Shipped, Delivered, Pending, Cancelled, Dispatched.
invoiceNumber string e.g. SNIP-1001.
creationDate datetime
modificationDate datetime
completionDate datetime
lang string Customer language.
ipAddress string
billingAddress Address
shippingAddress Address Optional.
shipToBillingAddress boolean
shippingInformation object Optional — { method, fees, provider }.
paymentMethod string Enum: CreditCard, WillBePaidLater, Other, …
paymentStatus string Optional: Paid, Deferred, PaidDeferred, ChargedBack, Refunded, Paidout, Pending, Failed, Expired, Cancelled, Open, Authorized.
card object Optional — { last4Digits, type, ownerName }.
paymentDetails object Optional. paymentDetails.display holds the label shown for Other payment methods.
summary Summary
items Item[]
discounts Discount[]
customFields CustomField[]
refunds Refund[]
taxes Tax[] Optional — order-level taxes, distinct from summary.taxes.
currency string
totalWeight number Optional.
total number
isRecurringInvoice boolean True for recurring subscription invoices.
metadata object Optional — merchant metadata.
subscriptionId guid Optional — the subscription this order belongs to (subscriptions only).
parentCartId string Optional — only set on recurring subscription invoices; the token of the original order.

Minimal example 

{
  "token": "b698211d-02bc-4745-8ea7-6f8330a53136",
  "email": "john.doe@example.com",
  "mode": "Live",
  "status": "Processed",
  "invoiceNumber": "SNIP-1001",
  "currency": "usd",
  "total": 120,
  "billingAddress": { "...": "see Address" },
  "items": [ { "...": "see Item" } ],
  "summary": { "...": "see Summary" }
}

Was this article helpful?