{"swagger":"2.0","info":{"description":"\u003cdiv class='alert alert-warning' role='alert'\u003eThe Infor Partner API integration will require TLS 1.2 and we recommend the strongest cipher suites.\u003c/div\u003e","version":"1","title":"Infor Partner API specifications"},"host":"api.vivonet.com","basePath":"/","tags":[{"name":"menu/v1","description":"Menu API version 1"},{"name":"ordering/v1","description":"Ordering API version 1"},{"name":"configuration/v1","description":"Configuration API version 1"}],"schemes":["https"],"paths":{"/v1/stores/{storeId}/products":{"get":{"tags":["menu/v1"],"summary":"Products","description":"Returns a flat list of products for the terminal/store with Store ID passed as storeId parameter.  The request HTTP header should have x-api-key parameter with value of your API access key.","operationId":"products","produces":["application/json"],"parameters":[{"$ref":"#/parameters/xApiKeyParam"},{"$ref":"#/parameters/storeIdParam"},{"$ref":"#/parameters/productNameTargetParam"}],"responses":{"200":{"description":"Successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Product"}}},"204":{"description":"Data is not available"},"400":{"description":"Invalid ID supplied"},"493":{"description":"Not authorized"},"495":{"description":"Not authenticated"}}}},"/v1/stores/{storeId}/categories":{"get":{"tags":["menu/v1"],"summary":"Menu Categories","description":"\u003cp\u003eIf you are building a SaaS digital menu integration, then Categories will keep you on top of ever changing restaurant menus, whether at single or multiple locations for an operation. We recommend that you include the Menu Item Details resource in your build if you want an app representing an all-inclusive menu of a food service operation.\u003c/p\u003e \u003cp\u003eCategories represent menu layouts. Major Groups and Family Groups are the categories in the Infor lexicon. Groups are a convenient way for food service providers to organize their menus and that in turn determines how the many transaction and menu handling activities are performed on an Infor POS terminal during a typical day. Think of a group as a container that can hold other groups, or menu items. A Major Group (e.g., food) contains at least one Family Group (e.g., fish) and a Family Group contains at least one menu item (e.g., halibut). Groups are arranged in a hierarchy and determine how data is tracked by an Infor POS and uploaded to Infor Cloud and how that data is processed and the information returned in reports for managers of food service providers.\u003c/p\u003e","operationId":"categories","produces":["application/json"],"parameters":[{"$ref":"#/parameters/xApiKeyParam"},{"$ref":"#/parameters/storeIdParam"},{"$ref":"#/parameters/topCategoryNameParam"},{"$ref":"#/parameters/productNameTargetParam"},{"$ref":"#/parameters/modifierGroupsTargetParam"}],"responses":{"200":{"description":"Successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/MenuCategory"}}},"204":{"description":"Data is not available"},"400":{"description":"Invalid ID supplied"},"493":{"description":"Not authorized"},"495":{"description":"Not authenticated"}}}},"/v1/stores/{storeId}/menuItems/{menuItemId}":{"get":{"tags":["menu/v1"],"summary":"Menu Item Details","description":"\u003cp\u003eIf you are building a SaaS digital menu integration, then Menu Item Details will keep you on top of ever changing restaurant menus, whether at single or multiple locations for an operation. We recommend that you include the Menu Categories resource in your build if you want an app representing an all-inclusive menu of a food service operation.\u003c/p\u003e \u003cp\u003eMenu item details describe the menu offered by a food service provider. The details of a menu include the following:\u003c/p\u003e \u003cp\u003e\u003cstrong\u003eDescription:\u003c/strong\u003e\tThis is the name of a menu item and its price; it might include other details such as quantity, ingredients, and health information.\u003c/p\u003e \u003cp\u003e\u003cstrong\u003eImage:\u003c/strong\u003e An image can be a photograph or an illustration.\u003c/p\u003e \u003cp\u003e\u003cstrong\u003eModifier\u003c/strong\u003e This is a menu items that is added to or removed from a guest’s order. For example, if a guest orders a green salad there might be a choice of dressing. The choices offered are modifiers of the salad. There are two types of modifiers; forced modifiers are associated with a specific menu item and appear automatically in an Infor POS menu panel when the menu item is ordered, for example, choices for meat doneness; add/no modifiers do not appear automatically, instead these modifiers are opened only when requested, for example if a guest requests extra cheese for a Rueben sandwich.\u003c/p\u003e \u003cp\u003eThere are prices applied to modifiers.\u003c/p\u003e","operationId":"menuItems","produces":["application/json"],"parameters":[{"$ref":"#/parameters/xApiKeyParam"},{"$ref":"#/parameters/storeIdParam"},{"$ref":"#/parameters/menuItemIdParam"},{"$ref":"#/parameters/productNameTargetParam"},{"$ref":"#/parameters/modifierGroupsTargetParam"}],"responses":{"200":{"description":"Successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/MenuLineItemWithModifiers"}}},"204":{"description":"Data is not available"},"400":{"description":"Invalid ID supplied"},"493":{"description":"Not authorized"},"495":{"description":"Not authenticated"}}}},"/v1/stores/{storeId}/discounts":{"get":{"tags":["menu/v1"],"summary":"Discounts","description":"\u003cp\u003eReturns a flat list of discounts available on the POS terminal which can be subsequently incorporated into an order created in the \u003ccode\u003estores/{storeId}/orders\u003c/code\u003e API.\u003c/p\u003e","operationId":"discounts","produces":["application/json"],"parameters":[{"$ref":"#/parameters/xApiKeyParam"},{"$ref":"#/parameters/storeIdParam"}],"responses":{"200":{"description":"Successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Discount"}}},"204":{"description":"Data is not available"},"400":{"description":"Invalid ID supplied"},"493":{"description":"Not authorized"},"495":{"description":"Not authenticated"}}}},"/v1/stores/{storeId}/storeDetails":{"get":{"tags":["menu/v1"],"summary":"Store Details","description":"\u003cp\u003eThis resource returns information about a single Infor customer Store. Store information describes a Store’s location as an address and as a geographic coordinate; Store information also includes telephone numbers and hours of operation.\u003c/p\u003e \u003cp\u003eUse this resource if you are a software development company creating applications that provide information about life style, entertainment, food and drink, navigation, sports or travel. Infor’s enterprise POS customers have operations in large North American sports facilities and at major airports.\u003c/p\u003e","operationId":"storeDetails","produces":["application/json"],"parameters":[{"$ref":"#/parameters/xApiKeyParam"},{"$ref":"#/parameters/storeIdParam"}],"responses":{"200":{"description":"Successful operation","schema":{"$ref":"#/definitions/StoreDetails"}},"204":{"description":"Data is not available"},"400":{"description":"Invalid ID supplied"},"493":{"description":"Not authorized"},"495":{"description":"Not authenticated"}}}},"/v1/stores/{storeId}/tenders":{"get":{"tags":["ordering/v1"],"summary":"Tenders","description":"\u003cp\u003eTenders are methods of payment received for orders processed on Infor POS terminals. Infor POS can process transactions with tenders from all the typically used major credit cards and debit cards; in addition, Infor POS can process coupons, vouchers, gift cards, loyalty cards, student meal plans, checks and of course, cash. This resource will be an asset if your company offers mobile ordering or kiosk ordering.\u003c/p\u003e","operationId":"tenders","produces":["application/json"],"parameters":[{"$ref":"#/parameters/xApiKeyParam"},{"$ref":"#/parameters/storeIdParam"},{"$ref":"#/parameters/categoryNameParam"},{"$ref":"#/parameters/isIntegratedParam"}],"responses":{"200":{"description":"Successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Tender"}}},"204":{"description":"Data is not available"},"400":{"description":"Invalid ID supplied"},"493":{"description":"Not authorized"},"495":{"description":"Not authenticated"}}}},"/v1/stores/{storeId}/orders/data":{"put":{"tags":["ordering/v1"],"summary":"Order data (charges)","description":"\u003cp\u003eThis resource returns a list of order items with calculated totals and charges.\u003c/p\u003e","operationId":"orderData","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Order items","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/OrderLineItem"}}},{"$ref":"#/parameters/xApiKeyParam"},{"$ref":"#/parameters/storeIdParam"}],"responses":{"200":{"description":"Successful operation","schema":{"$ref":"#/definitions/OrderData"}},"204":{"description":"Data is not available or POS hasn't replied in time before timeout is reached"},"400":{"description":"Invalid ID supplied"},"409":{"description":"Item is out of stock","schema":{"$ref":"#/definitions/OutOfStockResponse"}},"493":{"description":"Not authorized"},"495":{"description":"Not authenticated"},"524":{"description":"Connection to POS cannot be established"}}}},"/v1/stores/{storeId}/orders":{"post":{"tags":["ordering/v1"],"summary":"Place order","description":"\u003cp\u003eThis resource submits an order to an Infor POS terminal for processing. The same information returned on a receipt for an order is included on an order sent to the Point of Sale.\u003c/p\u003e \u003cp\u003eUse this resource if you want a third party mobile ordering app to place orders that are received by an Infor POS.\u003c/p\u003e","operationId":"order","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Order","required":true,"schema":{"$ref":"#/definitions/Order"}},{"in":"header","name":"correlationId","description":"CorrelationId","required":false,"type":"string"},{"$ref":"#/parameters/xApiKeyParam"},{"$ref":"#/parameters/storeIdParam"}],"responses":{"200":{"description":"Successful operation","schema":{"$ref":"#/definitions/OrderReceipt"}},"204":{"description":"Data is not available or POS hasn't replied in time before timeout is reached"},"400":{"description":"Invalid ID supplied"},"402":{"description":"Payment is required (payment failed)","schema":{"$ref":"#/definitions/PaymentFailure"}},"409":{"description":"Item is out of stock","schema":{"$ref":"#/definitions/OutOfStockResponse"}},"493":{"description":"Not authorized"},"495":{"description":"Not authenticated"},"524":{"description":"Connection to POS cannot be established"}}}},"/v1/stores/{storeId}/orders/receipt/{correlationId}":{"get":{"tags":["ordering/v1"],"summary":"Order receipt","description":"\u003cp\u003eThis resource returns a receipt for an order from an Infor point of sale terminal by using a correlation Id. The receipt includes the amount, tender Id, transaction time, reference number, payment method, transaction time, authorization code and receipt Id.\u003c/p\u003e \u003cp\u003eUse this resource if you want to retrieve information about a completed order.\u003c/p\u003e","operationId":"orderReceipt","produces":["application/json"],"parameters":[{"in":"path","name":"correlationId","description":"CorrelationId","required":true,"type":"string"},{"$ref":"#/parameters/xApiKeyParam"},{"$ref":"#/parameters/storeIdParam"}],"responses":{"200":{"description":"Successful operation","schema":{"$ref":"#/definitions/OrderReceipt"}},"400":{"description":"Invalid ID supplied"},"402":{"description":"Payment is required (payment failed)","schema":{"$ref":"#/definitions/PaymentFailure"}},"409":{"description":"Item is out of stock","schema":{"$ref":"#/definitions/OutOfStockResponse"}},"493":{"description":"Not authorized"},"495":{"description":"Not authenticated"}}}},"/v1/stores/{storeId}/receipts/email":{"post":{"tags":["ordering/v1"],"summary":"Send order receipt via email","description":"Sends order receipt via email with a content provided in the requests. Terminal/store ID must be provided. The request HTTP header should have x-api-key parameter with value of your API access key.","operationId":"sendEmailReceipt","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Receipt contents","required":true,"schema":{"$ref":"#/definitions/EmailReceipt"}},{"$ref":"#/parameters/xApiKeyParam"},{"$ref":"#/parameters/storeIdParam"}],"responses":{"200":{"description":"Successful operation"},"400":{"description":"Invalid data supplied"},"493":{"description":"Not authorized"},"495":{"description":"Not authenticated"},"503":{"description":"Email service is not available"}}}},"/v1/stores/{storeId}/orders/{tabId}":{"get":{"tags":["ordering/v1"],"summary":"Get order from POS","description":"\u003cp\u003eThis resource is used to return the current details of an open check. If a check is closed, the API response returns a “Check is Closed” error message. Open checks are used only in situations when you would like the option of adding more items during a period of time.\u003c/p\u003e","operationId":"getOrderByTabId","produces":["application/json"],"parameters":[{"$ref":"#/parameters/xApiKeyParam"},{"$ref":"#/parameters/storeIdParam"},{"$ref":"#/parameters/tabIdParam"}],"responses":{"200":{"description":"Successful operation","schema":{"$ref":"#/definitions/Order"}},"400":{"description":"Invalid data supplied in the request"},"405":{"description":"Order with the tabId is already closed on POS"},"410":{"description":"Order with the tabId does not exist on POS"},"493":{"description":"Not authorized"},"495":{"description":"Not authenticated"},"524":{"description":"Connection to POS cannot be established"}}},"patch":{"tags":["ordering/v1"],"summary":"Closes order on POS","description":"\u003cp\u003eThis resource is used to close a specific open check that has been paid for on a third party device. For example, if a third party mobile ordering app has accepted payment for a check, the third party app will make a call to the Infor POS to close the check.\u003c/p\u003e","operationId":"closeOrder","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Payment details","required":true,"schema":{"$ref":"#/definitions/PaymentDetails"}},{"$ref":"#/parameters/xApiKeyParam"},{"$ref":"#/parameters/storeIdParam"},{"$ref":"#/parameters/tabIdParam"}],"responses":{"200":{"description":"Successful operation"},"400":{"description":"Invalid data supplied in the request"},"402":{"description":"Payment is required (payment failed)","schema":{"$ref":"#/definitions/PaymentFailure"}},"405":{"description":"Order with the tabId is already closed on POS"},"409":{"description":"Order cannot be closed"},"410":{"description":"Order with the tabId does not exist on POS"},"493":{"description":"Not authorized"},"495":{"description":"Not authenticated"},"524":{"description":"Connection to POS cannot be established"}}}},"/v1/stores/{storeId}/orders/{tabId}/items":{"post":{"tags":["ordering/v1"],"summary":"Add items to order on POS","description":"\u003cp\u003eThis resource is used by a third Party Product (such as a mobile ordering app) to add items to an existing open check on an Infor POS.\u003c/p\u003e","operationId":"addItemsToOrder","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Order items","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/OrderLineItem"}}},{"$ref":"#/parameters/xApiKeyParam"},{"$ref":"#/parameters/storeIdParam"},{"$ref":"#/parameters/tabIdParam"}],"responses":{"200":{"description":"Successful operation","schema":{"$ref":"#/definitions/OrderData"}},"400":{"description":"Invalid data supplied in the request"},"405":{"description":"Order with the tabId is already closed on POS"},"410":{"description":"Order with the tabId does not exist on POS"},"416":{"description":"Tax calculation error"},"493":{"description":"Not authorized"},"495":{"description":"Not authenticated"},"524":{"description":"Connection to POS cannot be established"}}}},"/v1/apiKeys/stores":{"get":{"tags":["configuration/v1"],"summary":"API key Stores","description":"\u003cp\u003eThis resource returns a list of the Stores that the API Key entitles a partner to access.\u003c/p\u003e","operationId":"apiKeyStores","produces":["application/json"],"parameters":[{"$ref":"#/parameters/xApiKeyParam"}],"responses":{"200":{"description":"Successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Store"}}},"204":{"description":"Data is not available"},"493":{"description":"Not authorized"},"495":{"description":"Not authenticated"}}}},"/v1/stores/{storeId}/employees":{"get":{"tags":["configuration/v1"],"summary":"Employees","description":"\u003cp\u003eThis resource returns a list of the employees at the store.\u003c/p\u003e","operationId":"employeesForStore","produces":["application/json"],"parameters":[{"$ref":"#/parameters/xApiKeyParam"},{"$ref":"#/parameters/storeIdParam"}],"responses":{"200":{"description":"Successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Employee"}}},"204":{"description":"Data is not available"},"493":{"description":"Not authorized"},"495":{"description":"Not authenticated"}}}}},"definitions":{"OrderLineItem":{"type":"object","required":["orderLineItemId","productId","productName","quantity","quantityUnit","price","ignorePrice","orderTypeId","modifiers","discounts","remark"],"properties":{"orderLineItemId":{"type":"integer","format":"int64"},"productId":{"type":"integer","format":"int64"},"productName":{"type":"string"},"orderTypeId":{"type":"integer","format":"int64"},"price":{"type":"number"},"quantity":{"type":"number"},"quantityUnit":{"type":"string"},"ignorePrice":{"type":"boolean"},"remark":{"type":"string"},"modifiers":{"type":"array","items":{"$ref":"#/definitions/OrderLineItem"}},"discounts":{"type":"array","items":{"$ref":"#/definitions/Discount"}},"restricted":{"type":"boolean"},"employee":{"$ref":"#/definitions/Employee"},"onHold":{"type":"boolean"},"weighed":{"type":"boolean"}}},"MenuCategory":{"type":"object","required":["categoryId","categoryName","subCategories","menuLineItems"],"properties":{"categoryId":{"type":"integer","format":"int64"},"categoryName":{"type":"string"},"subCategories":{"type":"array","items":{"$ref":"#/definitions/MenuCategory"}},"menuLineItems":{"type":"array","items":{"$ref":"#/definitions/MenuLineItem"}},"images":{"type":"array","items":{"$ref":"#/definitions/ImageMetaData"}}}},"MenuLineItem":{"type":"object","required":["hasModifiers","availableQuantity","menuLineItemDescription","product"],"properties":{"hasModifiers":{"type":"boolean"},"availableQuantity":{"type":"number"},"menuLineItemDescription":{"type":"string"},"product":{"$ref":"#/definitions/Product"}}},"MenuLineItemWithModifiers":{"type":"object","required":["hasModifiers","availableQuantity","menuLineItemDescription","product","modifierGroups"],"properties":{"hasModifiers":{"type":"boolean"},"availableQuantity":{"type":"number"},"menuLineItemDescription":{"type":"string"},"product":{"$ref":"#/definitions/Product"},"modifierGroups":{"type":"array","items":{"$ref":"#/definitions/ModifierGroup"}}}},"Product":{"type":"object","required":["productId","productName","pricePerUnit","productDescription","unitName","images"],"properties":{"productId":{"type":"integer","format":"int64"},"productName":{"type":"string"},"pricePerUnit":{"type":"number"},"productDescription":{"type":"string"},"unitName":{"type":"string"},"unitId":{"type":"integer"},"images":{"type":"array","items":{"$ref":"#/definitions/ImageMetaData"}},"nutritionDetails":{"$ref":"#/definitions/NutritionDetails"},"pricingEvents":{"type":"array","items":{"$ref":"#/definitions/PricingEvent"}},"weighed":{"type":"boolean"},"restricted":{"type":"boolean"},"tares":{"type":"array","items":{"$ref":"#/definitions/Tare"}},"upcs":{"type":"array","items":{"$ref":"#/definitions/UniversalProductCode"}}}},"ModifierGroup":{"type":"object","required":["modifierGroupId","modifierGroupName","ignorePrice","allowClose","combo","repeatTimes","modifiers","discounts"],"properties":{"modifierGroupId":{"type":"integer","format":"int64"},"modifierGroupName":{"type":"string"},"ignorePrice":{"type":"boolean"},"allowClose":{"type":"boolean"},"combo":{"type":"boolean"},"repeatTimes":{"type":"boolean"},"modifiers":{"type":"array","items":{"$ref":"#/definitions/MenuLineItemWithModifiers"}},"discounts":{"type":"array","items":{"$ref":"#/definitions/Discount"}}}},"ImageMetaData":{"type":"object","required":["imageId","imageHeight","imageWidth","externalURL","imageFormat","localPath","fileName","imageDesc","resolution","lastUpdated"],"properties":{"imageId":{"type":"integer","format":"int64"},"imageHeight":{"type":"integer","format":"int32"},"imageWidth":{"type":"integer","format":"int32"},"externalURL":{"type":"string"},"imageFormat":{"type":"string"},"localPath":{"type":"string"},"fileName":{"type":"string"},"imageDesc":{"type":"string"},"resolution":{"type":"string"},"lastUpdated":{"type":"integer","format":"int32"}}},"Discount":{"type":"object","required":["discountId","discountName","discountType","value"],"properties":{"discountId":{"type":"integer","format":"int64"},"discountName":{"type":"string"},"discountType":{"type":"string"},"value":{"type":"number"}}},"Tender":{"type":"object","required":["tenderId","tenderName","cash"],"properties":{"tenderId":{"type":"integer","format":"int64"},"tenderName":{"type":"string"},"cash":{"type":"boolean"},"taxByTender":{"type":"boolean"},"integrated":{"type":"boolean"},"displayText":{"type":"string"},"providerId":{"type":"integer"}}},"StoreDetails":{"type":"object","required":["storeId","name"],"properties":{"storeId":{"type":"integer","format":"int64"},"name":{"type":"string"},"company":{"$ref":"#/definitions/Company"},"address":{"$ref":"#/definitions/Address"},"storeHours":{"type":"array","items":{"$ref":"#/definitions/StoreHours"}}}},"Company":{"type":"object","required":["companyId","companyName"],"properties":{"companyId":{"type":"integer","format":"int64"},"companyName":{"type":"string"}}},"Address":{"type":"object","required":["street","city","state","postalCode","phone","email","countryCode","timeZone","latitude","longitude"],"properties":{"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"},"countryCode":{"type":"integer","format":"int32"},"timeZone":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"}}},"StoreHours":{"type":"object","required":["id","openTime","closeTime","dayOfWeek"],"properties":{"id":{"type":"integer","format":"int64"},"openTime":{"type":"integer","format":"int64"},"closeTime":{"type":"integer","format":"int64"},"dayOfWeek":{"type":"integer","format":"int32"}}},"Store":{"type":"object","required":["companyId","companyName","storeId","storeName"],"properties":{"companyId":{"type":"integer","format":"int64"},"companyName":{"type":"string"},"storeId":{"type":"integer","format":"int64"},"storeName":{"type":"string"}}},"OrderData":{"type":"object","required":["total","orderLineItems","discounts","charges"],"properties":{"total":{"type":"integer","format":"int64"},"orderLineItems":{"type":"array","items":{"$ref":"#/definitions/OrderLineItem"}},"discounts":{"type":"array","items":{"$ref":"#/definitions/Discount"}},"charges":{"type":"array","items":{"$ref":"#/definitions/Charge"}}}},"Charge":{"type":"object","required":["chargeId","name","amount"],"properties":{"chargeId":{"type":"integer","format":"int64"},"name":{"type":"string"},"amount":{"type":"number"}}},"Order":{"type":"object","required":["orderId","externalSystemOrderId","orderLineItems","payments","charges","pickupTime"],"properties":{"orderId":{"type":"integer","format":"int64"},"externalSystemOrderId":{"type":"string"},"orderPlacedBy":{"type":"string"},"orderPlacerId":{"type":"string"},"orderLineItems":{"type":"array","items":{"$ref":"#/definitions/OrderLineItem"}},"charges":{"type":"array","items":{"$ref":"#/definitions/Charge"}},"payments":{"type":"array","items":{"$ref":"#/definitions/Payment"}},"discounts":{"type":"array","items":{"$ref":"#/definitions/Discount"}},"pickupTime":{"type":"integer","format":"int64"},"transferable":{"type":"boolean"},"positionId":{"type":"integer","format":"int64"}}},"Payment":{"type":"object","required":["paymentId","tenderId","amount","paymentMethod","type"],"properties":{"paymentId":{"type":"integer","format":"int64"},"tenderId":{"type":"integer","format":"int64"},"amount":{"type":"number"},"lineItemIds":{"type":"array","items":{"type":"integer"}},"paymentMethod":{"$ref":"#/definitions/PaymentMethod"},"type":{"type":"string"},"externalPaymentReceipt":{"$ref":"#/definitions/ExternalPaymentReceipt"}}},"PaymentDetails":{"type":"object","required":["paymentId","tenderId","amount","charges"],"properties":{"paymentId":{"type":"integer","format":"int64"},"tenderId":{"type":"integer","format":"int64"},"amount":{"type":"number"},"charges":{"type":"array","items":{"$ref":"#/definitions/Charge"}}}},"PaymentMethod":{"type":"object","required":["type","nameOnCard","cardNumber","expirationDate"],"properties":{"paymentMethodId":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["RawCard","RawAllTracksCardData","PreAuthData"]},"nameOnCard":{"type":"string"},"cardNumber":{"type":"string"},"expirationDate":{"type":"string"},"securityCode":{"type":"string"},"base64Data":{"type":"string"},"paymentProviderId":{"type":"string"}}},"OrderReceipt":{"type":"object","required":["orderId","tabId","paymentTransactionConfirmations"],"properties":{"orderId":{"type":"integer","format":"int64"},"tabId":{"type":"string"},"paymentTransactionConfirmations":{"type":"array","items":{"$ref":"#/definitions/PaymentTransactionConfirmation"}},"terminalPrefix":{"type":"integer"}}},"PaymentTransactionConfirmation":{"type":"object","required":["amount","tenderId","transactionTime","transactionReferenceNumber","humanReadablePaymentMethod","authorizationCode","receiptId"],"properties":{"amount":{"type":"number"},"tenderId":{"type":"integer","format":"int64"},"transactionTime":{"type":"string"},"transactionReferenceNumber":{"type":"string"},"humanReadablePaymentMethod":{"type":"string"},"transactionTimeGmt":{"type":"integer","format":"int64"},"authorizationCode":{"type":"string"},"receiptId":{"type":"string"}}},"PaymentFailure":{"type":"object","required":["message","errorCode","transactionReferenceNumber"],"properties":{"message":{"type":"string"},"errorCode":{"type":"string"},"transactionReferenceNumber":{"type":"string"}}},"ProductQuantity":{"type":"object","required":["productId","availableQuantity"],"properties":{"productId":{"type":"integer","format":"int64"},"availableQuantity":{"type":"number"}}},"OutOfStockResponse":{"type":"array","items":{"$ref":"#/definitions/ProductQuantity"}},"EmailReceipt":{"type":"object","required":["consumerEmail","order","orderReceipt"],"properties":{"consumerEmail":{"type":"string"},"acceptedTermsAndConditionsVersion":{"type":"string"},"acceptedTermsAndConditionsDateTime":{"type":"integer","format":"int64"},"order":{"$ref":"#/definitions/Order"},"orderReceipt":{"$ref":"#/definitions/OrderReceipt"},"preferReceiptLines":{"type":"boolean"},"receiptLines":{"type":"array","items":{"$ref":"#/definitions/EmailReceiptLine"}}}},"ExternalPaymentReceipt":{"type":"object","properties":{"paymentProviderId":{"type":"string"},"correlationId":{"type":"string"},"transactionStatus":{"type":"string"},"transactionType":{"type":"string"},"transactionId":{"type":"string"},"transactionTag":{"type":"integer","format":"int64"},"tenderMethod":{"type":"string"},"amount":{"type":"number"},"currency":{"type":"string"}}},"NutritionDetails":{"type":"object","required":["nutrients"],"properties":{"nutrients":{"type":"array","items":{"$ref":"#/definitions/Nutrient"}}}},"Nutrient":{"type":"object","required":["name","displayName","unit","value"],"properties":{"value":{"type":"number"},"name":{"type":"string"},"displayName":{"type":"string"},"unit":{"type":"string"}}},"PricingEvent":{"type":"object","required":["eventName","price","priority"],"properties":{"eventName":{"type":"string"},"price":{"type":"number"},"priority":{"type":"number"},"schedules":{"type":"array","items":{"$ref":"#/definitions/PricingEventSchedule"}}}},"PricingEventSchedule":{"type":"object","required":["scheduleName","dateStart","dateEnd","timeStart","timeEnd","noEndDate"],"properties":{"scheduleName":{"type":"string"},"dateStart":{"type":"string"},"dateEnd":{"type":"string"},"timeStart":{"type":"string"},"timeEnd":{"type":"string"},"noEndDate":{"type":"boolean"},"daysOfWeek":{"type":"array","items":{"$ref":"#/definitions/DayOfWeek"}}}},"DayOfWeek":{"type":"object","required":["dayName","dayNumber","active"],"properties":{"dayName":{"type":"string"},"dayNumber":{"type":"number"},"active":{"type":"boolean"}}},"Employee":{"type":"object","required":["employeeId","positionId"],"properties":{"employeeId":{"type":"number"},"positionId":{"type":"number"},"swipeCodeSHA256AsBase64":{"type":"string"},"username":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"}}},"TabEntry":{"type":"object","properties":{"companyId":{"type":"number"},"storeId":{"type":"number"},"tabId":{"type":"number"},"shareId":{"type":"number"},"terminalId":{"type":"number"},"linkTo":{"type":"number"},"numShares":{"type":"number"},"timeStamp":{"type":"string"},"lineType":{"type":"number"},"itemId":{"type":"number"},"itemDesc":{"type":"string"},"param1":{"type":"string"},"param2":{"type":"string"},"positionId":{"type":"number"},"ordered":{"type":"number","format":"float"},"currencyId":{"type":"number"},"exchangeRate":{"type":"number","format":"float"},"amount":{"type":"number"},"taxGrpId":{"type":"number"},"deptId":{"type":"number"},"accountId":{"type":"number"},"tabStatus":{"type":"number"},"status":{"type":"string"},"grossAmount":{"type":"number"},"isTaxExempt":{"type":"boolean"},"taxComment":{"type":"string"},"transferredIn":{"type":"boolean"},"pureAmount":{"type":"number"},"theoreticalCogs":{"type":"number"},"course":{"type":"number"}}},"CashTransferEntry":{"type":"object","properties":{"companyId":{"type":"number"},"storeId":{"type":"number"},"cashId":{"type":"number"},"mediaType":{"type":"string"},"timeStamp":{"type":"string"},"fromPositionId":{"type":"number"},"toPositionId":{"type":"number"},"currencyId":{"type":"number"},"amount":{"type":"number"},"description":{"type":"string"},"status":{"type":"string"},"terminalId":{"type":"number"}}},"ClockTimeEntry":{"type":"object","properties":{"companyId":{"type":"number"},"storeId":{"type":"number"},"positionId":{"type":"number"},"clockTimesId":{"type":"number"},"clockIn":{"type":"string"},"clockOut":{"type":"string"},"adjustClockIn":{"type":"number"},"adjustClockOut":{"type":"number"},"inTerminalId":{"type":"number"},"outTerminalId":{"type":"number"},"status":{"type":"string"},"wageRate":{"type":"number"},"overtimeWageRate":{"type":"number"},"regularHours":{"type":"number","format":"float"},"overtimeHours":{"type":"number","format":"float"}}},"EmailReceiptLine":{"type":"object","required":["size","style","weight","alignment"],"properties":{"size":{"type":"string"},"style":{"type":"string"},"weight":{"type":"string"},"alignment":{"type":"string"},"text1":{"type":"string"},"text2":{"type":"string"}}},"Tare":{"type":"object","properties":{"tareId":{"type":"number"},"tareName":{"type":"string"},"weight":{"type":"number","format":"float"},"unitId":{"type":"integer"},"unitName":{"type":"string"},"order":{"type":"integer"}}},"UniversalProductCode":{"type":"object","properties":{"priority":{"type":"integer"},"upc":{"type":"string"}}}},"parameters":{"storeIdParam":{"name":"storeId","in":"path","description":"The ID of the store (POS terminal)","required":true,"type":"integer","minimum":1},"companyIdParam":{"name":"companyId","in":"path","description":"The ID of the company","required":true,"type":"integer","minimum":1},"xApiKeyParam":{"name":"x-api-key","in":"header","description":"Your API access key","required":true,"type":"string","minimum":1},"tabIdParam":{"name":"tabId","in":"path","description":"The reference id of an open order on POS !!!","required":true,"type":"integer","minimum":1},"startTimeParam":{"name":"startTime","in":"query","description":"Timestamp indicating the start of requested date range. Format 'YYYYMMDD HH:MM:SS'. Provided in URL like '20120101%2009:09:09' ('%20' is space)","required":true,"type":"string","minimum":1},"endTimeParam":{"name":"endTime","in":"query","description":"Timestamp indicating the end of requested date range. Format 'YYYYMMDD HH:MM:SS'. Provided in URL like '20120101%2009:09:09' ('%20' is space)","required":true,"type":"string","minimum":1},"productNameTargetParam":{"name":"productNameTarget","in":"query","description":"Type of a client application which is the name of a product set for. Example: \"mobile\"","required":false,"type":"string","minimum":1},"topCategoryNameParam":{"name":"topCategory","in":"query","description":"Name of the category which is a root of required menu tree","required":false,"type":"string","minimum":1},"modifierGroupsTargetParam":{"name":"modifierGroupsTarget","in":"query","description":"Type of a client application which is the modifiers are set for. Example: \"mobile\"","required":false,"type":"string","minimum":1},"menuItemIdParam":{"name":"menuItemId","in":"path","description":"Menu item ID (productId)","required":true,"type":"integer","minimum":1},"categoryNameParam":{"name":"category","in":"query","description":"Name of the category which the records belong to","required":false,"type":"string","minimum":1},"isIntegratedParam":{"name":"integrated","in":"query","description":"Filter records by \"integrated\" parameter","required":false,"type":"boolean","minimum":1}}}