Update check custom namedeprecated

puthttps://core-api.ancon.io/api/v1/Outlets/{outletId}/Checks/{checkId}/CustomName

View .md OpenAPI

Deprecated. Check the description for the replacement and sunset date, and see how deprecation works.

Will no longer work after 2028-09-01 00:00, move over to the V2 Check endpoints instead.

Authorization

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

Path parameters

outletIdstring (uuid)required
checkIdstring (uuid)required

Header parameters

correlationIdstring
Correlation Id for the request

Request body application/json

customNamestring | null

Responses

200OKapplication/json

checkobject | null
Public api 1.0 check. Third party integrations parse this shape and cannot be made to update, so it serializes exactly as it did before R18: the domain value objects (Money, CurrencyCode, DiscountInfo, CompanyInfo, CustomerInfo) go on the wire as they are. The current shape is served by public api v2.
41 fields in check
- idstring (uuid)
- createdstring (date-time)
- modifiedstring (date-time)
- outletobject | null
  2 fields in outlet
  - idstring (uuid)
  - namestring | null
- orderFormatinteger (int32)
  Allowed values: 0, 1, 2, 4, 8, 16, 32, 64, 128, 159, 191.
- orderTypeinteger (int32)
  Allowed values: 0, 1, 2, 3, 4, 5.
- saleSourceIdstring (uuid)
- discountValueobject | null
  2 fields in discountValue
  - valuenumber (double) | null
  - typeinteger (int32) | null
    Allowed values: 0, 1.
- discountCodeobject | null
  2 fields in discountCode
  - discountIdstring (uuid) | null
  - discountNamestring | null
- currencyobject | null
  1 field in currency
  - codestring | null
- salesLocationobject | null
  2 fields in salesLocation
  - salesLocationIdstring (uuid) | null
  - typeinteger (int32)
    Allowed values: 0, 1, 2, 3.
- 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
  - invoiceEmailobject | null
    1 field in invoiceEmail
    emailstring | null
  - memberIdstring (uuid) | null
  - memberNamestring | null
- deletedReasonstring | null
- createdCheckTenantUserIdstring (uuid)
- createdCheckTenantUserobject | null
  3 fields in createdCheckTenantUser
  - idstring (uuid)
  - nameobject | null
    2 fields in name
    firstNamestring | null
    lastNamestring | null
  - emailobject | null
    1 field in email
    emailstring | null
