Lightspeed Restaurant K Series API

1.0.0

Body Required

• reason string

  Reason for failure if there is one

• thirdPartyReference string

  Third-party reference you provided when the order or payment was placed.

• businessLocationId integer(int64)

  The unique identifier of the business location.

• ikentooAccountIdentifier string

  The K-series account identifier for a SUCCESS event (V3 format)

• iKentooAccountId integer(int64) Deprecated

  The K-series account identifier for a SUCCESS event (V2 format)

• status string

  Status of the order operation.

  Values are SUCCESS, FAILURE, IN_DELIVERY, READY_FOR_PICKUP, CLOSED, ABANDONED, or CANCELLED.

• type string

  Notification type

  Default value is ORDER.

• account object
  Hide account attributes Show account attributes

  • clientCount integer(int32)

    The number of guests at the table.

  • identifier string Deprecated
  • uuid string

    The account uuid.

  • openDate string(date-time)

    The date this account was opened in UTC.

  • closeDate string(date-time)

    The date this account was closed in UTC.

  • paidAmount number

    The total of all payments on the check.

  • serviceCharge number

    The service charge applied to the check.

  • name string

    The check name.

  • currentAmount number

    The current total amount on the check.

  • staffName string

    The name of the staff member assigned to the check.

  • staffId integer(int64)

    The unique ID of the staff member assigned to the check.

  • salesEntries array[object]

    Collection of check items.

    Hide salesEntries attributes Show salesEntries attributes object

    • id integer(int64)

      The unique ID assigned to the sale line.

    • uuid string

      The UUID assigned to the sale line.

    • itemName string

      The name given to the item.

    • itemSku string

      The SKU assigned to the item.

    • unitAmount number

      The price per unit.

    • quantity number(double)

      The quantity of the item for this sale line.

    • modifiers array[object]

      The modifiers of the item for this sale line

      Hide modifiers attributes Show modifiers attributes object

      • name string

        The name of the modifier.

      • quantity integer(int32)

        The quantity of the modifier.

    • amountWithTax number

      The total price of the item including tax.

    • amountLessTax number

      The total price of the item without tax.

    • discountedAmount number

      The amount the item was discounted.

    • timeOfTransactionUtc string(date-time)

      The date and time in UTC when the transaction occurred.

    • active boolean Deprecated
    • parentId integer(int64)
    • subLineItems array[object]

      Collection of sub-line items associated with this sale line.
    • isTaxIncluded boolean
    • taxIncluded boolean

      Indicates whether tax is included in the unit amount.

  • paymentEntries array[object]

    Payments associated with this check.

    Hide paymentEntries attributes Show paymentEntries attributes object

    • paymentMethodDescription string

      Payment method for this payment line.

    • externalReference string

      Payment external reference.

    • paymentMethodCode string

      Payment method code for this payment line.

    • amountPaid number

      Amount paid for this payment line.

    • paymentDate string(date-time)

      Date/Time in UTC of this payment.

    • active boolean

      Whether this payment line is active or not.

    • accountCancelled boolean
  • id string Deprecated
  • ikaccountId string

    The system-generated account identifier for this check.(Applies to iKentoo V3+).

  • number integer(int32) Deprecated
  • tableNumber integer(int32)

    The table number assigned to the check.

  • posId integer(int64)

    The unique ID of the POS station that processed the check.

  • deviceId integer(int64) Deprecated