developers
esc

Popular

↑ ↓ navigate↵ openAgents: llms.txt

Core APIOrders

Get order details

gethttps://core-api.ancon.io/api/v1/Outlets/{outletId}/Orders/{id}
View .mdOpenAPI

Authorization

  • Access-Tokenheaderrequired

    Tenant- or outlet-level token from the backoffice. See Get started.

Path parameters

  • outletIdstring (uuid)required
  • idstring (uuid)required

Header parameters

  • correlationIdstring

    Correlation Id for the request

Responses

200OKapplication/json
  • orderobject | null
    43 fields in order
    • idstring (uuid)
    • createdstring (date-time)
    • orderFormatsinteger (int32)

      Allowed values: 0, 1, 2, 4, 8, 16, 32, 64, 128, 159, 191.

    • statusinteger (int32)

      Allowed values: 0, 1, 2, 3.

    • refundedAtstring (date-time) | null
    • customerobject | null
      5 fields in customer
      • emailstring | null
      • customerIdstring (uuid) | null
      • namestring | null
      • phonestring | null
      • addressobject | null
        6 fields in address
        • streetstring | null
        • zipCodestring | null
        • citystring | null
        • statestring | null
        • countrystring | null
        • locationobject | null
          2 fields in location
          • latitudenumber (double)
          • longitudenumber (double)
    • deliveryobject | null
      3 fields in delivery
      • addressobject | null
        6 fields in address
        • streetstring | null
        • zipCodestring | null
        • citystring | null
        • statestring | null
        • countrystring | null
        • locationobject | null
          2 fields in location
          • latitudenumber (double)
          • longitudenumber (double)
      • phonestring | null
      • recipientstring | null
    • totalAmountobject | null

      Order total (include tax) This amount includes modifications. This amount includes fees. This amount is calculated from SubtotalInclTax + FeeAmountInclTax This amount is what must be paid or refunded to complete the order.

      2 fields in totalAmount
      • amountnumber (double)
      • currencystring | null
    • taxAmountobject | null

      Order total tax.

      2 fields in taxAmount
      • amountnumber (double)
      • currencystring | null
    • subtotalInclTaxobject | null

      Order sub total (include tax). This amount is calculated from OrderItem.TotalPriceInclTax

      2 fields in subtotalInclTax
      • amountnumber (double)
      • currencystring | null
    • subtotalExclTaxobject | null

      Order sub total (exclude tax). This amount is calculated from OrderItem.TotalPriceExclTax

      2 fields in subtotalExclTax
      • amountnumber (double)
      • currencystring | null
    • subTotalDiscountInclTaxobject | null

      Gets the order subtotal discount (include tax) This amount is calculated from OrderItem.DiscountAmountInclTax

      2 fields in subTotalDiscountInclTax
      • amountnumber (double)
      • currencystring | null
    • subTotalDiscountExclTaxobject | null

      Gets the order subtotal discount (exclude tax) This amount is calculated from OrderItem.DiscountAmountExclTax

      2 fields in subTotalDiscountExclTax
      • amountnumber (double)
      • currencystring | null
    • feeAmountInclTaxobject | null

      Gets the total fee amount (include tax) This amount is calculated from OrderFee.AmountInclTax

      2 fields in feeAmountInclTax
      • amountnumber (double)
      • currencystring | null
    • feeAmountExclTaxobject | null

      Gets the total fee amount (exclude tax) This amount is calculated from OrderFee.AmountExclTax

      2 fields in feeAmountExclTax
      • amountnumber (double)
      • currencystring | null
    • discountobject | null
      2 fields in discount
      • idstring (uuid) | null
      • namestring | null
    • discountValueobject | null

      The applied discount value.

      2 fields in discountValue
      • valuenumber (double) | null
      • typeinteger (int32) | null

        Allowed values: 0, 1.

    • salesLocationobject | null

      Information about where this order was sold (table, bar etc.).

      2 fields in salesLocation
      • salesLocationIdstring (uuid) | null
      • typeinteger (int32)

        Allowed values: 0, 1, 2, 3.

    • sourcestring | null
    • saleSourceIdstring (uuid)
    • outletobject | null
      2 fields in outlet
      • idstring (uuid)
      • namestring | null
    • paymentsarray<object> | null
      21 fields in payments
      • idstring (uuid)
      • createdstring (date-time)
      • orderIdstring (uuid)
      • amountobject | null
        2 fields in amount
        • amountnumber (double)
        • currencystring | null
      • cashBackAmountobject | null
        2 fields in cashBackAmount
        • amountnumber (double)
        • currencystring | null
      • roundingAmountobject | null
        2 fields in roundingAmount
        • amountnumber (double)
        • currencystring | null
      • tipAmountobject | null
        2 fields in tipAmount
        • amountnumber (double)
        • currencystring | null
      • paymentMethodobject | null
        3 fields in paymentMethod
        • idstring | null
        • typeinteger (int32)

          Allowed values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23.

        • displayNamestring | null
      • ourReferencestring (uuid)
      • externalReferencestring | null
      • externalIdentifierstring | null
      • clientIdstring (uuid) | null
      • tenantUserIdstring (uuid) | null
      • externalTimeStampstring (date-time) | null
      • integrationTypeinteger (int32)

        Allowed values: 1, 2.

      • statusinteger (int32)

        Allowed values: 0, 1, 2, 3, 4.

      • centralControlUnitSerialstring | null
      • invoiceReferenceNotestring | null
      • invoiceHandlingStatusinteger (int32) | null

        Allowed values: 1, 2, 4, 8.

      • refundsarray<object> | null
        7 fields in refunds
        • idstring (uuid)
        • refundedAtstring (date-time) | null
        • refundAmountobject | null
          2 fields in refundAmount
          • amountnumber (double)
          • currencystring | null
        • roundingAmountobject | null
          2 fields in roundingAmount
          • amountnumber (double)
          • currencystring | null
        • paymentIdstring (uuid)
        • statusinteger (int32)

          Allowed values: 0, 1, 2, 3, 4.

        • refundReferencestring (uuid)
      • mewsInfoany | null
    • itemsarray<object> | null
      21 fields in items
      • idstring (uuid)
      • productobject | null
        9 fields in product
        • productIdstring (uuid)
        • productNamestring | null
        • productTypeinteger (int32)

          Allowed values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10.

        • variantIdstring (uuid)
        • variantNamestring | null
        • hasVariantsboolean
        • productGroupIdstring (uuid)
        • productGroupNamestring | null
        • useBasePriceboolean
      • quantitynumber (double)
      • unitQuantitynumber (double)
      • unitobject | null
        2 fields in unit
        • namestring | null
        • typeinteger (int32)

          Allowed values: 0, 1, 2, 3.

      • productPriceInclTaxobject | null
        2 fields in productPriceInclTax
        • unitPriceobject | null
          2 fields in unitPrice
          • amountnumber (double)
          • currencystring | null
        • additionalPriceobject | null
          2 fields in additionalPrice
          • amountnumber (double)
          • currencystring | null
      • productPriceExclTaxobject | null
        2 fields in productPriceExclTax
        • unitPriceobject | null
          2 fields in unitPrice
          • amountnumber (double)
          • currencystring | null
        • additionalPriceobject | null
          2 fields in additionalPrice
          • amountnumber (double)
          • currencystring | null
      • productMaterialCostExclTaxobject | null
        2 fields in productMaterialCostExclTax
        • unitPriceobject | null
          2 fields in unitPrice
          • amountnumber (double)
          • currencystring | null
        • additionalPriceobject | null
          2 fields in additionalPrice
          • amountnumber (double)
          • currencystring | null
      • totalPriceInclTaxobject | null
        2 fields in totalPriceInclTax
        • amountnumber (double)
        • currencystring | null
      • totalPriceExclTaxobject | null
        2 fields in totalPriceExclTax
        • amountnumber (double)
        • currencystring | null
      • totalMaterialCostExclTaxobject | null
        2 fields in totalMaterialCostExclTax
        • amountnumber (double)
        • currencystring | null
      • discountAmountInclTaxobject | null
        2 fields in discountAmountInclTax
        • amountnumber (double)
        • currencystring | null
      • discountAmountExclTaxobject | null
        2 fields in discountAmountExclTax
        • amountnumber (double)
        • currencystring | null
      • taxesarray<object> | null
        2 fields in taxes
        • typeinteger (int32)

          Allowed values: 1, 2.

        • ratenumber (double)
      • modificationsarray<object> | null
        12 fields in modifications
        • modificationstring | null
        • ingredientIdstring (uuid) | null
        • namestring | null
        • replaceIdstring (uuid) | null
        • replacementNamestring | null
        • addOnGroupIdstring (uuid) | null
        • addOnGroupNamestring | null
        • quantitynumber (double)
        • freeAmountnumber (double)
        • costnumber (double)
        • totalCostnumber (double)
        • positioninteger (int32)
      • addOnProductsarray<object> | null
        19 fields in addOnProducts
        • idstring (uuid)
        • productobject | null
          9 fields in product
          • productIdstring (uuid)
          • productNamestring | null
          • productTypeinteger (int32)

            Allowed values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10.

          • variantIdstring (uuid)
          • variantNamestring | null
          • hasVariantsboolean
          • productGroupIdstring (uuid)
          • productGroupNamestring | null
          • useBasePriceboolean
        • quantitynumber (double)
        • unitQuantitynumber (double)
        • unitobject | null
          2 fields in unit
          • namestring | null
          • typeinteger (int32)

            Allowed values: 0, 1, 2, 3.

        • productPriceInclTaxobject | null
          2 fields in productPriceInclTax
          • unitPriceobject | null
            2 fields in unitPrice
            • amountnumber (double)
            • currencystring | null
          • additionalPriceobject | null
            2 fields in additionalPrice
            • amountnumber (double)
            • currencystring | null
        • productPriceExclTaxobject | null
          2 fields in productPriceExclTax
          • unitPriceobject | null
            2 fields in unitPrice
            • amountnumber (double)
            • currencystring | null
          • additionalPriceobject | null
            2 fields in additionalPrice
            • amountnumber (double)
            • currencystring | null
        • productMaterialCostExclTaxobject | null
          2 fields in productMaterialCostExclTax
          • unitPriceobject | null
            2 fields in unitPrice
            • amountnumber (double)
            • currencystring | null
          • additionalPriceobject | null
            2 fields in additionalPrice
            • amountnumber (double)
            • currencystring | null
        • totalPriceInclTaxobject | null
          2 fields in totalPriceInclTax
          • amountnumber (double)
          • currencystring | null
        • totalPriceExclTaxobject | null
          2 fields in totalPriceExclTax
          • amountnumber (double)
          • currencystring | null
        • totalMaterialCostExclTaxobject | null
          2 fields in totalMaterialCostExclTax
          • amountnumber (double)
          • currencystring | null
        • discountAmountInclTaxobject | null
          2 fields in discountAmountInclTax
          • amountnumber (double)
          • currencystring | null
        • discountAmountExclTaxobject | null
          2 fields in discountAmountExclTax
          • amountnumber (double)
          • currencystring | null
        • taxesarray<object> | null
          2 fields in taxes
          • typeinteger (int32)

            Allowed values: 1, 2.

          • ratenumber (double)
        • discountobject | null
          2 fields in discount
          • valuenumber (double) | null
          • typeinteger (int32) | null

            Allowed values: 0, 1.

        • statusinteger (int32) | null

          Allowed values: 0, 1, 2, 3.

        • addOnGroupIdstring (uuid)
        • addOnGroupNamestring | null
        • addOnFreeAmountnumber (double)
      • discountobject | null
        2 fields in discount
        • valuenumber (double) | null
        • typeinteger (int32) | null

          Allowed values: 0, 1.

      • statusinteger (int32) | null

        Allowed values: 0, 1, 2, 3.

      • soldAtstring (date-time)
      • refundsarray<object> | null
        5 fields in refunds
        • idstring (uuid)
        • quantitynumber (double)
        • statusinteger (int32)

          Allowed values: 0, 1, 2, 3.

        • refundReferencestring (uuid)
        • orderItemIdstring (uuid)
      • itemsarray<object> | null
    • feesarray<object> | null
      5 fields in fees
      • feeIdstring (uuid)
      • feeNamestring | null
      • amountInclTaxobject | null
        2 fields in amountInclTax
        • amountnumber (double)
        • currencystring | null
      • amountExclTaxobject | null
        2 fields in amountExclTax
        • amountnumber (double)
        • currencystring | null
      • taxesarray<object> | null
        2 fields in taxes
        • typeinteger (int32)

          Allowed values: 1, 2.

        • ratenumber (double)
    • voucherBasisIdstring (uuid) | null
    • incrementalNumbersobject | null
      4 fields in incrementalNumbers
      • ticketNumberinteger (int64) | null

        Unique number per outlet per Z-Report, it will reset when a Z-Report is made and start on 1 again. Used alot in the UI to give a simple to read number, will also be printed on tickets.

      • serialNumberinteger (int64) | null

        Unbroken sequence per outlet which statisfies the needs of certain pos system laws, is only used on Checks.

      • referenceNumberinteger (int64) | null

        Unbroken sequence per outlet which is used for all types of sales. Suitable for correlation between systems.

      • refundSerialNumberinteger (int64) | null

        Uses same series as SerialNumber and is set on orders which is refunded.

    • fromTypeinteger (int32)

      Allowed values: 0, 1.

    • fromTypeCreatedstring (date-time)
    • createdCheckTenantUserIdstring (uuid) | null

      The tenant user id of who created the check this order was created from.

    • closedCheckTenantUserIdstring (uuid) | null

      Tenant user id of who closed the check this order was created from.

    • createdCheckClientIdstring (uuid) | null
    • closedCheckClientIdstring (uuid) | null
    • ticketedAtstring (date-time) | null

      The time this order was ticketed.

    • soldAtstring (date-time)

      The time when this order was sold. When something is sold is different if the order comes from check or checkout. Check: The last time an item was ticketed or if no tickets then it will be when the order was created. Checkout: The time the order was created.

    • checkoutAuthorizedAtstring (date-time) | null
    • checkoutServiceTimeobject | null

      Service time for the sale. No time is needed for Kind.AsSoonAsPossible it will be set as current UTC time on server side.

      2 fields in checkoutServiceTime
      • kindinteger (int32)

        Allowed values: 0, 1, -1.

      • timestring (date-time) | null
    • ticketClosedAtstring (date-time) | null
    • companyInfoobject | null
      7 fields in companyInfo
      • companyIdstring (uuid) | null
      • companyNamestring | null
      • companyBusinessNumberstring | null
      • addressobject | null
        4 fields in address
        • streetstring | null
        • street2string | null
        • zipCodestring | null
        • citystring | null
      • invoiceEmailstring | null
      • memberIdstring (uuid) | null
      • memberNamestring | null
    • metaDataarray<object> | null
      2 fields in metaData
      • metaDataany | null

        Rename for next version to Metadata

      • metaDataTypestring | null
    • guestGroupIdstring (uuid) | null
    • orderTypeinteger (int32)

      Allowed values: 0, 1, 2, 3, 4, 5.

    • parentOrderIdstring (uuid) | null
    • customNamestring | null
401Unauthorizedapplication/json
  • messagestring | null
404Not Foundapplication/json
  • messagestring | null
  • errorCodestring (uuid)