# Storyous Public APIs

## Docs
- [Introduction](https://docs.api.storyous.com/introduction-354414m0.md): 
- [Menu API](https://docs.api.storyous.com/menu-api-453068f0.md): 
- [Deskview API](https://docs.api.storyous.com/deskview-api-453070f0.md): 
- [Hotel accounts integration API](https://docs.api.storyous.com/hotel-accounts-integration-api-453073f0.md): 
- Loyalty API [Introduction](https://docs.api.storyous.com/introduction-354279m0.md): 
- Loyalty API [Prepayment](https://docs.api.storyous.com/prepayment-355676m0.md): 
- Loyalty API [Item refunds with credit](https://docs.api.storyous.com/item-refunds-with-credit-356981m0.md): 
- [DataSync](https://docs.api.storyous.com/datasync-453075f0.md): 
- DataSync [Webhook receiving endpoint](https://docs.api.storyous.com/webhook-receiving-endpoint-453195f0.md): 

## API Docs
- Merchants API [Get merchant and all its places](https://docs.api.storyous.com/get-merchant-and-all-its-places-3899426e0.md): 
- Menu API [Get a menu tree](https://docs.api.storyous.com/get-a-menu-tree-3899456e0.md): Endpoint that allows to read all levels of a menu. 
- Menu API [Get time-based menu](https://docs.api.storyous.com/get-time-based-menu-3899457e0.md): Real time-based menu (e.g. daily-menu, Happy-Hours).
- Menu API [Get Remaining amounts of time-based menu](https://docs.api.storyous.com/get-remaining-amounts-of-time-based-menu-3899458e0.md): Gets current remaining amounts based on active time-based menu
- Bills API [Get list of payment bills](https://docs.api.storyous.com/get-list-of-payment-bills-3899434e0.md): Get payment bills for a sourceId (merchantId-placeId). Data are ordered by the billId by default. If modifiedSince parameter is present, results will be ordered by the _lastModifiedAt property ascending.
- Bills API [Get detail of a payment bill](https://docs.api.storyous.com/get-detail-of-a-payment-bill-3899435e0.md): Get payment bills for a sourceId (merchantId-placeId) and billId
- Delivery API [Create an order through delivery API](https://docs.api.storyous.com/create-an-order-through-delivery-api-3899461e0.md): **Notification webhooks**
- Delivery API [Get status of delivery order](https://docs.api.storyous.com/get-status-of-delivery-order-3899462e0.md): **Possible order states:**
- Deskview API [Get list of desks](https://docs.api.storyous.com/get-list-of-desks-3899431e0.md): Get desks
- Deskview API [Get list of sections](https://docs.api.storyous.com/get-list-of-sections-3899432e0.md): Get section list
- Deskview API [Get desk view of a place](https://docs.api.storyous.com/get-desk-view-of-a-place-3899433e0.md): Get deskView
- Features API [Get list of merchants/places with a feature](https://docs.api.storyous.com/get-list-of-merchantsplaces-with-a-feature-3899463e0.md): The endpoint returns a list of entities (merchants or places) with the enabled feature. In the case of automated client onboarding for an integration (represented by the feature), the partner can call the endpoint to regularly check and pair Storyous entities (places/merchants) with entities on their side.
- Hotel accounts integration API [Provide list of accounts](https://docs.api.storyous.com/provide-list-of-accounts-3899845e0.md): 
- Hotel accounts integration API [Write consumed items to hotel account](https://docs.api.storyous.com/write-consumed-items-to-hotel-account-3899846e0.md): The endpoint should accept items consumed by a customer and add them to his account for future payment.
- Stocks API [Get list of stocks](https://docs.api.storyous.com/get-list-of-stocks-3899847e0.md): 
- Stocks API [Get list of items](https://docs.api.storyous.com/get-list-of-items-3899850e0.md): 
- Stocks API [Get list of stock ups](https://docs.api.storyous.com/get-list-of-stock-ups-3899852e0.md): 
- Stocks API [Get detail of stock up](https://docs.api.storyous.com/get-detail-of-stock-up-3899856e0.md): 
- Stocks API [Create new stock up](https://docs.api.storyous.com/create-new-stock-up-3899857e0.md): 
- Stocks API [Modify stock up](https://docs.api.storyous.com/modify-stock-up-3899858e0.md): 
- Stocks API [Delete stock up](https://docs.api.storyous.com/delete-stock-up-3899859e0.md): 
- Stocks API [Get list of stock takings](https://docs.api.storyous.com/get-list-of-stock-takings-3899860e0.md): 
- Stocks API [Get detail of stock taking](https://docs.api.storyous.com/get-detail-of-stock-taking-3899861e0.md): 
- Stocks API [Create new stock taking](https://docs.api.storyous.com/create-new-stock-taking-3899862e0.md): 
- Stocks API [Modify stock taking](https://docs.api.storyous.com/modify-stock-taking-3899863e0.md): 
- Stocks API [Delete stock taking](https://docs.api.storyous.com/delete-stock-taking-3899864e0.md): 
- Stocks API [Get suppliers](https://docs.api.storyous.com/get-suppliers-3899865e0.md): 
- Loyalty API [Get benefit offer](https://docs.api.storyous.com/get-benefit-offer-3893485e0.md): **Purpose**
- Loyalty API [Report offer validation error](https://docs.api.storyous.com/report-offer-validation-error-3893486e0.md): **Purpose**
- Loyalty API [Report benefit usage](https://docs.api.storyous.com/report-benefit-usage-3893507e0.md): **When a benefit usage occurs, this webhook is triggered.**
- Loyalty API [Get loyalty benefit usages](https://docs.api.storyous.com/get-loyalty-benefit-usages-3893481e0.md): **Description**
- Loyalty API [Mark benefit usages as synchronized](https://docs.api.storyous.com/mark-benefit-usages-as-synchronized-3893482e0.md): **Description**
- DataSync > Webhook receiving endpoint [Receive new or updated records](https://docs.api.storyous.com/receive-new-or-updated-records-3900111e0.md): The receiver of the data has to implement the endpoint, Storyous Data Sync then sends following payload to that endpoint.
- DataSync > Data domains > Stock management [Stocks domain](https://docs.api.storyous.com/stocks-domain-3900114e0.md): This data domain provides list of stocks.
- DataSync > Data domains > Stock management [StockItemCategories domain](https://docs.api.storyous.com/stockitemcategories-domain-3900115e0.md): This data domain provides list of categories used for categorization of stock items.
- DataSync > Data domains > Stock management [StockItems domain](https://docs.api.storyous.com/stockitems-domain-3900116e0.md): 
- DataSync > Data domains > Stock management [StockMovements domain](https://docs.api.storyous.com/stockmovements-domain-3900118e0.md): This data domain provides list of stock movements.
- DataSync > Data domains > Sales and costs [Bills domain](https://docs.api.storyous.com/bills-domain-3900119e0.md): This data domain provides list of bills paid (or modified) since last time.
- DataSync > Data domains > Sales and costs [BillCosts domain](https://docs.api.storyous.com/billcosts-domain-3900120e0.md): This data domain pairs costs of goods sold for each to items of bills.It’s a separate domain, because bills don’t change after they are issued (except refund and changing payment method), while costs can change quite often and for example creating a stock-up in past could invalidate lots of bills at once.
- DataSync > Data domains > Sales and costs [TerminalTransactions domain](https://docs.api.storyous.com/terminaltransactions-domain-3900121e0.md): Transactions from payment terminals.
- DataSync > Data domains > Sales and costs [PaymentTypes domain](https://docs.api.storyous.com/paymenttypes-domain-3900122e0.md): This data domain provides list of payment methods used in bills domain.Some payment types are predefined (“default”), others are custom-defined by the merchant (“custom”).Not all payment types are used in all the places.
- DataSync > Data domains > Sales and costs [Loyalty domain](https://docs.api.storyous.com/loyalty-domain-3900123e0.md): This data domain provides info about loyalty customers.
- DataSync > Data domains > Desks [DeskSections domain](https://docs.api.storyous.com/desksections-domain-3900127e0.md): This data domain provides list of desk sections which are used for categorization of desks.
- DataSync > Data domains > Desks [Desks domain](https://docs.api.storyous.com/desks-domain-3900128e0.md): This data domain provides list of desks.
- DataSync > Data domains > Menu [ItemCategories domain](https://docs.api.storyous.com/itemcategories-domain-3900129e0.md): This data domain provides list of categories used for categorization of menu items.
- DataSync > Data domains > Menu [Items domain](https://docs.api.storyous.com/items-domain-3900130e0.md): 
- DataSync > Data domains > Menu [PlaceITems domain](https://docs.api.storyous.com/placeitems-domain-3900131e0.md): This data domain provides list of menu items values valid for place.
- DataSync > Data domains > Merchants [Merchants domain](https://docs.api.storyous.com/merchants-domain-3900135e0.md): This data domain provides info about merchant.
- DataSync > Data domains > Merchants [Places domain](https://docs.api.storyous.com/places-domain-3900137e0.md): This data domain provides info about places.
- DataSync > Data domains > Merchants [Persons domain](https://docs.api.storyous.com/persons-domain-3900138e0.md): 

## Schemas
- Schemas > Loyalty api [BalanceBenefitOfferRequest](https://docs.api.storyous.com/balancebenefitofferrequest-599322d0.md): 
- Schemas > Loyalty api [ThirdPartyLoyaltyOfferRequest](https://docs.api.storyous.com/thirdpartyloyaltyofferrequest-599323d0.md): 
- Schemas > Loyalty api [LoyaltyOfferValidationError](https://docs.api.storyous.com/loyaltyoffervalidationerror-599325d0.md): 
- Schemas > Loyalty api [LoyaltyBenefitUsagesPayload](https://docs.api.storyous.com/loyaltybenefitusagespayload-599326d0.md): 
- Schemas > Loyalty api [BenefitInput](https://docs.api.storyous.com/benefitinput-599327d0.md): 
- Schemas > Loyalty api [PaidItem](https://docs.api.storyous.com/paiditem-599328d0.md): 
- Schemas > Loyalty api [Applied Benefits](https://docs.api.storyous.com/applied-benefits-599330d0.md): 
- Schemas > Loyalty api [PaymentByBalance](https://docs.api.storyous.com/paymentbybalance-599331d0.md): 
- Schemas > Loyalty api [UsedBalance](https://docs.api.storyous.com/usedbalance-599332d0.md): 
- Schemas > Loyalty api [LoyaltyOfferResponse](https://docs.api.storyous.com/loyaltyofferresponse-599324d0.md): 
- Schemas > Loyalty api [MenuProductDefinition](https://docs.api.storyous.com/menuproductdefinition-599329d0.md): 
- Schemas > Loyalty api [UsedGeneralDiscount](https://docs.api.storyous.com/usedgeneraldiscount-604033d0.md): 
- Schemas > Loyalty api [Prepayment](https://docs.api.storyous.com/prepayment-657269d0.md): 
- Schemas [Desk](https://docs.api.storyous.com/desk-601653d0.md): 
- Schemas [Section](https://docs.api.storyous.com/section-601654d0.md): 
- [Error](https://docs.api.storyous.com/error-707057d0.md):