smartshop

APIs for Smart Shopper Devices
More information: https://openapi-generator.tech
Contact Info: tony.hicks@qvssoftware.com
Version: 1.0.0
BasePath:/generic-ace
Apache 2.0
http://www.apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up 
put /acews/transaction
Contents of Client Transaction (acewsTransactionPut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body body (optional)
Body Parameter —

Return type

body

Example data

Content-Type: application/json
{
  "applicationContext" : {
    "result" : "OK",
    "operatorInfo" : {
      "operatorPw" : "operatorPw",
      "signOnState" : "SignedOn",
      "operatorId" : "operatorId"
    },
    "responseTime" : "responseTime",
    "applStatus" : {
      "txnVoidPending" : true,
      "txnInProgress" : true,
      "txnVoidOrTenderRequired" : true
    },
    "responseSequenceNumber" : 6,
    "clientSequenceID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "resultMessage" : "resultMessage",
    "transaction" : {
      "receiptPrints" : [ null, null ],
      "clientApplicationID" : "clientApplicationID",
      "receiptDisplays" : [ null, null ],
      "customerInfo" : {
        "alternateId" : "alternateId",
        "scannedInput" : "scannedInput",
        "loyaltyAuditFlags" : "loyaltyAuditFlags",
        "loyaltyAccountType" : "loyaltyAccountType",
        "loyaltyAccountNumber" : "loyaltyAccountNumber",
        "resultMessage" : "resultMessage",
        "keyedInput" : "keyedInput"
      },
      "discount" : {
        "amount" : "amount",
        "taxExemptId" : "taxExemptId",
        "groupId" : 1,
        "description" : "description",
        "resultMessage" : "resultMessage"
      },
      "purgeDataAfterSerialize" : true,
      "totals" : {
        "total" : "total",
        "totalItems" : "totalItems",
        "balanceDue" : "balanceDue",
        "foodStampTotal" : "foodStampTotal",
        "foodStampBalance" : "foodStampBalance",
        "totalCouponCount" : "totalCouponCount",
        "changeDue" : "changeDue",
        "tax" : "tax",
        "tenderExchanged" : "tenderExchanged",
        "subTotal" : "subTotal",
        "totalSavings" : "totalSavings",
        "totalCouponAmount" : "totalCouponAmount"
      },
      "exceptionItems" : [ {
        "resultErrorDescription" : "resultErrorDescription",
        "priceVerify" : true,
        "quantity" : 9,
        "overridePrice" : true,
        "returnToStockAnswer" : "ENTER",
        "weight" : 3,
        "wicEligible" : true,
        "dateOfBirth" : "dateOfBirth",
        "clientPrice" : "clientPrice",
        "netWeight" : "netWeight",
        "itemSaleAuditFlags" : "itemSaleAuditFlags",
        "scannedInput" : "scannedInput",
        "itemDescription" : "itemDescription",
        "foodstampEligible" : true,
        "clientItemID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "isAdditionalItem" : "true",
        "keyedInput" : "keyedInput",
        "tareWeight" : "tareWeight"
      }, {
        "resultErrorDescription" : "resultErrorDescription",
        "priceVerify" : true,
        "quantity" : 9,
        "overridePrice" : true,
        "returnToStockAnswer" : "ENTER",
        "weight" : 3,
        "wicEligible" : true,
        "dateOfBirth" : "dateOfBirth",
        "clientPrice" : "clientPrice",
        "netWeight" : "netWeight",
        "itemSaleAuditFlags" : "itemSaleAuditFlags",
        "scannedInput" : "scannedInput",
        "itemDescription" : "itemDescription",
        "foodstampEligible" : true,
        "clientItemID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "isAdditionalItem" : "true",
        "keyedInput" : "keyedInput",
        "tareWeight" : "tareWeight"
      } ],
      "suspendTransaction" : true,
      "prepareToTender" : true,
      "transactionAuditFlags" : "transactionAuditFlags",
      "actionType" : "SALES",
      "suspendInfo" : {
        "terminalNumber" : 7,
        "transactionNumber" : 1,
        "barCodeData" : "barCodeData"
      },
      "tenders" : [ null, null ],
      "actionSubType" : "SALES",
      "items" : [ {
        "resultErrorDescription" : "resultErrorDescription",
        "overridePrice" : true,
        "returnToStockAnswer" : "ENTER",
        "itemCode" : "itemCode",
        "regularPrice" : "regularPrice",
        "wicEligible" : true,
        "linkedItemOrdinalNumber" : 2,
        "extendedPrice" : "extendedPrice",
        "itemSaleAuditFlags" : "itemSaleAuditFlags",
        "scannedInput" : "scannedInput",
        "itemDescription" : "itemDescription",
        "itemOrdinalNumber" : 5,
        "foodstampEligible" : true,
        "clientItemID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "value" : "value",
        "isCouponItem" : "true",
        "unitPrice" : "unitPrice",
        "priceVerify" : true,
        "quantity" : 1,
        "responseTime" : 5,
        "linkedItemCode" : "linkedItemCode",
        "weight" : 7,
        "dateOfBirth" : "dateOfBirth",
        "clientPrice" : "clientPrice",
        "netWeight" : "netWeight",
        "aefItemEvents" : [ {
          "isReturn" : true,
          "dealQuantity" : "dealQuantity",
          "isDiscountable" : true,
          "pricingMethod" : "pricingMethod",
          "wicEligible" : true,
          "dealPrice" : "dealPrice",
          "isDeposit" : true,
          "itemRepeatAllowed" : true,
          "promotionServiceID" : "promotionServiceID",
          "limitedQuantityDiscountUnitPriceQuantity" : "limitedQuantityDiscountUnitPriceQuantity",
          "restricts" : [ {
            "startMonth" : "startMonth",
            "endDate" : "endDate",
            "startDay" : "startDay",
            "endDay" : "endDay",
            "startTime" : "startTime",
            "endTime" : "endTime",
            "endMonth" : "endMonth",
            "reversed" : true,
            "startDate" : "startDate"
          }, {
            "startMonth" : "startMonth",
            "endDate" : "endDate",
            "startDay" : "startDay",
            "endDay" : "endDay",
            "startTime" : "startTime",
            "endTime" : "endTime",
            "endMonth" : "endMonth",
            "reversed" : true,
            "startDate" : "startDate"
          } ],
          "extendedPrice" : "extendedPrice",
          "fixedValueAmount" : "fixedValueAmount",
          "itemOrdinalNumber" : "itemOrdinalNumber",
          "checkDigit" : true,
          "barcode" : "barcode",
          "isQuantityAllowed" : true,
          "promotionServiceGiftCardID" : "promotionServiceGiftCardID",
          "unitPrice" : "unitPrice",
          "enteredPriceUsed" : true,
          "groupID" : "groupID",
          "bornByDate" : "bornByDate",
          "promotionCode" : "promotionCode",
          "promotionServiceUserData" : "promotionServiceUserData",
          "weight" : "weight",
          "eventType" : "eventType",
          "isVoided" : true,
          "barcodeFamily" : "barcodeFamily",
          "raincheckKeyed" : true,
          "weightOrigin" : "weightOrigin",
          "linkedItemID" : "linkedItemID",
          "departmentNumber" : "departmentNumber",
          "quantityEntries" : [ {
            "unitPrice" : "unitPrice",
            "ordinalNumber" : "ordinalNumber",
            "voidedItemOrdinalNumber" : "voidedItemOrdinalNumber",
            "lastMatchedOrdinal" : "lastMatchedOrdinal"
          }, {
            "unitPrice" : "unitPrice",
            "ordinalNumber" : "ordinalNumber",
            "voidedItemOrdinalNumber" : "voidedItemOrdinalNumber",
            "lastMatchedOrdinal" : "lastMatchedOrdinal"
          } ],
          "limitedQuantityDiscountDealLimit" : "limitedQuantityDiscountDealLimit",
          "itemTaxable" : true,
          "nrscUserData2" : "nrscUserData2",
          "itemIDQualifier" : "itemIDQualifier",
          "itemType" : "itemType",
          "requiredAge" : "requiredAge",
          "linkedItemIDQualifier" : "linkedItemIDQualifier",
          "description" : "description",
          "itemID" : "itemID",
          "depositKeyUsed" : true,
          "isQuantityRequired" : true,
          "returnReason" : "returnReason",
          "lastMatchedOrdinal" : "lastMatchedOrdinal",
          "foodstampEligible" : true,
          "quantity" : "quantity",
          "printLines" : [ {
            "centered" : true,
            "lineType" : "lineType",
            "columnsToPrint" : "columnsToPrint",
            "lineCategory" : "lineCategory",
            "signatureLine" : "signatureLine",
            "filteredData" : "filteredData",
            "rawData" : "rawData",
            "linefeeds" : "linefeeds",
            "font" : "font"
          }, {
            "centered" : true,
            "lineType" : "lineType",
            "columnsToPrint" : "columnsToPrint",
            "lineCategory" : "lineCategory",
            "signatureLine" : "signatureLine",
            "filteredData" : "filteredData",
            "rawData" : "rawData",
            "linefeeds" : "linefeeds",
            "font" : "font"
          } ],
          "deptKey" : "deptKey",
          "reducePrice" : "reducePrice",
          "voidedItemOrdinalNumber" : "voidedItemOrdinalNumber",
          "manualTareId" : "manualTareId",
          "enteredQuantityUsed" : true,
          "tareWeight" : "tareWeight"
        }, {
          "isReturn" : true,
          "dealQuantity" : "dealQuantity",
          "isDiscountable" : true,
          "pricingMethod" : "pricingMethod",
          "wicEligible" : true,
          "dealPrice" : "dealPrice",
          "isDeposit" : true,
          "itemRepeatAllowed" : true,
          "promotionServiceID" : "promotionServiceID",
          "limitedQuantityDiscountUnitPriceQuantity" : "limitedQuantityDiscountUnitPriceQuantity",
          "restricts" : [ {
            "startMonth" : "startMonth",
            "endDate" : "endDate",
            "startDay" : "startDay",
            "endDay" : "endDay",
            "startTime" : "startTime",
            "endTime" : "endTime",
            "endMonth" : "endMonth",
            "reversed" : true,
            "startDate" : "startDate"
          }, {
            "startMonth" : "startMonth",
            "endDate" : "endDate",
            "startDay" : "startDay",
            "endDay" : "endDay",
            "startTime" : "startTime",
            "endTime" : "endTime",
            "endMonth" : "endMonth",
            "reversed" : true,
            "startDate" : "startDate"
          } ],
          "extendedPrice" : "extendedPrice",
          "fixedValueAmount" : "fixedValueAmount",
          "itemOrdinalNumber" : "itemOrdinalNumber",
          "checkDigit" : true,
          "barcode" : "barcode",
          "isQuantityAllowed" : true,
          "promotionServiceGiftCardID" : "promotionServiceGiftCardID",
          "unitPrice" : "unitPrice",
          "enteredPriceUsed" : true,
          "groupID" : "groupID",
          "bornByDate" : "bornByDate",
          "promotionCode" : "promotionCode",
          "promotionServiceUserData" : "promotionServiceUserData",
          "weight" : "weight",
          "eventType" : "eventType",
          "isVoided" : true,
          "barcodeFamily" : "barcodeFamily",
          "raincheckKeyed" : true,
          "weightOrigin" : "weightOrigin",
          "linkedItemID" : "linkedItemID",
          "departmentNumber" : "departmentNumber",
          "quantityEntries" : [ {
            "unitPrice" : "unitPrice",
            "ordinalNumber" : "ordinalNumber",
            "voidedItemOrdinalNumber" : "voidedItemOrdinalNumber",
            "lastMatchedOrdinal" : "lastMatchedOrdinal"
          }, {
            "unitPrice" : "unitPrice",
            "ordinalNumber" : "ordinalNumber",
            "voidedItemOrdinalNumber" : "voidedItemOrdinalNumber",
            "lastMatchedOrdinal" : "lastMatchedOrdinal"
          } ],
          "limitedQuantityDiscountDealLimit" : "limitedQuantityDiscountDealLimit",
          "itemTaxable" : true,
          "nrscUserData2" : "nrscUserData2",
          "itemIDQualifier" : "itemIDQualifier",
          "itemType" : "itemType",
          "requiredAge" : "requiredAge",
          "linkedItemIDQualifier" : "linkedItemIDQualifier",
          "description" : "description",
          "itemID" : "itemID",
          "depositKeyUsed" : true,
          "isQuantityRequired" : true,
          "returnReason" : "returnReason",
          "lastMatchedOrdinal" : "lastMatchedOrdinal",
          "foodstampEligible" : true,
          "quantity" : "quantity",
          "printLines" : [ {
            "centered" : true,
            "lineType" : "lineType",
            "columnsToPrint" : "columnsToPrint",
            "lineCategory" : "lineCategory",
            "signatureLine" : "signatureLine",
            "filteredData" : "filteredData",
            "rawData" : "rawData",
            "linefeeds" : "linefeeds",
            "font" : "font"
          }, {
            "centered" : true,
            "lineType" : "lineType",
            "columnsToPrint" : "columnsToPrint",
            "lineCategory" : "lineCategory",
            "signatureLine" : "signatureLine",
            "filteredData" : "filteredData",
            "rawData" : "rawData",
            "linefeeds" : "linefeeds",
            "font" : "font"
          } ],
          "deptKey" : "deptKey",
          "reducePrice" : "reducePrice",
          "voidedItemOrdinalNumber" : "voidedItemOrdinalNumber",
          "manualTareId" : "manualTareId",
          "enteredQuantityUsed" : true,
          "tareWeight" : "tareWeight"
        } ],
        "itemPrice" : "1.00",
        "isAdditionalItem" : "true",
        "keyedInput" : "keyedInput",
        "tareWeight" : "tareWeight",
        "aefCouponEvents" : [ {
          "addKeyForVoid" : true,
          "itemIDQualifier" : "itemIDQualifier",
          "itemType" : "itemType",
          "dealQuantity" : "dealQuantity",
          "reducesTaxDue" : "reducesTaxDue",
          "requiredAge" : "requiredAge",
          "matchingItem" : {
            "ordinalNumber" : "ordinalNumber",
            "couponValue" : "couponValue"
          },
          "linkedItemIDQualifier" : "linkedItemIDQualifier",
          "pricingMethod" : "pricingMethod",
          "description" : "description",
          "wicEligible" : true,
          "dealPrice" : "dealPrice",
          "isDeposit" : true,
          "itemRepeatAllowed" : true,
          "promotionServiceID" : "promotionServiceID",
          "itemModifier" : "itemModifier",
          "itemID" : "itemID",
          "restricts" : [ {
            "startDay" : "startDay",
            "endDay" : "endDay",
            "start" : "start",
            "end" : "end",
            "startTime" : "startTime",
            "endTime" : "endTime",
            "day" : "day",
            "reversed" : true
          }, {
            "startDay" : "startDay",
            "endDay" : "endDay",
            "start" : "start",
            "end" : "end",
            "startTime" : "startTime",
            "endTime" : "endTime",
            "day" : "day",
            "reversed" : true
          } ],
          "reducesFoodStampBalanceDue" : true,
          "reducedPrice" : "reducedPrice",
          "couponType" : "couponType",
          "manufacturerNumber" : "manufacturerNumber",
          "automaticCoupon" : true,
          "fixedValueAmount" : "fixedValueAmount",
          "value" : "value",
          "unitPrice" : "unitPrice",
          "ordinalNumber" : "ordinalNumber",
          "quantity" : "quantity",
          "isRefunded" : true,
          "printLines" : [ {
            "centered" : true,
            "lineType" : "lineType",
            "columnsToPrint" : "columnsToPrint",
            "lineCategory" : "lineCategory",
            "signatureLine" : "signatureLine",
            "filteredData" : "filteredData",
            "rawData" : "rawData",
            "linefeeds" : "linefeeds",
            "font" : "font"
          }, {
            "centered" : true,
            "lineType" : "lineType",
            "columnsToPrint" : "columnsToPrint",
            "lineCategory" : "lineCategory",
            "signatureLine" : "signatureLine",
            "filteredData" : "filteredData",
            "rawData" : "rawData",
            "linefeeds" : "linefeeds",
            "font" : "font"
          } ],
          "enteredPriceUsed" : true,
          "groupID" : "groupID",
          "promotionServiceUserData" : "promotionServiceUserData",
          "weight" : "weight",
          "percentageOff" : "percentageOff",
          "eventType" : "eventType",
          "isVoided" : true,
          "netValueAmount" : "netValueAmount",
          "volume" : "volume",
          "weightOrigin" : "weightOrigin",
          "promotionServiceCouponID" : "promotionServiceCouponID",
          "linkedItemID" : "linkedItemID",
          "departmentNumber" : "departmentNumber",
          "itemTaxable" : true,
          "enteredQuantityUsed" : true
        }, {
          "addKeyForVoid" : true,
          "itemIDQualifier" : "itemIDQualifier",
          "itemType" : "itemType",
          "dealQuantity" : "dealQuantity",
          "reducesTaxDue" : "reducesTaxDue",
          "requiredAge" : "requiredAge",
          "matchingItem" : {
            "ordinalNumber" : "ordinalNumber",
            "couponValue" : "couponValue"
          },
          "linkedItemIDQualifier" : "linkedItemIDQualifier",
          "pricingMethod" : "pricingMethod",
          "description" : "description",
          "wicEligible" : true,
          "dealPrice" : "dealPrice",
          "isDeposit" : true,
          "itemRepeatAllowed" : true,
          "promotionServiceID" : "promotionServiceID",
          "itemModifier" : "itemModifier",
          "itemID" : "itemID",
          "restricts" : [ {
            "startDay" : "startDay",
            "endDay" : "endDay",
            "start" : "start",
            "end" : "end",
            "startTime" : "startTime",
            "endTime" : "endTime",
            "day" : "day",
            "reversed" : true
          }, {
            "startDay" : "startDay",
            "endDay" : "endDay",
            "start" : "start",
            "end" : "end",
            "startTime" : "startTime",
            "endTime" : "endTime",
            "day" : "day",
            "reversed" : true
          } ],
          "reducesFoodStampBalanceDue" : true,
          "reducedPrice" : "reducedPrice",
          "couponType" : "couponType",
          "manufacturerNumber" : "manufacturerNumber",
          "automaticCoupon" : true,
          "fixedValueAmount" : "fixedValueAmount",
          "value" : "value",
          "unitPrice" : "unitPrice",
          "ordinalNumber" : "ordinalNumber",
          "quantity" : "quantity",
          "isRefunded" : true,
          "printLines" : [ {
            "centered" : true,
            "lineType" : "lineType",
            "columnsToPrint" : "columnsToPrint",
            "lineCategory" : "lineCategory",
            "signatureLine" : "signatureLine",
            "filteredData" : "filteredData",
            "rawData" : "rawData",
            "linefeeds" : "linefeeds",
            "font" : "font"
          }, {
            "centered" : true,
            "lineType" : "lineType",
            "columnsToPrint" : "columnsToPrint",
            "lineCategory" : "lineCategory",
            "signatureLine" : "signatureLine",
            "filteredData" : "filteredData",
            "rawData" : "rawData",
            "linefeeds" : "linefeeds",
            "font" : "font"
          } ],
          "enteredPriceUsed" : true,
          "groupID" : "groupID",
          "promotionServiceUserData" : "promotionServiceUserData",
          "weight" : "weight",
          "percentageOff" : "percentageOff",
          "eventType" : "eventType",
          "isVoided" : true,
          "netValueAmount" : "netValueAmount",
          "volume" : "volume",
          "weightOrigin" : "weightOrigin",
          "promotionServiceCouponID" : "promotionServiceCouponID",
          "linkedItemID" : "linkedItemID",
          "departmentNumber" : "departmentNumber",
          "itemTaxable" : true,
          "enteredQuantityUsed" : true
        } ]
      }, {
        "resultErrorDescription" : "resultErrorDescription",
        "overridePrice" : true,
        "returnToStockAnswer" : "ENTER",
        "itemCode" : "itemCode",
        "regularPrice" : "regularPrice",
        "wicEligible" : true,
        "linkedItemOrdinalNumber" : 2,
        "extendedPrice" : "extendedPrice",
        "itemSaleAuditFlags" : "itemSaleAuditFlags",
        "scannedInput" : "scannedInput",
        "itemDescription" : "itemDescription",
        "itemOrdinalNumber" : 5,
        "foodstampEligible" : true,
        "clientItemID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "value" : "value",
        "isCouponItem" : "true",
        "unitPrice" : "unitPrice",
        "priceVerify" : true,
        "quantity" : 1,
        "responseTime" : 5,
        "linkedItemCode" : "linkedItemCode",
        "weight" : 7,
        "dateOfBirth" : "dateOfBirth",
        "clientPrice" : "clientPrice",
        "netWeight" : "netWeight",
        "aefItemEvents" : [ {
          "isReturn" : true,
          "dealQuantity" : "dealQuantity",
          "isDiscountable" : true,
          "pricingMethod" : "pricingMethod",
          "wicEligible" : true,
          "dealPrice" : "dealPrice",
          "isDeposit" : true,
          "itemRepeatAllowed" : true,
          "promotionServiceID" : "promotionServiceID",
          "limitedQuantityDiscountUnitPriceQuantity" : "limitedQuantityDiscountUnitPriceQuantity",
          "restricts" : [ {
            "startMonth" : "startMonth",
            "endDate" : "endDate",
            "startDay" : "startDay",
            "endDay" : "endDay",
            "startTime" : "startTime",
            "endTime" : "endTime",
            "endMonth" : "endMonth",
            "reversed" : true,
            "startDate" : "startDate"
          }, {
            "startMonth" : "startMonth",
            "endDate" : "endDate",
            "startDay" : "startDay",
            "endDay" : "endDay",
            "startTime" : "startTime",
            "endTime" : "endTime",
            "endMonth" : "endMonth",
            "reversed" : true,
            "startDate" : "startDate"
          } ],
          "extendedPrice" : "extendedPrice",
          "fixedValueAmount" : "fixedValueAmount",
          "itemOrdinalNumber" : "itemOrdinalNumber",
          "checkDigit" : true,
          "barcode" : "barcode",
          "isQuantityAllowed" : true,
          "promotionServiceGiftCardID" : "promotionServiceGiftCardID",
          "unitPrice" : "unitPrice",
          "enteredPriceUsed" : true,
          "groupID" : "groupID",
          "bornByDate" : "bornByDate",
          "promotionCode" : "promotionCode",
          "promotionServiceUserData" : "promotionServiceUserData",
          "weight" : "weight",
          "eventType" : "eventType",
          "isVoided" : true,
          "barcodeFamily" : "barcodeFamily",
          "raincheckKeyed" : true,
          "weightOrigin" : "weightOrigin",
          "linkedItemID" : "linkedItemID",
          "departmentNumber" : "departmentNumber",
          "quantityEntries" : [ {
            "unitPrice" : "unitPrice",
            "ordinalNumber" : "ordinalNumber",
            "voidedItemOrdinalNumber" : "voidedItemOrdinalNumber",
            "lastMatchedOrdinal" : "lastMatchedOrdinal"
          }, {
            "unitPrice" : "unitPrice",
            "ordinalNumber" : "ordinalNumber",
            "voidedItemOrdinalNumber" : "voidedItemOrdinalNumber",
            "lastMatchedOrdinal" : "lastMatchedOrdinal"
          } ],
          "limitedQuantityDiscountDealLimit" : "limitedQuantityDiscountDealLimit",
          "itemTaxable" : true,
          "nrscUserData2" : "nrscUserData2",
          "itemIDQualifier" : "itemIDQualifier",
          "itemType" : "itemType",
          "requiredAge" : "requiredAge",
          "linkedItemIDQualifier" : "linkedItemIDQualifier",
          "description" : "description",
          "itemID" : "itemID",
          "depositKeyUsed" : true,
          "isQuantityRequired" : true,
          "returnReason" : "returnReason",
          "lastMatchedOrdinal" : "lastMatchedOrdinal",
          "foodstampEligible" : true,
          "quantity" : "quantity",
          "printLines" : [ {
            "centered" : true,
            "lineType" : "lineType",
            "columnsToPrint" : "columnsToPrint",
            "lineCategory" : "lineCategory",
            "signatureLine" : "signatureLine",
            "filteredData" : "filteredData",
            "rawData" : "rawData",
            "linefeeds" : "linefeeds",
            "font" : "font"
          }, {
            "centered" : true,
            "lineType" : "lineType",
            "columnsToPrint" : "columnsToPrint",
            "lineCategory" : "lineCategory",
            "signatureLine" : "signatureLine",
            "filteredData" : "filteredData",
            "rawData" : "rawData",
            "linefeeds" : "linefeeds",
            "font" : "font"
          } ],
          "deptKey" : "deptKey",
          "reducePrice" : "reducePrice",
          "voidedItemOrdinalNumber" : "voidedItemOrdinalNumber",
          "manualTareId" : "manualTareId",
          "enteredQuantityUsed" : true,
          "tareWeight" : "tareWeight"
        }, {
          "isReturn" : true,
          "dealQuantity" : "dealQuantity",
          "isDiscountable" : true,
          "pricingMethod" : "pricingMethod",
          "wicEligible" : true,
          "dealPrice" : "dealPrice",
          "isDeposit" : true,
          "itemRepeatAllowed" : true,
          "promotionServiceID" : "promotionServiceID",
          "limitedQuantityDiscountUnitPriceQuantity" : "limitedQuantityDiscountUnitPriceQuantity",
          "restricts" : [ {
            "startMonth" : "startMonth",
            "endDate" : "endDate",
            "startDay" : "startDay",
            "endDay" : "endDay",
            "startTime" : "startTime",
            "endTime" : "endTime",
            "endMonth" : "endMonth",
            "reversed" : true,
            "startDate" : "startDate"
          }, {
            "startMonth" : "startMonth",
            "endDate" : "endDate",
            "startDay" : "startDay",
            "endDay" : "endDay",
            "startTime" : "startTime",
            "endTime" : "endTime",
            "endMonth" : "endMonth",
            "reversed" : true,
            "startDate" : "startDate"
          } ],
          "extendedPrice" : "extendedPrice",
          "fixedValueAmount" : "fixedValueAmount",
          "itemOrdinalNumber" : "itemOrdinalNumber",
          "checkDigit" : true,
          "barcode" : "barcode",
          "isQuantityAllowed" : true,
          "promotionServiceGiftCardID" : "promotionServiceGiftCardID",
          "unitPrice" : "unitPrice",
          "enteredPriceUsed" : true,
          "groupID" : "groupID",
          "bornByDate" : "bornByDate",
          "promotionCode" : "promotionCode",
          "promotionServiceUserData" : "promotionServiceUserData",
          "weight" : "weight",
          "eventType" : "eventType",
          "isVoided" : true,
          "barcodeFamily" : "barcodeFamily",
          "raincheckKeyed" : true,
          "weightOrigin" : "weightOrigin",
          "linkedItemID" : "linkedItemID",
          "departmentNumber" : "departmentNumber",
          "quantityEntries" : [ {
            "unitPrice" : "unitPrice",
            "ordinalNumber" : "ordinalNumber",
            "voidedItemOrdinalNumber" : "voidedItemOrdinalNumber",
            "lastMatchedOrdinal" : "lastMatchedOrdinal"
          }, {
            "unitPrice" : "unitPrice",
            "ordinalNumber" : "ordinalNumber",
            "voidedItemOrdinalNumber" : "voidedItemOrdinalNumber",
            "lastMatchedOrdinal" : "lastMatchedOrdinal"
          } ],
          "limitedQuantityDiscountDealLimit" : "limitedQuantityDiscountDealLimit",
          "itemTaxable" : true,
          "nrscUserData2" : "nrscUserData2",
          "itemIDQualifier" : "itemIDQualifier",
          "itemType" : "itemType",
          "requiredAge" : "requiredAge",
          "linkedItemIDQualifier" : "linkedItemIDQualifier",
          "description" : "description",
          "itemID" : "itemID",
          "depositKeyUsed" : true,
          "isQuantityRequired" : true,
          "returnReason" : "returnReason",
          "lastMatchedOrdinal" : "lastMatchedOrdinal",
          "foodstampEligible" : true,
          "quantity" : "quantity",
          "printLines" : [ {
            "centered" : true,
            "lineType" : "lineType",
            "columnsToPrint" : "columnsToPrint",
            "lineCategory" : "lineCategory",
            "signatureLine" : "signatureLine",
            "filteredData" : "filteredData",
            "rawData" : "rawData",
            "linefeeds" : "linefeeds",
            "font" : "font"
          }, {
            "centered" : true,
            "lineType" : "lineType",
            "columnsToPrint" : "columnsToPrint",
            "lineCategory" : "lineCategory",
            "signatureLine" : "signatureLine",
            "filteredData" : "filteredData",
            "rawData" : "rawData",
            "linefeeds" : "linefeeds",
            "font" : "font"
          } ],
          "deptKey" : "deptKey",
          "reducePrice" : "reducePrice",
          "voidedItemOrdinalNumber" : "voidedItemOrdinalNumber",
          "manualTareId" : "manualTareId",
          "enteredQuantityUsed" : true,
          "tareWeight" : "tareWeight"
        } ],
        "itemPrice" : "1.00",
        "isAdditionalItem" : "true",
        "keyedInput" : "keyedInput",
        "tareWeight" : "tareWeight",
        "aefCouponEvents" : [ {
          "addKeyForVoid" : true,
          "itemIDQualifier" : "itemIDQualifier",
          "itemType" : "itemType",
          "dealQuantity" : "dealQuantity",
          "reducesTaxDue" : "reducesTaxDue",
          "requiredAge" : "requiredAge",
          "matchingItem" : {
            "ordinalNumber" : "ordinalNumber",
            "couponValue" : "couponValue"
          },
          "linkedItemIDQualifier" : "linkedItemIDQualifier",
          "pricingMethod" : "pricingMethod",
          "description" : "description",
          "wicEligible" : true,
          "dealPrice" : "dealPrice",
          "isDeposit" : true,
          "itemRepeatAllowed" : true,
          "promotionServiceID" : "promotionServiceID",
          "itemModifier" : "itemModifier",
          "itemID" : "itemID",
          "restricts" : [ {
            "startDay" : "startDay",
            "endDay" : "endDay",
            "start" : "start",
            "end" : "end",
            "startTime" : "startTime",
            "endTime" : "endTime",
            "day" : "day",
            "reversed" : true
          }, {
            "startDay" : "startDay",
            "endDay" : "endDay",
            "start" : "start",
            "end" : "end",
            "startTime" : "startTime",
            "endTime" : "endTime",
            "day" : "day",
            "reversed" : true
          } ],
          "reducesFoodStampBalanceDue" : true,
          "reducedPrice" : "reducedPrice",
          "couponType" : "couponType",
          "manufacturerNumber" : "manufacturerNumber",
          "automaticCoupon" : true,
          "fixedValueAmount" : "fixedValueAmount",
          "value" : "value",
          "unitPrice" : "unitPrice",
          "ordinalNumber" : "ordinalNumber",
          "quantity" : "quantity",
          "isRefunded" : true,
          "printLines" : [ {
            "centered" : true,
            "lineType" : "lineType",
            "columnsToPrint" : "columnsToPrint",
            "lineCategory" : "lineCategory",
            "signatureLine" : "signatureLine",
            "filteredData" : "filteredData",
            "rawData" : "rawData",
            "linefeeds" : "linefeeds",
            "font" : "font"
          }, {
            "centered" : true,
            "lineType" : "lineType",
            "columnsToPrint" : "columnsToPrint",
            "lineCategory" : "lineCategory",
            "signatureLine" : "signatureLine",
            "filteredData" : "filteredData",
            "rawData" : "rawData",
            "linefeeds" : "linefeeds",
            "font" : "font"
          } ],
          "enteredPriceUsed" : true,
          "groupID" : "groupID",
          "promotionServiceUserData" : "promotionServiceUserData",
          "weight" : "weight",
          "percentageOff" : "percentageOff",
          "eventType" : "eventType",
          "isVoided" : true,
          "netValueAmount" : "netValueAmount",
          "volume" : "volume",
          "weightOrigin" : "weightOrigin",
          "promotionServiceCouponID" : "promotionServiceCouponID",
          "linkedItemID" : "linkedItemID",
          "departmentNumber" : "departmentNumber",
          "itemTaxable" : true,
          "enteredQuantityUsed" : true
        }, {
          "addKeyForVoid" : true,
          "itemIDQualifier" : "itemIDQualifier",
          "itemType" : "itemType",
          "dealQuantity" : "dealQuantity",
          "reducesTaxDue" : "reducesTaxDue",
          "requiredAge" : "requiredAge",
          "matchingItem" : {
            "ordinalNumber" : "ordinalNumber",
            "couponValue" : "couponValue"
          },
          "linkedItemIDQualifier" : "linkedItemIDQualifier",
          "pricingMethod" : "pricingMethod",
          "description" : "description",
          "wicEligible" : true,
          "dealPrice" : "dealPrice",
          "isDeposit" : true,
          "itemRepeatAllowed" : true,
          "promotionServiceID" : "promotionServiceID",
          "itemModifier" : "itemModifier",
          "itemID" : "itemID",
          "restricts" : [ {
            "startDay" : "startDay",
            "endDay" : "endDay",
            "start" : "start",
            "end" : "end",
            "startTime" : "startTime",
            "endTime" : "endTime",
            "day" : "day",
            "reversed" : true
          }, {
            "startDay" : "startDay",
            "endDay" : "endDay",
            "start" : "start",
            "end" : "end",
            "startTime" : "startTime",
            "endTime" : "endTime",
            "day" : "day",
            "reversed" : true
          } ],
          "reducesFoodStampBalanceDue" : true,
          "reducedPrice" : "reducedPrice",
          "couponType" : "couponType",
          "manufacturerNumber" : "manufacturerNumber",
          "automaticCoupon" : true,
          "fixedValueAmount" : "fixedValueAmount",
          "value" : "value",
          "unitPrice" : "unitPrice",
          "ordinalNumber" : "ordinalNumber",
          "quantity" : "quantity",
          "isRefunded" : true,
          "printLines" : [ {
            "centered" : true,
            "lineType" : "lineType",
            "columnsToPrint" : "columnsToPrint",
            "lineCategory" : "lineCategory",
            "signatureLine" : "signatureLine",
            "filteredData" : "filteredData",
            "rawData" : "rawData",
            "linefeeds" : "linefeeds",
            "font" : "font"
          }, {
            "centered" : true,
            "lineType" : "lineType",
            "columnsToPrint" : "columnsToPrint",
            "lineCategory" : "lineCategory",
            "signatureLine" : "signatureLine",
            "filteredData" : "filteredData",
            "rawData" : "rawData",
            "linefeeds" : "linefeeds",
            "font" : "font"
          } ],
          "enteredPriceUsed" : true,
          "groupID" : "groupID",
          "promotionServiceUserData" : "promotionServiceUserData",
          "weight" : "weight",
          "percentageOff" : "percentageOff",
          "eventType" : "eventType",
          "isVoided" : true,
          "netValueAmount" : "netValueAmount",
          "volume" : "volume",
          "weightOrigin" : "weightOrigin",
          "promotionServiceCouponID" : "promotionServiceCouponID",
          "linkedItemID" : "linkedItemID",
          "departmentNumber" : "departmentNumber",
          "itemTaxable" : true,
          "enteredQuantityUsed" : true
        } ]
      } ],
      "purgeCRAfterSerialize" : true,
      "retrieveInfo" : {
        "terminalNumber" : 2,
        "transactionNumber" : 4,
        "resultMessage" : "resultMessage"
      }
    }
  },
  "clientInfo" : {
    "attributes" : {
      "mobile" : true,
      "isMobile" : "true",
      "isAssociateFacing" : "true"
    },
    "type" : "MOBILE_POS",
    "uuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  },
  "requestResponseInfo" : {
    "responseType" : "PROCESS_TRANSACTION",
    "requestType" : "PROCESS_TRANSACTION",
    "applicationContext" : "applicationContext",
    "errorReason" : "errorReason",
    "responseSequence" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation body

400

Invalid Item supplied

401

Unauthorized Response Body

404

Item not found

500

Internal Server Error
Up 
get /status/v1
Retrieves information and current status of Novos Server (getNovosStatus)
Prcvides information and current status of Novos Server.

Return type

NovosStatus

Example data

Content-Type: application/json
{
  "systemConfiguration" : "systemConfiguration",
  "initialized" : true,
  "version" : "version"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation NovosStatus
Up 
get /status/v2
Retrieves information and current status of Novos Server (getNovosStatusV2)
Prcvides information and current status of Novos Server.

Return type

NovosStatusV2

Example data

Content-Type: application/json
{
  "onlineToController" : true,
  "storeNumber" : "storeNumber",
  "sessionsAvailable" : 0,
  "susRetIndexFileAvailable" : "true",
  "onlineToApplication" : true,
  "eslOnlyStore" : "true",
  "startupTime" : "startupTime",
  "version" : "version",
  "retrievedTransactionsMonitorEnabled" : true,
  "systemConfiguration" : "systemConfiguration",
  "terminalsCount" : "terminalsCount",
  "accept0PriceCheckDigit" : "true",
  "initialized" : true,
  "managerIDMustBeScannedConfiguredCorrectly" : "true",
  "posApplicationName" : "posApplicationName",
  "retrievedTransactionsMonitorConfigProcessed" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation NovosStatusV2
Up 
get /acews/pricedb/v1
Retreive item pricing records from the sales application pricing database (getPriceDb)
Provides access the pricing database used by the sales application to calculate item sale prices. The endpoint provides an interface that allows the client to request the entire price database or request that only changes occurring after an arbitray point in time be returned. Time is tracked using Linux/Unix timestamp values (milliseconds since the epoch)

Query parameters

timestamp (optional)
Query Parameter — If timestamp is omitted the API returns all records in the pricing database. Otherwise if timestamp is provided the API returns all records that were added, modified or delete subsequent to that point in time. default: null format: int32

Return type

array[PriceDbItem]

Example data

Content-Type: application/json
{
  "unitPrice" : 14658129,
  "saleQuantity" : 59,
  "restrictedSaleItem" : 7,
  "storeNumber" : 7,
  "picklistItem" : 1,
  "restrictedSaleType" : 22,
  "priceRequired" : 9,
  "pricingMethod" : 0,
  "itemCode" : "itemCode",
  "aliasItemCode" : "aliasItemCode",
  "flags" : "flags",
  "wicEligible" : 1,
  "dealPrice" : 59621338,
  "quantityRequired" : 2,
  "quantityAllowed" : 3,
  "embeddedPriceOrWeight" : 7,
  "departmentNumber" : "departmentNumber",
  "action" : "I",
  "weightRequired" : 4,
  "itemDescription" : "itemDescription",
  "foodstampEligible" : 6,
  "itemNotForSale" : 5,
  "timestamp" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

500

server fault during operation

Models

[ Jump to Methods ]

Table of Contents

  1. AefCouponEvent -
  2. AefItemEvent -
  3. ApplicationContext -
  4. ApplicationStatus -
  5. AurusTender -
  6. BarcodeType -
  7. CashTender -
  8. ClientInfo -
  9. ClientInfoAttributes -
  10. ClientTendered -
  11. CouponRestrict -
  12. CustomerInfo -
  13. Discount -
  14. ExceptionItem -
  15. ItemRestrict -
  16. ItemType -
  17. MatchingItem -
  18. NovosStatus -
  19. NovosStatusV2 -
  20. OperatorInfo -
  21. PriceDbItem -
  22. PriceVerify -
  23. PrintLine -
  24. QuantityEntry -
  25. RequestResponseInfo -
  26. Result -
  27. RetrieveInfo -
  28. StatusCode -
  29. SuspendInfo -
  30. TenderExtension -
  31. TenderResult -
  32. Tenders_inner -
  33. Total -
  34. TransItem -
  35. Transaction -
  36. body -

AefCouponEvent - Up

addKeyForVoid (optional)
Boolean
automaticCoupon (optional)
Boolean
couponType (optional)
String
dealPrice (optional)
String
dealQuantity (optional)
String
departmentNumber (optional)
String
description (optional)
String
enteredPriceUsed (optional)
Boolean
enteredQuantityUsed (optional)
Boolean
eventType (optional)
String
groupID (optional)
String
isDeposit (optional)
Boolean
isRefunded (optional)
Boolean
isVoided (optional)
Boolean
itemID (optional)
String
itemIDQualifier (optional)
String
itemModifier (optional)
String
itemRepeatAllowed (optional)
Boolean
itemTaxable (optional)
Boolean
itemType (optional)
String
linkedItemID (optional)
String
linkedItemIDQualifier (optional)
String
manufacturerNumber (optional)
String
ordinalNumber (optional)
String
pricingMethod (optional)
String
quantity (optional)
String
reducedPrice (optional)
String
reducesFoodStampBalanceDue (optional)
Boolean
reducesTaxDue (optional)
String
requiredAge (optional)
String
unitPrice (optional)
String
value (optional)
String
volume (optional)
String
weight (optional)
String
weightOrigin (optional)
String
wicEligible (optional)
Boolean
matchingItem (optional)
MatchingItem
promotionServiceID (optional)
String
promotionServiceCouponID (optional)
String
percentageOff (optional)
String
fixedValueAmount (optional)
String
netValueAmount (optional)
String
promotionServiceUserData (optional)
String
printLines (optional)
array[PrintLine]
restricts (optional)
array[CouponRestrict]

AefItemEvent - Up

barcodeFamily (optional)
String
barcode (optional)
String
bornByDate (optional)
String
checkDigit (optional)
Boolean
dealPrice (optional)
String
dealQuantity (optional)
String
departmentNumber (optional)
String
deptKey (optional)
String
description (optional)
String
enteredPriceUsed (optional)
Boolean
enteredQuantityUsed (optional)
Boolean
eventType (optional)
String
extendedPrice (optional)
String
fixedValueAmount (optional)
String
foodstampEligible (optional)
Boolean
groupID (optional)
String
isDeposit (optional)
Boolean
isDiscountable (optional)
Boolean
isQuantityAllowed (optional)
Boolean
isQuantityRequired (optional)
Boolean
isReturn (optional)
Boolean
isVoided (optional)
Boolean
itemID (optional)
String
itemIDQualifier (optional)
String
itemOrdinalNumber (optional)
String
itemRepeatAllowed (optional)
Boolean
itemTaxable (optional)
Boolean
itemType (optional)
String
lastMatchedOrdinal (optional)
String
linkedItemID (optional)
String
linkedItemIDQualifier (optional)
String
manualTareId (optional)
String
nrscUserData2 (optional)
String
pricingMethod (optional)
String
promotionCode (optional)
String
promotionServiceGiftCardID (optional)
String
promotionServiceID (optional)
String
promotionServiceUserData (optional)
String
quantity (optional)
String
raincheckKeyed (optional)
Boolean
reducePrice (optional)
String
requiredAge (optional)
String
returnReason (optional)
String
tareWeight (optional)
String
unitPrice (optional)
String
voidedItemOrdinalNumber (optional)
String
weight (optional)
String
weightOrigin (optional)
String
wicEligible (optional)
Boolean
depositKeyUsed (optional)
Boolean
limitedQuantityDiscountDealLimit (optional)
String
limitedQuantityDiscountUnitPriceQuantity (optional)
String
printLines (optional)
array[PrintLine]
quantityEntries (optional)
array[QuantityEntry]
restricts (optional)
array[ItemRestrict]

ApplicationContext - Up

clientSequenceID (optional)
UUID format: uuid
result (optional)
String Status returned by the application for last lookup
* OK - The last lookup was successful
* ITEM_ERR - One or more items in the last lookup had an error in processing
* DISCOUNT_ERR - Unable to add transaction discount
* NO_SESSIONS_AVAILABLE - Terminal Concentrator/Controller not available or system taxed.
* INVALID_REQUEST - The requested operation is invalid
* TENDER_ERR - There was an error encountered when tendering the transaction
* ITEM_VOID_ERROR - The requested item void action could not be completed
* INTERNAL_SERVER_ERROR - The requested caused an unexpected and unhandled error in the server.
* OPERATOR_CONFIG_ERR - Novos was unable to sign on due to invalid operator configuration
* OVERLAPPED_REQUESTS_NOT_ALLOWED - The request was rejected because another request for this client is still being processed
* OFFLINE_FROM_CONTROLLER - Novos is offline from the 4690 controller and the request cannot be processed
* NO_SESSION_FOR_TERM - no terminal is mapped for the requested ClientInfo.uuid
* NO_SESSIONS_AVAILABLE_STILL_INITIALIZING - Terminal Concentrator/Controller not available, still initializing
* RETRIEVE_NOT_SUPPORTED - Retrieve functionality not currenty supported
* UNABLE_TO_RETRIEVE_TRANSACTION - Unable to retrieve the requested transaction
* UNABLE_TO_START_REFUNDS_TRANSACTION - Unable to start a refunds transaction
* GENERAL_FAILURE_PLEASE_TRY_AGAIN - Terminal has encountered a general failure and will be reset. Please send transaction again.
Enum:
OK
ITEM_ERR
DISCOUNT_ERR
NO_SESSIONS_AVAILABLE
INVALID_REQUEST
TENDER_ERR
ITEM_VOID_ERROR
INTERNAL_SERVER_ERROR
OPERATOR_CONFIG_ERR
OVERLAPPED_REQUESTS_NOT_ALLOWED
OFFLINE_FROM_CONTROLLER
NO_SESSION_FOR_TERM
NO_SESSIONS_AVAILABLE_STILL_INITIALIZING
RETRIEVE_NOT_SUPPORTED
UNABLE_TO_RETRIEVE_TRANSACTION
UNABLE_TO_START_REFUNDS_TRANSACTION
GENERAL_FAILURE_PLEASE_TRY_AGAIN
resultMessage (optional)
String Potentially additional information about result.
responseSequenceNumber (optional)
Integer
responseTime (optional)
String Maximum time required to respond to item lookups in milliseconds
operatorInfo (optional)
OperatorInfo
applStatus (optional)
ApplicationStatus
transaction (optional)
Transaction

ApplicationStatus - Up

txnVoidPending (optional)
Boolean Indication of whether or not a void is pending
txnInProgress (optional)
Boolean Indication of whether or not a transaction is in progress
txnVoidOrTenderRequired (optional)
Boolean Indication of whether or not a void or tender is required

AurusTender - Up

tenderType (optional)
String
result (optional)
TenderResult
clientItemID (optional)
String
tenderExtension (optional)
TenderExtension
tenderAmount (optional)
Integer The amount of the tender. Read-only. Returned in response. Aurus tenders tender the remaining balance of the transaction. No split tenders.
message (optional)
String Textual message associated with the tender result.
approvalCode (optional)
String
auditFlags (optional)
String
completeOnDecline (optional)
Boolean

BarcodeType - Up


CashTender - Up

tenderAmount (optional)
Integer
clientItemID (optional)
String
message (optional)
String Textual message associated with the tender result.
result (optional)
TenderResult
tenderType (optional)
String

ClientInfo - Up

uuid (optional)
UUID

This field is used to uniquely idenify devices - Use one per device (cart, e-tag, etc). You can use your session ID for uuid so long as it’s unique within a given store. The value is not interpreted, it's just compared to uuids for previous requests to find your session. Note that a transaction cane be reset in 2 ways

  • Change the clientInfo.uuid to a new, unique value. The next request you make with that uuid will cause us to throw away your previous transaction.
  • change "applicationContext" variables as noted in that property.
format: uuid
type (optional)
String Type of Point-of-Sale application
Enum:
MOBILE_POS
VENDING_MACHINE
REFUND_CLIENT
attributes (optional)
ClientInfoAttributes

ClientInfoAttributes - Up

mobile (optional)
Boolean Client supports mobile - This must be set true
isMobile (optional)
String Client is mobile
Enum:
true
false
isAssociateFacing (optional)
String Client is mobile
Enum:
true
false

ClientTendered - Up

tenderAmount (optional)
Integer
clientItemID (optional)
String
message (optional)
String Textual message associated with the tender result.
result (optional)
TenderResult
tenderType (optional)
String
cardType (optional)
String
accountNumber (optional)
String
auditFlags (optional)
String

CouponRestrict - Up

reversed (optional)
Boolean
day (optional)
String
start (optional)
String
end (optional)
String
startDay (optional)
String
endDay (optional)
String
startTime (optional)
String
endTime (optional)
String

CustomerInfo - Up

loyaltyAccountNumber (optional)
String The customer's loyalty account number
loyaltyAccountType (optional)
String The type of loyalty account number as defined by Toshiba ACE
Always set to the value 'LOYALTY_NUMBER'
scannedInput (optional)
String if scanned item the barcode that was scanned
scannedInputLabelType (optional)
BarcodeType
keyedInput (optional)
String The customer's loyalty account number if entered at the keyboard as
* rather than being scanned
alternateId (optional)
String The digits of the customer's alternate loyalty Id (phone number for example.
* This field is input only from the client. If a request is received with a alternateId but no
* loyalty account number, it's assumed the client wishes to retrieve the
* customer's loyalty account information using the customer's alternateId.
loyaltyAuditFlags (optional)
String

When a loyalty account is added to a transaction the server may be perform override actions to permit the operation.
* These flags convey to the API client which if any override actions were performed during the processing of loyalty information.

  • Offset 0 Keyed loyalty account number override performed
    . : no override was performed processing keyed loyalty information
    O : operator-initiated override performed while processing keyed loyalty information
    M : manager-initiated override performed while processing keyed loyalty information
  • Offset 1 Change loyalty account override performed. Changing the loyalty information from one account to another on a given transaction can require an override
    . : no override was performed changing loyalty account information
    O : operator-initiated override performed while changing loyalty account information
    M : manager-initiated override performed while changing loyalty account information
  • Offset 2-19 : Reserved
result (optional)
Result
resultMessage (optional)
String Additional information pertaining to the value of the result of
* loyalty account lookup

Discount - Up

groupId (optional)
Integer Discount group id to be applied to the transaction
taxExemptId (optional)
String Tax exempt id when discount is a Tax Exemption discount
amount (optional)
String Discount amount
description (optional)
String The description of the discount
result (optional)
Result
resultMessage (optional)
String Addttional information pertaining to the processing of the discount

ExceptionItem - Up

result (optional)
Result
itemType (optional)
ItemType
keyedInput (optional)
String The customer's loyalty account number if entered at the keyboard as
* rather than being scanned
itemSaleAuditFlags (optional)
String

When an item is added to a transaction the server may be perform override actions to permit the item's sale. These flags convey to the API client which if any override actions were performed during the processing/pricing of this item.

  • Offset 0 Quantity override audit flag:
    . : no quantity override performed during item processing
    O : operator-initiated quantity override performed during item processing
    M : manager-initiated quantity override performed during item processing
  • Offset 1 Dollar amount override audit flag:
    . : no dollar amount override performed during item processing
    O : operator-initiated dollar amount override performed during item processing
    M : manager-initiated dollar amount override performed during item processing
  • Offset 2 Restricted age audit flag:
    . : no age restriction on item
    0 : Restricted age - 16
    1 : Restricted age - 17
    2 : Restricted age - 18
    3 : Restricted age - 19
    4 : Restricted age - 20
    5 : Restricted age - 21
  • Offset 3 Price manually entered from scanned EAN-13/NS2 barcode:
    . : no price manually entered from scanned EAN-13/NS2 barcode
    1 : price manually entered from scanned EAN-13/NS2 barcode when prompted Enter Price
  • Offset 4-19 : Reserved


    Toshiba ACE Note: Quantity limits on item sales are controlled by application personalization options and by department group definitions.

resultErrorDescription (optional)
String This is the text for the error
quantity (optional)
Integer The quantity of this item
weight (optional)
Integer Weight of item being sold in hundredths of a unit
dateOfBirth (optional)
String Purchaser's date of birth. Required when the sale of an item is restricted based on the age of the purchaser.
Format: MMDDYYYY
isAdditionalItem (optional)
String The item was added to the cart by the POS application. A loyalty coupon is a good example of an additional item.
Enum:
true
false
scannedInput (optional)
String if scanned item the barcode that was scanned
scannedInputLabelType (optional)
BarcodeType
itemDescription (optional)
String The description of the failing item
clientItemID (optional)
UUID format: uuid
tareWeight (optional)
String For weighted items the tare weight of the item as configured in the item record file
netWeight (optional)
String For weighted items, the weight of goods sold which is the scale weight less the item's tare weight
clientPrice (optional)
String Used by the client application to provide a price for items which have the price required attribute on in the point of sale application
overridePrice (optional)
Boolean If this flag is set then the unit price of the item will be set to the clientPrice.
priceVerify (optional)
Boolean If this flag is set then a price verify will be performed for he item.
wicEligible (optional)
Boolean indication of whether item is WIC-eligible
foodstampEligible (optional)
Boolean indication of whether item is foodstamp-eligible
returnToStockAnswer (optional)
String Should the refund item be retured to stock
Enum:
ENTER
CLEAR

ItemRestrict - Up

reversed (optional)
Boolean
startMonth (optional)
String
endMonth (optional)
String
startDate (optional)
String
endDate (optional)
String
startDay (optional)
String
endDay (optional)
String
startTime (optional)
String
endTime (optional)
String

ItemType - Up

The ACE sales application item type for this item:
* 0 - Normal sale
* 1 - Deposit
* 2 - Refund
* 3 - Deposit return
* 4 - Misc. sale/payin
* 5 - Misc. payout
* 6 - Manufac. coupon
* 7 - Store coupon

MatchingItem - Up

ordinalNumber (optional)
String
couponValue (optional)
String

NovosStatus - Up

initialized (optional)
Boolean Indication of where Novos is intialized and ready to receive requests
version (optional)
String Novos version number
systemConfiguration (optional)
String System Configuration setting

NovosStatusV2 - Up

initialized (optional)
Boolean Indication of where Novos is intialized and ready to receive requests
version (optional)
String Novos version number
systemConfiguration (optional)
String System Configuration setting
terminalsCount (optional)
String Number of terminals configured in Novos
sessionsAvailable (optional)
Integer Number of available sessions
posApplicationName (optional)
String Name of POS application
eslOnlyStore (optional)
String Is Novos running in a ESL only store
Enum:
true
false
likely
likely not
possibly configured incorrectly
retrievedTransactionsMonitorConfigProcessed (optional)
Boolean Has the retreivedTransactionsMonitorConfig file been processed
retrievedTransactionsMonitorEnabled (optional)
Boolean Is retrieveTransactionsMonitor enabled
susRetIndexFileAvailable (optional)
String Is the suspend/Retreive Index File present on the controller
Enum:
true
false
Unknown
N/A
managerIDMustBeScannedConfiguredCorrectly (optional)
String Is the personalization option manager ID Must Be Scanned configured correctly
Enum:
true
false
accept0PriceCheckDigit (optional)
String Is personalization option accept 0 Price Check Digit enabled
Enum:
true
false
onlineToController (optional)
Boolean Is Terminal Concentrator online to the controller
onlineToApplication (optional)
Boolean Is Novos online/connected to POS application
storeNumber (optional)
String Store Number
startupTime (optional)
String Time when Novos was started

OperatorInfo - Up

operatorId (optional)
String The numeric operator identification number
operatorPw (optional)
String The numeric operator password
signOnState (optional)
String Indicates the status of the operation sign-on
Enum:
SignedOn
SignedOff
Locked
Unknown
result (optional)
StatusCode

PriceDbItem - Up

action
String Last action applied to this record in the database:
* I - record was inserted during a database update.
* U - record was updated during a database update.
Enum:
I
U
itemCode
String The unique item code for this item.
aliasItemCode
String When item pricing method is alias pricing, the item code that should be used to calculate the price for this item.
itemDescription
String The textual description for this item that will display on the sales receipt.
itemType
ItemType
pricingMethod
Integer The ACE sales application pricing method for this item:
* 0 - Split package pricing
* 1 - Base-Plus-One pricing
* 2 - Group-Threshold pricing
* 3 - Group-Adjusted pricing
* 4 - Unit-Adjusted pricing
* 5 - Alias pricing method format: int8
Enum:
0
1
2
3
4
5
saleQuantity
Integer Quantity used to calculate group pricing when using a group pricing method (pricing methods 1-4)
unitPrice
Integer Unit price of the item
dealPrice
Integer Deal price of the group if using group pricing method (pricing methods 1-4)
itemNotForSale
Integer Indicates if this item is not for sale
* 1 - Item is not for sale
* 0 - Item is for sale format: int8
Enum:
1
0
restrictedSaleType
Integer Indicates that this item is a restricted sale item. For example, tobacco and alcohol sales are often restricted to customers age 21 and above. Pseudoephedrine is commonly restricted in the quantity that may be purchased.

These restriction types are retailer defined. You must know how each retailer defines the restriction type to understand what type of item controls need to be applied to the sale of this item
* 0 - Item sale has no restricted sale type (unrestricted)
* > 0 - Item is restricted format: int8
restrictedSaleItem
Integer Indicates the item has restricted sales hours
* 1 - The item has restricted sale hours
* 0 - The item has no restricted sale hours format: int8
Enum:
1
0
priceRequired
Integer Indicates that a price must be provided in order to sell this item
* 1 - Price is required
* 0 - Price will be calulated by the sales application format: int8
Enum:
1
0
quantityAllowed
Integer Indicates that this item is allowed to be sold using the quantity modifier
* 1 - Quantity modifier allowed to be used on this item
* 0 - Quantity modifier not allowed to be used on this item format: int8
Enum:
1
0
quantityRequired
Integer Indicates that the quantity of item to be sold must be provided.
* 1 - Quantity must be provided
* 0 - Quantity not required format: int8
Enum:
1
0
weightRequired
Integer Indicates that the weigth of item to be sold must be provided.
* 1 - Weight must be provided
* 0 - Weight not required format: int8
Enum:
1
0
embeddedPriceOrWeight
Integer This item code uses embedded price or weight in the barcode
* 1 - The barcode contains an embedded priced or weight
* 0 - The barcode does not contain an embedded price or weight format: int8
Enum:
1
0
picklistItem
Integer This item code can be displayed in a pick list. Typically items sold by PLU such as bakery and produce.
* 1 - The item should be displayed in a pick list
* 0 - The item should not be displayed in a pick list format: int8
Enum:
1
0
timestamp
Integer The Linux/Unix timestamp value (milliseconds since the epoch) marking the time when this item was last modified in the price database. format: int32
flags
String Addition flags associated with this item in the price database.
  • Offset 0 Item deleted flag:
    Y : item has been deleted from the database
    N : item has not beed deleted from the database
  • Offset 1 Coupon linkage indicator. For store and manufacturer coupons, flag shows if coupon is used as the linked item or large linked item for
    1 : coupon is referenced by a single item in the price database (variety coupon
    M : coupon is referenced by mulptiple items in the price database (brand/flavor coupon)
    . : coupon is not referenced by any items in the price database
  • Offset 2-9 : Reserved
departmentNumber
String The department number the item is assigned to from the ACE pricing database
wicEligible
Integer Flag indicating if this item is WIC eligible or not.
* 1 - The item is WIC eligible
* 0 - The item is not WIC eligible format: int8
foodstampEligible
Integer Flag indicating if this item is foodstamp eligible or not.
* 1 - The item is foodstamp eligible
* 0 - The item is not foodstamp eligible format: int8
storeNumber
Integer Store Number format: int8

PriceVerify - Up

This object contains the values returned from a Price Verify
responseCode
String OK or error indicating reason for failure
Enum:
OK
B076 AUTHORIZATION REQUIRED
B027 NOT FOR SALE
B019 WEIGHT NEEDED
B029 QUANTITY NEEDED
itemNumber (optional)
String Item number used for lookup from Item Record File
itemDescription (optional)
String Description of item from lookup file
wicEligible (optional)
Boolean indication of whether item is WIC-eligible
itemDepartment (optional)
String Department number that applies to item
foodstampEligible (optional)
Boolean indication of whether item is foodstamp-eligible
unitPrice (optional)
String Item Price
requiredAge (optional)
Integer Age that is required for purchase of this item format: int32
bornByDate (optional)
String Minimum date that eligible purchaser must have been born by (yyyymmdd)

PrintLine - Up

centered (optional)
Boolean
linefeeds (optional)
String
font (optional)
String
lineType (optional)
String
lineCategory (optional)
String
signatureLine (optional)
String
filteredData (optional)
String
columnsToPrint (optional)
String
rawData (optional)
String

QuantityEntry - Up

ordinalNumber (optional)
String
unitPrice (optional)
String
voidedItemOrdinalNumber (optional)
String
lastMatchedOrdinal (optional)
String

RequestResponseInfo - Up

statusCode (optional)
StatusCode
requestType (optional)
String
Enum:
PROCESS_TRANSACTION
responseType (optional)
String
Enum:
PROCESS_TRANSACTION
responseSequence (optional)
Integer
errorReason (optional)
String Description of error
applicationContext (optional)
String Context of Client application

Result - Up

Indication of result of item processing
* OK - Item processed successfully with no errors
* ERROR - Unable to process item, general error
* INVALID_ENTRY - Incomplete or malformed input data for this operation
* AGE_RESTRICT - Item cannot be sold due to age restriction
* ITEM_LIMIT_CHECK - A non-overridable limit check has prevented the sale
* PRICE_LIMIT_CHECK - A non-overridable limit check has prevented the sale
* NOT_ON_FILE - The item is not in the pricing database
* TRACKING_ITEM_NOT_ON_FILE - the system is configured to add a tracking item to each transaction but the item to be added is not on file with th POS application
* ITEM_VOID_ERROR - The request to void the item could not be completed of this item.
* PRICE_ENTRY_REQUIRED - The item requires that the price be specified in order to sell
* UNEXPECTED_TERMINAL_STATE - The sales application is in the incorrect state for this operation
* NO_LOYALTY_DATA - Loyalty card/alternate ID processed by no loyalty account exists
* TIMEOUT_EXCEEDED - The operation took too long to complete
* UNABLE_TO_PERFORM_OVERRIDE - an override was required but could not be performed
* ITEM_WEIGHT_REQUIRED - Item is sold by weight and no weight was provided
* OFFLINE_FROM_CONTROLLER - Novos is offline to the 4690 controller and cannot sell the item
* NOT_A_LOYALTY_ID - Keyed or scanned data is not a loyalty identifier or card number
* QUANTITY_NOT_ALLOWED - Item cannot be sold with quantity modifier
* ITEM_NOT_FOR_SALE - Item is not authorized for sale
* NO_MORE_ITEMS_ALLOWED - The transaction is too large and must be ended. Only tender entries are accepted at this time.
* SIGNON_UNEXPECTED_TERMINAL_STATE - The terminal entered an unexpected state when attempting to sign on and processing cannot continue.
* DISCOUNT_ERR - Unable to add transaction discount
* KEYED_MANAGER_ID_NOT_ALLOWED - Manager id must be scanned.
* KEYED_ENTRY_NOT_ALLOWED - Keyed entry not allowed.
* COUPON_AS_FIRST_ITEM_NOT_ALLOWED - Coupon not allowed as first item.
* LIMITED_NUMBER_OF_COUPONS_PER_ORDER - Limited number of coupons per order exceeded
* MINIMUM_SALE_NOT_SATISFIED - Coupon not allowed when exceeds minimum sale amount
* GENERAL_FAILURE_PLEASE_TRY_AGAIN - Terminal has encountered a general failure and will be reset. Please send transaction again.

RetrieveInfo - Up

terminalNumber (optional)
Integer Terminal number of transaction to be retrieved
transactionNumber (optional)
Integer Transaction number of transaction to be retrieved
result (optional)
Result
resultMessage (optional)
String Addttional information pertaining to the processing of the discount

StatusCode - Up

Status code for Totals

SuspendInfo - Up

terminalNumber (optional)
Integer Terminal number of transaction being suspended
transactionNumber (optional)
Integer Transaction number of transaction being suspended
barCodeType (optional)
BarcodeType
barCodeData (optional)
String Data to be included in the barcode

TenderExtension - Up

Additional data required to perform tender. Requires custom Novos development and should only be populated when instructed by QVS.
custom1 (optional)
String Tender specific custom data 1. Set per instructions from QVS.
custom2 (optional)
String Tender specific custom data 2. Set per instructions from QVS.
custom3 (optional)
String Tender specific custom data 3. Set per instructions from QVS.
custom4 (optional)
String Tender specific custom data 4. Set per instructions from QVS.
custom5 (optional)
String Tender specific custom data 5. Set per instructions from QVS.
custom6 (optional)
String Tender specific custom data 6. Set per instructions from QVS.
custom7 (optional)
String Tender specific custom data 7. Set per instructions from QVS.
custom8 (optional)
String Tender specific custom data 8. Set per instructions from QVS.
custom9 (optional)
String Tender specific custom data 9. Set per instructions from QVS.
custom10 (optional)
String Tender specific custom data 10. Set per instructions from QVS.

TenderResult - Up

The result of tender processing

Tenders_inner - Up

Array of tenders on the transaction
tenderAmount (optional)
Integer The amount of the tender. Read-only. Returned in response. Aurus tenders tender the remaining balance of the transaction. No split tenders.
clientItemID (optional)
String
message (optional)
String Textual message associated with the tender result.
result (optional)
TenderResult
tenderType (optional)
String
cardType (optional)
String
accountNumber (optional)
String
auditFlags (optional)
String
tenderExtension (optional)
TenderExtension
approvalCode (optional)
String
completeOnDecline (optional)
Boolean

Total - Up

totalSavings (optional)
String Savings applled to this transaction from loyalty programs, etc.
foodStampTotal (optional)
String Total of transaction that is foodstamp-eligible
foodStampBalance (optional)
String Transaction balance that might be satisfied using foodstamps.
totalCouponCount (optional)
String Count of coupons in transaction
totalCouponAmount (optional)
String Amount of coupons in transaction
subTotal (optional)
String Subtotal of transaction
tax (optional)
String Tax applied to transaction
total (optional)
String Total of transaction
balanceDue (optional)
String Balance due after application of tender
changeDue (optional)
String Change due to customer after application of tender
totalItems (optional)
String count of items sold in transaction
tenderExchanged (optional)
String Amount of tender exchanged

TransItem - Up

linkedItemCode (optional)
String
result
Result
resultErrorDescription (optional)
String This is the text for the error
quantity (optional)
Integer The quantity of this item
scannedInput (optional)
String if scanned item the barcode that was scanned
scannedInputLabelType (optional)
BarcodeType
keyedInput (optional)
String Keyed item data
itemDescription (optional)
String The textual description for this item that will display on the sales receipt.
itemType (optional)
ItemType
itemCode (optional)
String The SKU or lookup number for the item
itemPrice (optional)
String The unit price of a single item, adjusted for discount
unitPrice (optional)
String The unit price of a single item, adjusted for discount
extendedPrice (optional)
String The price for this combination of SKU, quantity, and/or weight
regularPrice (optional)
String The regular price of the item
responseTime (optional)
Integer The response time for the lookup
clientItemID (optional)
UUID format: uuid
itemSaleAuditFlags (optional)
String

When an item is added to a transaction the server may be perform override actions to permit the item's sale. These flags convey to the API client which if any override actions were performed during the processing/pricing of this item.

  • Offset 0 Quantity override audit flag:
    . : no quantity override performed during item processing
    O : operator-initiated quantity override performed during item processing
    M : manager-initiated quantity override performed during item processing
  • Offset 1 Dollar amount override audit flag:
    . : no dollar amount override performed during item processing
    O : operator-initiated dollar amount override performed during item processing
    M : manager-initiated dollar amount override performed during item processing
  • Offset 2 Restricted age audit flag:
    . : no age restriction on item
    0 : Restricted age - 16
    1 : Restricted age - 17
    2 : Restricted age - 18
    3 : Restricted age - 19
    4 : Restricted age - 20
    5 : Restricted age - 21
  • Offset 3 Price manually entered from scanned EAN-13/NS2 barcode:
    . : no price manually entered from scanned EAN-13/NS2 barcode
    1 : price manually entered from scanned EAN-13/NS2 barcode when prompted Enter Price
  • Offset 4-19 : Reserved


    Toshiba ACE Note: Quantity limits on item sales are controlled by application personalization options and by department group definitions.

itemOrdinalNumber (optional)
Integer The sequence number of the item in relation to other items
linkedItemOrdinalNumber (optional)
Integer For items automatically added to the transaction by the sales application (coupons, deposit fees, etc.) this is the itemOrdinalNumber to which this item is linked.
weight (optional)
Integer Weight of item being sold in hundredths of a unit
value (optional)
String For coupon items, the value of the coupon
dateOfBirth (optional)
String Purchaser's date of birth. Required when the sale of an item is restricted based on the age of the purchaser.
Format: MMDDYYYY
isAdditionalItem (optional)
String The item was added to the cart by the POS application. A loyalty coupon is a good example of an additional item.
Enum:
true
false
isCouponItem (optional)
String This item is a coupon item
Enum:
true
false
tareWeight (optional)
String For weighted items the tare weight of the item as configured in the item record file
netWeight (optional)
String For weighted items, the weight of goods sold which is the scale weight less the item's tare weight
clientPrice (optional)
String Used by the client application to provide a price for items which have the price required attribute on in the point of sale application
aefItemEvents (optional)
array[AefItemEvent]
aefCouponEvents (optional)
array[AefCouponEvent]
overridePrice (optional)
Boolean If this flag is set then the unit price of the item will be set to the clientPrice.
priceVerify (optional)
Boolean If this flag is set then a price verify will be performed for he item.
foodstampEligible (optional)
Boolean Indicates if the item is foodstamp eligible.
wicEligible (optional)
Boolean Indicates if the item is WIC eligible.
returnToStockAnswer (optional)
String Should the refund item be retured to stock
Enum:
ENTER
CLEAR

Transaction - Up

actionType (optional)
String description: > Type of Transaction.
Normally "SALES" but can be used to void a transaction by setting to VOID and setting actionSubType to VOID

* SALES - Normal sales transaction
* REFUNDS - Normal refunds transaction
* VOID - Used with actionSubType to void the current transaction
* RETRIEVE - Used with actionSubType to retrieve a transaction - FUTURE
* RETRIEVE_AND_VOID - Used with actionSubType to retrieve and then void a transaction
Enum:
SALES
REFUNDS
VOID
RETRIEVE
RETRIEVE_AND_VOID
purgeDataAfterSerialize (optional)
Boolean
actionSubType (optional)
String description: > Sub-type of Transaction.
Normally "SALES" but can be used to void a transaction by setting to VOID and setting actionType to VOID

* SALES - Normal sales transaction
* REFUNDS - Normal refunds transaction
* VOID - Used with actionType to void the current transaction
* RETRIEVE - Used with actionType to retrieve a transaction - FUTURE
* RETRIEVE_AND_VOID - Used with actionType to retrieve and then void a transaction
Enum:
SALES
REFUNDS
VOID
RETRIEVE
RETRIEVE_AND_VOID
customerInfo (optional)
CustomerInfo
clientApplicationID (optional)
String Used to identify the client application to Novos. Use of this field requires custom Novos development and should be set when instructed by QVS.
items (optional)
array[TransItem] Array of all items in transaction
suspendTransaction (optional)
Boolean Indicates if transaction is suspended
exceptionItems (optional)
array[ExceptionItem] Array of all exception items in transaction
retrieveInfo (optional)
RetrieveInfo
suspendInfo (optional)
SuspendInfo
prepareToTender (optional)
Boolean Prepare the transaction to tender by totalling the transaction.
tenders (optional)
array[Tenders_inner]
totals (optional)
Total
purgeCRAfterSerialize (optional)
Boolean Purge Cash Receipt Buffer after printing
receiptDisplays (optional)
array[String] Array of all receipt display lines in transaction
receiptPrints (optional)
array[String] Array of all receipt print lines in transaction
transactionAuditFlags (optional)
String

While processing a transaction the server may be perform override actions or receive notification that pertain to the transaction as a whole, rather than to a specific item within the transaction. These flags convey to the API client which if any transaction level override actions that were performed or notifications received during the processing of a request.

  • Offset 0 Coupons must be returned flag.
    1 : Coupons were on the transaction when it was finalized (suspended or voided) and should be returned to the customer.
    . : Value not set.
  • Offset 2-19 : Reserved
discount (optional)
Discount

body - Up

requestResponseInfo (optional)
RequestResponseInfo
clientInfo (optional)
ClientInfo
applicationContext (optional)
ApplicationContext