- closedCheckTenantUserIdstring (uuid) | null
- createdCheckClientIdstring (uuid)
- closedCheckClientIdstring (uuid) | null
- orderIdstring (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.
- collectionTicketIdstring (uuid) | null
- customTicketNumberinteger (int64) | null
- customNamestring | null
- deletedstring (date-time) | null
- guestCountinteger (int32) | null
- metaDataarray<object> | null
  Rename for next version to 'Metadata'
  6 fields in metaData
  - idstring (uuid)
  - createdstring (date-time)
  - modifiedstring (date-time)
  - checkIdstring (uuid)
  - checkItemIdstring (uuid) | null
    Rename for next version to string 'Reference'
  - metaDataany | null
    Rename for next version to 'Metadata'
- checkItemsarray<object> | null
  43 fields in checkItems
  - idstring (uuid)
  - checkIdstring (uuid) | null
  - createdstring (date-time)
  - modifiedstring (date-time)
  - productobject | null
    Restored 1.0 wire shape of Ancon.Wildcat.Shared OrderedProduct as it serializes in the production package (1.0.1200-alpha). The current package marks IsSystemProduct with [JsonIgnore], which would silently drop the field from the legacy payloads, so the raw value object cannot be serialized directly anymore. Frozen - do not change.
    
    20 fields in product
    glassesPerBottlenumber (double) | null
    hasVariantsboolean
    isSystemProductboolean
    localizedProductNamesobject | null
    1 field in localizedProductNames
    translationsmap<string, string> | null
    localizedVariantNamesobject | null
    1 field in localizedVariantNames
    translationsmap<string, string> | null
    positionobject | null
    1 field in position
    positioninteger (int32)
    productGroupIdstring (uuid)
    productGroupNamestring | null
    productIdstring (uuid)
    productNamestring | null
    productNumberstring | null
    productTypeinteger (int32)
    Allowed values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10.
    
    storageInfoobject | null
    2 fields in storageInfo
    temperatureinteger (int32)
    sizeobject | null
    3 fields in size
    heightinteger (int32)
    widthinteger (int32)
    lengthinteger (int32)
    subProductIdstring (uuid) | null
    subProductQuantityobject | null
    1 field in subProductQuantity
    valuenumber (double)
    useBasePriceboolean
    variantIdstring (uuid)
    variantNamestring | null
    variantNumberstring | null
    variantTypeinteger (int32)
    Allowed values: 0, 1, 2, 3, 4, 5, 6, 7.
  - quantityobject | null
    1 field in quantity
    valuenumber (double)
  - unitQuantityobject | null
    1 field in unitQuantity
    valuenumber (double)
  - unitobject | null
    2 fields in unit
    namestring | null
    typeinteger (int32)
    Allowed values: 0, 1, 2, 3.
  - pricePresetIdstring (uuid) | null
  - productPriceInclTaxobject | null
    2 fields in productPriceInclTax
    unitPriceobject | null
    2 fields in unitPrice
    amountnumber (double)
    currencyCodestring | null
    additionalPriceobject | null
    2 fields in additionalPrice
    amountnumber (double)
    currencyCodestring | null
  - productPriceExclTaxobject | null
    2 fields in productPriceExclTax
    unitPriceobject | null
    2 fields in unitPrice
    amountnumber (double)
    currencyCodestring | null
    additionalPriceobject | null
    2 fields in additionalPrice
    amountnumber (double)
    currencyCodestring | null
  - productMaterialCostExclTaxobject | null
    2 fields in productMaterialCostExclTax
    unitPriceobject | null
    2 fields in unitPrice
    amountnumber (double)
    currencyCodestring | null
    additionalPriceobject | null
    2 fields in additionalPrice
    amountnumber (double)
    currencyCodestring | null
  - kitchenMessagestring | null
  - discountInfoobject | null
    2 fields in discountInfo
    discountIdstring (uuid) | null
    discountNamestring | null
  - discountobject | null
    2 fields in discount
    valuenumber (double) | null
    typeinteger (int32) | null
    Allowed values: 0, 1.
  - courseNamestring | null
  - coursePositioninteger (int32)
  - checkPaymentIdstring (uuid) | null
  - paidAtstring (date-time) | null
  - tagstring | null
  - statusinteger (int32)
    Allowed values: 0, 1, 2, 4, 8, 16, 32.
  - upsellGroupIdstring (uuid) | null
  - ticketedAtstring (date-time) | null
  - ticketedTenantUserIdstring (uuid) | null
  - modificationsarray<object> | null
    5 fields in modifications
    idstring (uuid)
    createdstring (date-time)
    modifiedstring (date-time)
    checkItemIdstring (uuid)
    modificationobject | null
    Restored 1.0 wire shape of Ancon.Wildcat.Shared ProductModification as it serializes in the production package (1.0.1200-alpha), where Cost and MaterialCost are Money objects. The current package flattened them to decimals, so the raw value object cannot be serialized directly anymore. Frozen - do not change.
    
    9 fields in modification
    addOnGroupobject | null
    3 fields in addOnGroup
    idstring (uuid)
    namestring | null
    localizedCustomerFacingNamesobject | null
    costobject | null
    2 fields in cost
    amountnumber (double)
    currencyCodestring | null
    freeAmountobject | null
    1 field in freeAmount
    valuenumber (double)
    ingredientobject | null
    3 fields in ingredient
    idstring (uuid)
    nameobject | null
    localizedNamesobject | null
    materialCostobject | null
    2 fields in materialCost
    amountnumber (double)
    currencyCodestring | null
    modificationstring | null
    positionobject | null
    1 field in position
    positioninteger (int32)
    quantityobject | null
    1 field in quantity
    valuenumber (double)
    replacementobject | null
    3 fields in replacement
    idstring (uuid)
    nameobject | null
    localizedNamesobject | null
  - isTaxMandatoryboolean
  - taxesarray<object> | null
    4 fields in taxes
    idstring (uuid)
    createdstring (date-time)
    modifiedstring (date-time)
    taxobject | null
    2 fields in tax
    taxIdstring (uuid)
    taxValueobject | null
    2 fields in taxValue
    typeinteger (int32)
    Allowed values: 1, 2.
    
    ratenumber (double)
  - checkItemsarray<object> | null
  - parentItemIdstring (uuid) | null
  - isMultiproductboolean
  - hasOwnPriceboolean
  - priceInclTaxobject | null
    2 fields in priceInclTax
    amountnumber (double)
    currencystring | null
  - priceExclTaxobject | null
    2 fields in priceExclTax
    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
  - totalDiscountAmountInclTaxobject | null
    2 fields in totalDiscountAmountInclTax
    amountnumber (double)
    currencystring | null
  - totalDiscountAmountExclTaxobject | null
    2 fields in totalDiscountAmountExclTax
    amountnumber (double)
    currencystring | null
  - modificationPriceInclTaxobject | null
    2 fields in modificationPriceInclTax
    amountnumber (double)
    currencystring | null
  - modificationPriceExclTaxobject | null
    2 fields in modificationPriceExclTax
    amountnumber (double)
    currencystring | null
  - isPrepaidboolean
- paymentsarray<object> | null
  21 fields in payments
  - idstring (uuid)
  - createdstring (date-time)
  - modifiedstring (date-time)
  - paymentTypeinteger (int32)
    Allowed values: 1, 2, 3.
  - 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
  - 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
  - tenantUserIdstring (uuid)
  - externalReferencestring | null
  - externalIdentifierstring | null
  - externalTimeStampstring (date-time) | null
  - statusinteger (int32)
    Allowed values: 0, 1, 2, 3, 4, 5, -1.
  - errorTypeinteger (int32) | null
    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, 24, 25, 26, -1.
  - terminalobject | null
    2 fields in terminal
    idstring (uuid)
    namestring | null
  - clientobject | null
    2 fields in client
    idstring (uuid)
    namestring | null
  - centralControlUnitSerialstring | null
  - receiptsarray<object> | null
    3 fields in receipts
    receiverTypeinteger (int32)
    Allowed values: 1, 2.
    
    needsSignatureboolean
    receiptTextsarray<object> | null
    3 fields in receiptTexts
    keystring | null
    valuestring | null
    namestring | null
  - invoiceReferenceNotestring | null
  - isReceiptPrintedboolean
- allCheckItemsarray<object> | null
  43 fields in allCheckItems
  - idstring (uuid)
  - checkIdstring (uuid) | null
  - createdstring (date-time)
  - modifiedstring (date-time)
  - productobject | null
    Restored 1.0 wire shape of Ancon.Wildcat.Shared OrderedProduct as it serializes in the production package (1.0.1200-alpha). The current package marks IsSystemProduct with [JsonIgnore], which would silently drop the field from the legacy payloads, so the raw value object cannot be serialized directly anymore. Frozen - do not change.
    
    20 fields in product
    glassesPerBottlenumber (double) | null
    hasVariantsboolean
    isSystemProductboolean
    localizedProductNamesobject | null
    1 field in localizedProductNames
    translationsmap<string, string> | null
    localizedVariantNamesobject | null
    1 field in localizedVariantNames
    translationsmap<string, string> | null
    positionobject | null
    1 field in position
    positioninteger (int32)
    productGroupIdstring (uuid)
    productGroupNamestring | null
    productIdstring (uuid)
    productNamestring | null
    productNumberstring | null
    productTypeinteger (int32)
    Allowed values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10.
    
    storageInfoobject | null
    2 fields in storageInfo
    temperatureinteger (int32)
    sizeobject | null
    3 fields in size
    heightinteger (int32)
    widthinteger (int32)
    lengthinteger (int32)
    subProductIdstring (uuid) | null
    subProductQuantityobject | null
    1 field in subProductQuantity
    valuenumber (double)
    useBasePriceboolean
    variantIdstring (uuid)
    variantNamestring | null
    variantNumberstring | null
    variantTypeinteger (int32)
    Allowed values: 0, 1, 2, 3, 4, 5, 6, 7.
  - quantityobject | null
    1 field in quantity
    valuenumber (double)
  - unitQuantityobject | null
    1 field in unitQuantity
    valuenumber (double)
  - unitobject | null
    2 fields in unit
    namestring | null
    typeinteger (int32)
    Allowed values: 0, 1, 2, 3.
  - pricePresetIdstring (uuid) | null
  - productPriceInclTaxobject | null
    2 fields in productPriceInclTax
    unitPriceobject | null
    2 fields in unitPrice
    amountnumber (double)
    currencyCodestring | null
    additionalPriceobject | null
    2 fields in additionalPrice
    amountnumber (double)
    currencyCodestring | null
  - productPriceExclTaxobject | null
    2 fields in productPriceExclTax
    unitPriceobject | null
    2 fields in unitPrice
    amountnumber (double)
    currencyCodestring | null
    additionalPriceobject | null
    2 fields in additionalPrice
    amountnumber (double)
    currencyCodestring | null
  - productMaterialCostExclTaxobject | null
    2 fields in productMaterialCostExclTax
    unitPriceobject | null
    2 fields in unitPrice
    amountnumber (double)
    currencyCodestring | null
    additionalPriceobject | null
    2 fields in additionalPrice
    amountnumber (double)
    currencyCodestring | null
  - kitchenMessagestring | null
  - discountInfoobject | null
    2 fields in discountInfo
    discountIdstring (uuid) | null
    discountNamestring | null
  - discountobject | null
    2 fields in discount
    valuenumber (double) | null
    typeinteger (int32) | null
    Allowed values: 0, 1.
  - courseNamestring | null
  - coursePositioninteger (int32)
  - checkPaymentIdstring (uuid) | null
  - paidAtstring (date-time) | null
  - tagstring | null
  - statusinteger (int32)
    Allowed values: 0, 1, 2, 4, 8, 16, 32.
  - upsellGroupIdstring (uuid) | null
  - ticketedAtstring (date-time) | null
  - ticketedTenantUserIdstring (uuid) | null
  - modificationsarray<object> | null
    5 fields in modifications
    idstring (uuid)
    createdstring (date-time)
    modifiedstring (date-time)
    checkItemIdstring (uuid)
    modificationobject | null
    Restored 1.0 wire shape of Ancon.Wildcat.Shared ProductModification as it serializes in the production package (1.0.1200-alpha), where Cost and MaterialCost are Money objects. The current package flattened them to decimals, so the raw value object cannot be serialized directly anymore. Frozen - do not change.
    
    9 fields in modification
    addOnGroupobject | null
    3 fields in addOnGroup
    idstring (uuid)
    namestring | null
    localizedCustomerFacingNamesobject | null
    costobject | null
    2 fields in cost
    amountnumber (double)
    currencyCodestring | null
    freeAmountobject | null
    1 field in freeAmount
    valuenumber (double)
    ingredientobject | null
    3 fields in ingredient
    idstring (uuid)
    nameobject | null
    localizedNamesobject | null
    materialCostobject | null
    2 fields in materialCost
    amountnumber (double)
    currencyCodestring | null
    modificationstring | null
    positionobject | null
    1 field in position
    positioninteger (int32)
    quantityobject | null
    1 field in quantity
    valuenumber (double)
    replacementobject | null
    3 fields in replacement
    idstring (uuid)
    nameobject | null
    localizedNamesobject | null
  - isTaxMandatoryboolean
  - taxesarray<object> | null
    4 fields in taxes
    idstring (uuid)
    createdstring (date-time)
    modifiedstring (date-time)
    taxobject | null
    2 fields in tax
    taxIdstring (uuid)
    taxValueobject | null
    2 fields in taxValue
    typeinteger (int32)
    Allowed values: 1, 2.
    
    ratenumber (double)
  - checkItemsarray<object> | null
  - parentItemIdstring (uuid) | null
  - isMultiproductboolean
  - hasOwnPriceboolean
  - priceInclTaxobject | null
    2 fields in priceInclTax
    amountnumber (double)
    currencystring | null
  - priceExclTaxobject | null
    2 fields in priceExclTax
    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
  - totalDiscountAmountInclTaxobject | null
    2 fields in totalDiscountAmountInclTax
    amountnumber (double)
    currencystring | null
  - totalDiscountAmountExclTaxobject | null
    2 fields in totalDiscountAmountExclTax
    amountnumber (double)
    currencystring | null
  - modificationPriceInclTaxobject | null
    2 fields in modificationPriceInclTax
    amountnumber (double)
    currencystring | null
  - modificationPriceExclTaxobject | null
    2 fields in modificationPriceExclTax
    amountnumber (double)
    currencystring | null
  - isPrepaidboolean
- itemsExclSystemProductsarray<object> | null
  43 fields in itemsExclSystemProducts
  - idstring (uuid)
  - checkIdstring (uuid) | null
  - createdstring (date-time)
  - modifiedstring (date-time)
  - productobject | null
    Restored 1.0 wire shape of Ancon.Wildcat.Shared OrderedProduct as it serializes in the production package (1.0.1200-alpha). The current package marks IsSystemProduct with [JsonIgnore], which would silently drop the field from the legacy payloads, so the raw value object cannot be serialized directly anymore. Frozen - do not change.
    
    20 fields in product
    glassesPerBottlenumber (double) | null
    hasVariantsboolean
    isSystemProductboolean
    localizedProductNamesobject | null
    1 field in localizedProductNames
    translationsmap<string, string> | null
    localizedVariantNamesobject | null
    1 field in localizedVariantNames
    translationsmap<string, string> | null
    positionobject | null
    1 field in position
    positioninteger (int32)
    productGroupIdstring (uuid)
    productGroupNamestring | null
    productIdstring (uuid)
    productNamestring | null
    productNumberstring | null
    productTypeinteger (int32)
    Allowed values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10.
    
    storageInfoobject | null
    2 fields in storageInfo
    temperatureinteger (int32)
    sizeobject | null
    3 fields in size
    heightinteger (int32)
    widthinteger (int32)
    lengthinteger (int32)
    subProductIdstring (uuid) | null
    subProductQuantityobject | null
    1 field in subProductQuantity
    valuenumber (double)
    useBasePriceboolean
    variantIdstring (uuid)
    variantNamestring | null
    variantNumberstring | null
    variantTypeinteger (int32)
    Allowed values: 0, 1, 2, 3, 4, 5, 6, 7.
  - quantityobject | null
    1 field in quantity
    valuenumber (double)
  - unitQuantityobject | null
    1 field in unitQuantity
    valuenumber (double)
  - unitobject | null
    2 fields in unit
    namestring | null
    typeinteger (int32)
    Allowed values: 0, 1, 2, 3.
  - pricePresetIdstring (uuid) | null
  - productPriceInclTaxobject | null
    2 fields in productPriceInclTax
    unitPriceobject | null
    2 fields in unitPrice
    amountnumber (double)
    currencyCodestring | null
    additionalPriceobject | null
    2 fields in additionalPrice
    amountnumber (double)
    currencyCodestring | null
  - productPriceExclTaxobject | null
    2 fields in productPriceExclTax
    unitPriceobject | null
    2 fields in unitPrice
    amountnumber (double)
    currencyCodestring | null
    additionalPriceobject | null
    2 fields in additionalPrice
    amountnumber (double)
    currencyCodestring | null
  - productMaterialCostExclTaxobject | null
    2 fields in productMaterialCostExclTax
    unitPriceobject | null
    2 fields in unitPrice
    amountnumber (double)
    currencyCodestring | null
    additionalPriceobject | null
    2 fields in additionalPrice
    amountnumber (double)
    currencyCodestring | null
  - kitchenMessagestring | null
  - discountInfoobject | null
    2 fields in discountInfo
    discountIdstring (uuid) | null
    discountNamestring | null
  - discountobject | null
    2 fields in discount
    valuenumber (double) | null
    typeinteger (int32) | null
    Allowed values: 0, 1.
  - courseNamestring | null
  - coursePositioninteger (int32)
  - checkPaymentIdstring (uuid) | null
  - paidAtstring (date-time) | null
  - tagstring | null
  - statusinteger (int32)
    Allowed values: 0, 1, 2, 4, 8, 16, 32.
  - upsellGroupIdstring (uuid) | null
  - ticketedAtstring (date-time) | null
  - ticketedTenantUserIdstring (uuid) | null
  - modificationsarray<object> | null
    5 fields in modifications
    idstring (uuid)
    createdstring (date-time)
    modifiedstring (date-time)
    checkItemIdstring (uuid)
    modificationobject | null
    Restored 1.0 wire shape of Ancon.Wildcat.Shared ProductModification as it serializes in the production package (1.0.1200-alpha), where Cost and MaterialCost are Money objects. The current package flattened them to decimals, so the raw value object cannot be serialized directly anymore. Frozen - do not change.
    
    9 fields in modification
    addOnGroupobject | null
    3 fields in addOnGroup
    idstring (uuid)
    namestring | null
    localizedCustomerFacingNamesobject | null
    costobject | null
    2 fields in cost
    amountnumber (double)
    currencyCodestring | null
    freeAmountobject | null
    1 field in freeAmount
    valuenumber (double)
    ingredientobject | null
    3 fields in ingredient
    idstring (uuid)
    nameobject | null
    localizedNamesobject | null
    materialCostobject | null
    2 fields in materialCost
    amountnumber (double)
    currencyCodestring | null
    modificationstring | null
    positionobject | null
    1 field in position
    positioninteger (int32)
    quantityobject | null
    1 field in quantity
    valuenumber (double)
    replacementobject | null
    3 fields in replacement
    idstring (uuid)
    nameobject | null
    localizedNamesobject | null
  - isTaxMandatoryboolean
  - taxesarray<object> | null
    4 fields in taxes
    idstring (uuid)
    createdstring (date-time)
    modifiedstring (date-time)
    taxobject | null
    2 fields in tax
    taxIdstring (uuid)
    taxValueobject | null
    2 fields in taxValue
    typeinteger (int32)
    Allowed values: 1, 2.
    
    ratenumber (double)
  - checkItemsarray<object> | null
  - parentItemIdstring (uuid) | null
  - isMultiproductboolean
  - hasOwnPriceboolean
  - priceInclTaxobject | null
    2 fields in priceInclTax
    amountnumber (double)
    currencystring | null
  - priceExclTaxobject | null
    2 fields in priceExclTax
    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
  - totalDiscountAmountInclTaxobject | null
    2 fields in totalDiscountAmountInclTax
    amountnumber (double)
    currencystring | null
  - totalDiscountAmountExclTaxobject | null
    2 fields in totalDiscountAmountExclTax
    amountnumber (double)
    currencystring | null
  - modificationPriceInclTaxobject | null
    2 fields in modificationPriceInclTax
    amountnumber (double)
    currencystring | null
  - modificationPriceExclTaxobject | null
    2 fields in modificationPriceExclTax
    amountnumber (double)
    currencystring | null
  - isPrepaidboolean
- totalAmountobject | null
  2 fields in totalAmount
  - amountnumber (double)
  - currencyCodestring | null
- totalAmountPlusTipobject | null
  2 fields in totalAmountPlusTip
  - amountnumber (double)
  - currencyCodestring | null
- taxAmountobject | null
  2 fields in taxAmount
  - amountnumber (double)
  - currencyCodestring | null
- subtotalInclTaxobject | null
  2 fields in subtotalInclTax
  - amountnumber (double)
  - currencyCodestring | null
- subtotalExclTaxobject | null
  2 fields in subtotalExclTax
  - amountnumber (double)
  - currencyCodestring | null
- subTotalDiscountInclTaxobject | null
  2 fields in subTotalDiscountInclTax
  - amountnumber (double)
  - currencyCodestring | null
- subTotalDiscountExclTaxobject | null
  2 fields in subTotalDiscountExclTax
  - amountnumber (double)
  - currencyCodestring | null
- remainingAmountToPayobject | null
  2 fields in remainingAmountToPay
  - amountnumber (double)
  - currencyCodestring | null
- awaitingConfirmationstring (date-time) | null
- customerobject | null
  7 fields in customer
  - emailobject | null
    1 field in email
    emailstring | null
  - fullNamestring | null
  - customerIdstring (uuid) | null
  - identityUserIdstring (uuid) | 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)
  - phonestring | null
  - saleSourceIdstring (uuid) | null
