Order

An order placed against the vendor, with its money broken out by component. Every amount is in major units of currencyCode.

Fields

    code
    String!
    Required
    Human-readable order reference shown to the customer.
    createdAt
    DateTime!
    Required
    When the order was placed, in UTC.
    currencyCode
    String!
    Required
    ISO 4217 alphabetic currency code every amount is quoted in.
    deliveryAddressId
    Int

    Address the order is delivered to. null for pickup orders.

    deliveryFee
    Decimal!
    Required

    Delivery charge for this order. 0 for pickup.

    discount
    Decimal!
    Required
    Discount applied, as a positive amount subtracted from the total.
    id
    Int!
    Required
    Unique identifier of the order.
    note
    String
    Free-text note the customer left with the order.
    paymentStatus
    PaymentStatus!
    Required
    Where the order sits in its payment lifecycle.
    status
    OrderStatus!
    Required
    Where the order sits in its fulfilment lifecycle.
    subTotal
    Decimal!
    Required
    Sum of the line items before discount, tip, delivery and tax.
    tax
    Decimal!
    Required
    Tax charged on the order.
    tip
    Decimal!
    Required
    Tip added by the customer.
    total
    Decimal!
    Required

    Amount actually charged: sub_total - discount + tip + delivery_fee + tax.

    updatedAt
    DateTime!
    Required
    When the order was last changed, in UTC.
Built with