Store Connect is a hosted, POS-agnostic API that provides a common set of POS services to NCR and third party hosted applications.
| Release | Changes |
|---|---|
| 16.2 |
Added new call GET Server Version. |
|
Added new call POST Add Deposit Using Existing Tender. |
|
| 15.5 |
Added ProcessingType, P2PECombo and CardNumberMasked fields to Payments. |
Manipulate Tables in a store.
| API | Name | Description | |
|---|---|---|---|
| POST | v1/Table/{storeIdentifier}/{tableNumber} | Open Table |
Opens Table |
A base endpoint for Store-level operations.
| API | Name | Description | |
|---|---|---|---|
| GET | v1/Stores/{storeIdentifier}/OnlineStatus?timeout={timeout} | Store Online Status |
Checks to see if the store is online |
| GET | v1/Stores/{storeIdentifier}/Server/Version?timeout={timeout} | Server Version |
Retrieves the version of the TakeOut server |
| GET | v1/Stores/{storeIdentifier}/Server/POS/Version?timeout={timeout} | Server POS Version |
Retrieves the POS version of the TakeOut Server that uses Aloha 7.0+ version. |
| GET | v1/Stores/{storeIdentifier}/PrepTime/ForOrderMode/{orderMode}?timeout={timeout} | Get Prep Time |
Retrieves the next available time for the store to accept orders, along with the sites current time. |
ResultCodes StoreResponseCodes Response codes to interpret and understand the result of the api call.
A base endpoint for Consumer Profile operations. Look at each endpoint for required/optional header information.
| API | Name | Description | |
|---|---|---|---|
| PUT | v1/ConsumerProfiles?timeout={timeout} | Save Payments |
Saves a ConsumerProfile with updated information |
| GET | v1/ConsumerProfiles/{storeIdentifier}/ByReference?referenceId={referenceId}&timeout={timeout} | Saved Payments by Refernece Id |
Retrieves a ConsumerProfile by ReferenceId to be used at a specific site |
| GET | v1/ConsumerProfiles/{storeIdentifier}/ByEmail?email={email}&timeout={timeout} | Saved Payments by Email |
Retrieves a ConsumerProfile by Email, to be used at a specific site |
ResultCodes ConsumerProfileResponseCodes Response codes to interpret and understand the result of the api call.
A base endpoint for formatted Order operations
| API | Name | Description | |
|---|---|---|---|
| PUT | v1/FormattedOrders/{storeIdentifier}?timeout={timeout} | Calculate Tax and Total |
Sends an order to a site to be processed by the POS for item validation, discounts, and taxes. Does not finalize the order in the system. |
| POST | v1/FormattedOrders/{storeIdentifier}/{orderId}?isFinalDeposit={isFinalDeposit}&timeout={timeout} | Add Deposit |
Adds a deposit to a previously submitted order. Order must still be unreleased. Use the ReleaseAwaitingDeposits flag in POST order to guarantee an external order will not be released. |
| POST | v1/FormattedOrders/{storeIdentifier}/{orderId}/Tender/{tenderId}/{amount}?isFinalDeposit={isFinalDeposit}&timeout={timeout} | Add Deposit Using Existing Tender |
Adds a deposit to a previously submitted order using a tender that was returned in the POST order. The order must still be unreleased. |
| DELETE | v1/FormattedOrders/{storeIdentifier}/{orderId}/{depositId}/Refund?timeout={timeout} | Refund Deposit |
Refunds a deposit off of an order. |
| POST | v1/FormattedOrders/{storeIdentifier}?addOrderOptions={addOrderOptions}&timeout={timeout} | Submit Order |
Submits an order to the POS for final processing and finalizes it in the system. |
| PUT | v1/FormattedOrders/{storeIdentifier}/{updateOrderId}?updateOrderOptions={updateOrderOptions}&timeout={timeout} | Update Order |
Update the specified future order to the ATO system for the specified site. |
| POST | v1/FormattedOrders/{storeIdentifier}/{orderId}/CheckIn?tenderOrder={tenderOrder}&timeout={timeout} | Checkin Order |
Sends a command to the POS to fire an order |
| GET | v1/FormattedOrders/{storeIdentifier}/{orderId}?timeout={timeout} | Get Order by Order Id |
Gets an Updated Order from the POS by Order Id |
| GET | v1/FormattedOrders/{storeIdentifier}/ByReference/{referenceId}?timeout={timeout} | Get Order by Reference Id |
Gets an Updated Order from the POS by Reference Id |
| DELETE | v1/FormattedOrders/{storeIdentifier}/{orderId}?cancelIfOrdered={cancelIfOrdered}&timeout={timeout} | Cancel Order |
Cancels a pending order at the POS |
ResultCodes FormattedOrderResponseCodes Response codes to interpret and understand the result of the api call.
Monitors health of StoreConnect
| API | Name | Description | |
|---|---|---|---|
| GET | Health/Status | Get Status |
Gets you the status of storeconnect health |
Manipulate checks in a store. Operates on checks in the current Date-of-Business only (aka "live checks" or "current checks").
| API | Name | Description | |
|---|---|---|---|
| POST | v1/checks/{storeIdentifier}/{checkId}/pay | Pay with Tender by Check ID |
Pay a check with a (non-cash non-credit) tender by check ID. |
| POST | v1/checks/{storeIdentifier}/{checkId}/status | Add Status by Check ID |
Add a status to a check by Check ID. |
| POST | v1/checks/{storeIdentifier}/{checkId}/loyalty/{loyaltyId} | Assign Loyalty by Check ID |
Assign Loyalty Account to a check by check ID. |
| POST | v1/checks/{storeIdentifier}/{checkId}?timeout={timeout} | Modify Check |
Adds a list of items to a check and a list of comps to the check. |
| DELETE | v1/checks/{storeIdentifier}/{checkId}/loyalty | Unassign Loyalty by Check ID |
Unassign the assigned loyalty account from a check by check ID. |
| GET | v1/checks/{storeIdentifier}/{checkId}/loyalty | Get Loyalty Status by Check ID |
Get Loyalty Status by check ID. |
| POST | v1/checks/{storeIdentifier}/{checkId}/promo | Apply Promo |
Applys promo to a check |
| POST | v1/checks/{storeIdentifier}/{checkId}/deletePayment | Delete Payment |
Delete Payment by Check Id |
Authenticates Login
| API | Name | Description | |
|---|---|---|---|
| POST | v1/Authenticate/activechecks/{storeIdentifier} | Active Checks Validate Employee |
Validate Login for employees' for Active Checks. Need either the employee number and password or mag card data |