- guestGroupIdstring (uuid) | null

400Bad Requestapplication/json

messagestring | null
errorCodestring (uuid)
additionalDataany | null

401Unauthorizedapplication/json

messagestring | null

404Not Foundapplication/json

messagestring | null
errorCodestring (uuid)

Request

curl -X PUT "https://core-api.ancon.io/api/v1/Outlets/{outletId}/Checks/{checkId}/CustomName" \
  -H "Access-Token: $ANCON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "customName": "string"
}'

Response

Generated from the schema; values are placeholders.

{
  "check": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created": "2026-01-15T12:00:00Z",
    "modified": "2026-01-15T12:00:00Z",
    "outlet": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string"
    },
    "orderFormat": 0,
    "orderType": 0,
    "saleSourceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "discountValue": {
      "value": 0,
      "type": 0
    },
    "discountCode": {
      "discountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "discountName": "string"
    },
    "currency": {
      "code": "string"
    },
    "salesLocation": {
      "salesLocationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": 0
    },
    "companyInfo": {
      "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "companyName": "string",
      "companyBusinessNumber": "string",
      "address": {
        "street": "string",
        "street2": "string",
        "zipCode": "string",
        "city": "string"
      },
      "invoiceEmail": {
        "email": "string"
      },
      "memberId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "memberName": "string"
    },
    "deletedReason": "string",
    "createdCheckTenantUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdCheckTenantUser": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": {
        "firstName": "string",
        "lastName": "string"
      },
      "email": {
        "email": "string"
      }
    },
    "closedCheckTenantUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdCheckClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "closedCheckClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "incrementalNumbers": {
      "ticketNumber": 0,
      "serialNumber": 0,
      "referenceNumber": 0,
      "refundSerialNumber": 0
    },
    "collectionTicketId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "customTicketNumber": 0,
    "customName": "string",
    "deleted": "2026-01-15T12:00:00Z",
    "guestCount": 0,
    "metaData": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "created": "2026-01-15T12:00:00Z",
        "modified": "2026-01-15T12:00:00Z",
        "checkId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "checkItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "metaData": null
      }
    ],
    "checkItems": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "checkId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "created": "2026-01-15T12:00:00Z",
        "modified": "2026-01-15T12:00:00Z",
        "product": {
          "glassesPerBottle": 0,
          "hasVariants": true,
          "isSystemProduct": true,
          "localizedProductNames": {
            "translations": {}
          },
          "localizedVariantNames": {
            "translations": {}
          },
          "position": {
            "position": 0
          },
          "productGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "productGroupName": "string",
          "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "productName": "string",
          "productNumber": "string",
          "productType": 0,
          "storageInfo": {
            "temperature": 0,
            "size": {}
          },
          "subProductId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "subProductQuantity": {
            "value": 0
          },
          "useBasePrice": true,
          "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "variantName": "string",
          "variantNumber": "string",
          "variantType": 0
        },
        "quantity": {
          "value": 0
        },
        "unitQuantity": {
          "value": 0
        },
        "unit": {
          "name": "string",
          "type": 0
        },
        "pricePresetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "productPriceInclTax": {
          "unitPrice": {
            "amount": 0,
            "currencyCode": "string"
          },
          "additionalPrice": {
            "amount": 0,
            "currencyCode": "string"
          }
        },
        "productPriceExclTax": {
          "unitPrice": {
            "amount": 0,
            "currencyCode": "string"
          },
          "additionalPrice": {
            "amount": 0,
            "currencyCode": "string"
          }
        },
        "productMaterialCostExclTax": {
          "unitPrice": {
            "amount": 0,
            "currencyCode": "string"
          },
          "additionalPrice": {
            "amount": 0,
            "currencyCode": "string"
          }
        },
        "kitchenMessage": "string",
        "discountInfo": {
          "discountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "discountName": "string"
        },
        "discount": {
          "value": 0,
          "type": 0
        },
        "courseName": "string",
        "coursePosition": 0,
        "checkPaymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "paidAt": "2026-01-15T12:00:00Z",
        "tag": "string",
        "status": 0,
        "upsellGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "ticketedAt": "2026-01-15T12:00:00Z",
        "ticketedTenantUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "modifications": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "created": "2026-01-15T12:00:00Z",
            "modified": "2026-01-15T12:00:00Z",
            "checkItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "modification": {}
          }
        ],
        "isTaxMandatory": true,
        "taxes": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "created": "2026-01-15T12:00:00Z",
            "modified": "2026-01-15T12:00:00Z",
            "tax": {}
          }
        ],
        "checkItems": [
          {}
        ],
        "parentItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "isMultiproduct": true,
        "hasOwnPrice": true,
        "priceInclTax": {
          "amount": 0,
          "currency": "string"
        },
        "priceExclTax": {
          "amount": 0,
          "currency": "string"
        },
        "totalPriceInclTax": {
          "amount": 0,
          "currency": "string"
        },
        "totalPriceExclTax": {
          "amount": 0,
          "currency": "string"
        },
        "totalMaterialCostExclTax": {
          "amount": 0,
          "currency": "string"
        },
        "discountAmountInclTax": {
          "amount": 0,
          "currency": "string"
        },
        "discountAmountExclTax": {
          "amount": 0,
          "currency": "string"
        },
        "totalDiscountAmountInclTax": {
          "amount": 0,
          "currency": "string"
        },
        "totalDiscountAmountExclTax": {
          "amount": 0,
          "currency": "string"
        },
        "modificationPriceInclTax": {
          "amount": 0,
          "currency": "string"
        },
        "modificationPriceExclTax": {
          "amount": 0,
          "currency": "string"
        },
        "isPrepaid": true
      }
    ],
    "payments": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "created": "2026-01-15T12:00:00Z",
        "modified": "2026-01-15T12:00:00Z",
        "paymentType": 1,
        "paymentMethod": {
          "id": "string",
          "type": 0,
          "displayName": "string"
        },
        "amount": {
          "amount": 0,
          "currency": "string"
        },
        "cashBackAmount": {
          "amount": 0,
          "currency": "string"
        },
        "roundingAmount": {
          "amount": 0,
          "currency": "string"
        },
        "tipAmount": {
          "amount": 0,
          "currency": "string"
        },
        "tenantUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "externalReference": "string",
        "externalIdentifier": "string",
        "externalTimeStamp": "2026-01-15T12:00:00Z",
        "status": 0,
        "errorType": 0,
        "terminal": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        },
        "client": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        },
        "centralControlUnitSerial": "string",
        "receipts": [
          {
            "receiverType": 1,
            "needsSignature": true,
            "receiptTexts": []
          }
        ],
        "invoiceReferenceNote": "string",
        "isReceiptPrinted": true
      }
    ],
    "allCheckItems": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "checkId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "created": "2026-01-15T12:00:00Z",
        "modified": "2026-01-15T12:00:00Z",
        "product": {
          "glassesPerBottle": 0,
          "hasVariants": true,
          "isSystemProduct": true,
          "localizedProductNames": {
            "translations": {}
          },
          "localizedVariantNames": {
            "translations": {}
          },
          "position": {
            "position": 0
          },
          "productGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "productGroupName": "string",
          "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "productName": "string",
          "productNumber": "string",
          "productType": 0,
          "storageInfo": {
            "temperature": 0,
            "size": {}
          },
          "subProductId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "subProductQuantity": {
            "value": 0
          },
          "useBasePrice": true,
          "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "variantName": "string",
          "variantNumber": "string",
          "variantType": 0
        },
        "quantity": {
          "value": 0
        },
        "unitQuantity": {
          "value": 0
        },
        "unit": {
          "name": "string",
          "type": 0
        },
        "pricePresetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "productPriceInclTax": {
          "unitPrice": {
            "amount": 0,
            "currencyCode": "string"
          },
          "additionalPrice": {
            "amount": 0,
            "currencyCode": "string"
          }
        },
        "productPriceExclTax": {
          "unitPrice": {
            "amount": 0,
            "currencyCode": "string"
          },
          "additionalPrice": {
            "amount": 0,
            "currencyCode": "string"
          }
        },
        "productMaterialCostExclTax": {
          "unitPrice": {
            "amount": 0,
            "currencyCode": "string"
          },
          "additionalPrice": {
            "amount": 0,
            "currencyCode": "string"
          }
        },
        "kitchenMessage": "string",
        "discountInfo": {
          "discountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "discountName": "string"
        },
        "discount": {
          "value": 0,
          "type": 0
        },
        "courseName": "string",
        "coursePosition": 0,
        "checkPaymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "paidAt": "2026-01-15T12:00:00Z",
        "tag": "string",
        "status": 0,
        "upsellGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "ticketedAt": "2026-01-15T12:00:00Z",
        "ticketedTenantUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "modifications": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "created": "2026-01-15T12:00:00Z",
            "modified": "2026-01-15T12:00:00Z",
            "checkItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "modification": {}
          }
        ],
        "isTaxMandatory": true,
        "taxes": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "created": "2026-01-15T12:00:00Z",
            "modified": "2026-01-15T12:00:00Z",
            "tax": {}
          }
        ],
        "checkItems": [
          {}
        ],
        "parentItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "isMultiproduct": true,
        "hasOwnPrice": true,
        "priceInclTax": {
          "amount": 0,
          "currency": "string"
        },
        "priceExclTax": {
          "amount": 0,
          "currency": "string"
        },
        "totalPriceInclTax": {
          "amount": 0,
          "currency": "string"
        },
        "totalPriceExclTax": {
          "amount": 0,
          "currency": "string"
        },
        "totalMaterialCostExclTax": {
          "amount": 0,
          "currency": "string"
        },
        "discountAmountInclTax": {
          "amount": 0,
          "currency": "string"
        },
        "discountAmountExclTax": {
          "amount": 0,
          "currency": "string"
        },
        "totalDiscountAmountInclTax": {
          "amount": 0,
          "currency": "string"
        },
        "totalDiscountAmountExclTax": {
          "amount": 0,
          "currency": "string"
        },
        "modificationPriceInclTax": {
          "amount": 0,
          "currency": "string"
        },
        "modificationPriceExclTax": {
          "amount": 0,
          "currency": "string"
        },
        "isPrepaid": true
      }
    ],
    "itemsExclSystemProducts": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "checkId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "created": "2026-01-15T12:00:00Z",
        "modified": "2026-01-15T12:00:00Z",
        "product": {
          "glassesPerBottle": 0,
          "hasVariants": true,
          "isSystemProduct": true,
          "localizedProductNames": {
            "translations": {}
          },
          "localizedVariantNames": {
            "translations": {}
          },
          "position": {
            "position": 0
          },
          "productGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "productGroupName": "string",
          "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "productName": "string",
          "productNumber": "string",
          "productType": 0,
          "storageInfo": {
            "temperature": 0,
            "size": {}
          },
          "subProductId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "subProductQuantity": {
            "value": 0
          },
          "useBasePrice": true,
          "variantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "variantName": "string",
          "variantNumber": "string",
          "variantType": 0
        },
        "quantity": {
          "value": 0
        },
        "unitQuantity": {
          "value": 0
        },
        "unit": {
          "name": "string",
          "type": 0
        },
        "pricePresetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "productPriceInclTax": {
          "unitPrice": {
            "amount": 0,
            "currencyCode": "string"
          },
          "additionalPrice": {
            "amount": 0,
            "currencyCode": "string"
          }
        },
        "productPriceExclTax": {
          "unitPrice": {
            "amount": 0,
            "currencyCode": "string"
          },
          "additionalPrice": {
            "amount": 0,
            "currencyCode": "string"
          }
        },
        "productMaterialCostExclTax": {
          "unitPrice": {
            "amount": 0,
            "currencyCode": "string"
          },
          "additionalPrice": {
            "amount": 0,
            "currencyCode": "string"
          }
        },
        "kitchenMessage": "string",
        "discountInfo": {
          "discountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "discountName": "string"
        },
        "discount": {
          "value": 0,
          "type": 0
        },
        "courseName": "string",
        "coursePosition": 0,
        "checkPaymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "paidAt": "2026-01-15T12:00:00Z",
        "tag": "string",
        "status": 0,
        "upsellGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "ticketedAt": "2026-01-15T12:00:00Z",
        "ticketedTenantUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "modifications": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "created": "2026-01-15T12:00:00Z",
            "modified": "2026-01-15T12:00:00Z",
            "checkItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "modification": {}
          }
        ],
        "isTaxMandatory": true,
        "taxes": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "created": "2026-01-15T12:00:00Z",
            "modified": "2026-01-15T12:00:00Z",
            "tax": {}
          }
        ],
        "checkItems": [
          {}
        ],
        "parentItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "isMultiproduct": true,
        "hasOwnPrice": true,
        "priceInclTax": {
          "amount": 0,
          "currency": "string"
        },
        "priceExclTax": {
          "amount": 0,
          "currency": "string"
        },
        "totalPriceInclTax": {
          "amount": 0,
          "currency": "string"
        },
        "totalPriceExclTax": {
          "amount": 0,
          "currency": "string"
        },
        "totalMaterialCostExclTax": {
          "amount": 0,
          "currency": "string"
        },
        "discountAmountInclTax": {
          "amount": 0,
          "currency": "string"
        },
        "discountAmountExclTax": {
          "amount": 0,
          "currency": "string"
        },
        "totalDiscountAmountInclTax": {
          "amount": 0,
          "currency": "string"
        },
        "totalDiscountAmountExclTax": {
          "amount": 0,
          "currency": "string"
        },
        "modificationPriceInclTax": {
          "amount": 0,
          "currency": "string"
        },
        "modificationPriceExclTax": {
          "amount": 0,
          "currency": "string"
        },
        "isPrepaid": true
      }
    ],
    "totalAmount": {
      "amount": 0,
      "currencyCode": "string"
    },
    "totalAmountPlusTip": {
      "amount": 0,
      "currencyCode": "string"
    },
    "taxAmount": {
      "amount": 0,
      "currencyCode": "string"
    },
    "subtotalInclTax": {
      "amount": 0,
      "currencyCode": "string"
    },
    "subtotalExclTax": {
      "amount": 0,
      "currencyCode": "string"
    },
    "subTotalDiscountInclTax": {
      "amount": 0,
      "currencyCode": "string"
    },
    "subTotalDiscountExclTax": {
      "amount": 0,
      "currencyCode": "string"
    },
    "remainingAmountToPay": {
      "amount": 0,
      "currencyCode": "string"
    },
    "awaitingConfirmation": "2026-01-15T12:00:00Z",
    "customer": {
      "email": {
        "email": "string"
      },
      "fullName": "string",
      "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "identityUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "address": {
        "street": "string",
        "zipCode": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "location": {
          "latitude": 0,
          "longitude": 0
        }
      },
      "phone": "string",
      "saleSourceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "guestGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

#Authorization

#Path parameters

#Header parameters

#Request body application/json

#Responses

Authorization

Path parameters

Header parameters

Request body application/json

Responses