Order

public struct Order : Codable, Equatable

Struct representing Order related values.

  • id

    Value representing the entity id.

    Declaration

    Swift

    public var id: Int

  • Order Transaction Type.

    Declaration

    Swift

    public var transactionType: String

  • Order Transaction Date.

    Declaration

    Swift

    public var orderedAt: String

  • Order Preferred Receive Date.

    Declaration

    Swift

    public var preferredReceiveAt: String

  • Order Source Name.

    Declaration

    Swift

    public var sourceName: String

  • Order Status.

    Declaration

    Swift

    public var orderStatus: String

  • Order Integration Id.

    Declaration

    Swift

    public var integrationId: String

  • Order Place Integration Id.

    Declaration

    Swift

    public var placeIntegrationId: String

  • Order Terminal Name.

    Declaration

    Swift

    public var terminalName: String

  • Order Transaction ID.

    Declaration

    Swift

    public var transactionId: String

  • Order Business Date.

    Declaration

    Swift

    public var businessDate: String

  • Order Metric Name.

    Declaration

    Swift

    public var metricName: String

  • Order Metric Amount.

    Declaration

    Swift

    public var metricAmount: String

  • Order Currency.

    Declaration

    Swift

    public var currency: String

  • Order Eligible Subtotal.

    Declaration

    Swift

    public var eligibleSubtotal: String

  • Order Subtotal.

    Declaration

    Swift

    public var subtotal: String

  • Order Overall discount.

    Declaration

    Swift

    public var overallDiscount: String

  • Order Tip Amount.

    Declaration

    Swift

    public var tipAmount: String

  • Order Service Charge.

    Declaration

    Swift

    public var serviceCharge: String
  • tax

    Order Tax.

    Declaration

    Swift

    public var tax: String

  • Order Total Amount.

    Declaration

    Swift

    public var totalAmount: String

  • Order Created Date.

    Declaration

    Swift

    public var createdAt: String

  • Order Updated Date.

    Declaration

    Swift

    public var updatedAt: String

  • Order Item Count.

    Declaration

    Swift

    public var itemCount: Int

  • List of Order Item.

    Declaration

    Swift

    public var items: [Order.Item]

  • Order Overall Item Count.

    Declaration

    Swift

    public var overallItemCount: Int

  • Place of order.

    Declaration

    Swift

    public var place: Order.Place?

  • Undocumented

    Declaration

    Swift

    public init(id: Int, transactionType: String, orderedAt: String, preferredReceiveAt: String,
            sourceName: String, orderStatus: String, integrationId: String, placeIntegrationId: String,
            terminalName: String, transactionId: String, businessDate: String, metricName: String,
            metricAmount: String, currency: String, eligibleSubtotal: String, subtotal: String,
            overallDiscount: String, tipAmount: String, serviceCharge: String, tax: String,
            totalAmount: String, createdAt: String, updatedAt: String, itemCount: Int,
            items: [Order.Item], overallItemCount: Int, place: Order.Place?)

  • Struct representing Order Item related values.

    See more

    Declaration

    Swift

    public struct Item : Codable, Equatable

  • Place object specifically for Order object.

    Note

    This structure is different from the Place object in the Places Module, but its id property can be used to obtain a Place object from the API.
    See more

    Declaration

    Swift

    public struct Place : Codable, Equatable

  • Declaration

    Swift

    public init(from decoder: Decoder) throws