Get Terminals

Endpoint Access URL: https://rest.everyware.com/api/terminals[GET]

Use this GET method to fetch synced terminal details for a Sales Site.

🚧
Notice
If your sales site is not enabled for CP Terminal functionality you will encounter an error response, "Card Present Terminal functionality has not be enabled for this sales site" Contact [email protected] if you encounter this error.

👍
All or Active Only
You can add /active to the end of the GET URL to retrieve information for only terminals with an Active status if you prefer.
Ex: https://rest.everyware.com/api/terminals/active

Response Parameters

Parameter	Description
SalesSiteId	The unique identifier in Everyware for the business.
EverywareTerminalId	Everyware issued unique Id used to differentiate between terminals associated with a single Everyware sales site. Ex: “2"
ProviderTerminalId	Terminal provider issued Id, which appears in the Point of Sale Settings table in the Everyware portal ‘Terminal Id’ column. Ex: “11ecd08f84335ffea994b6a5”
ProviderLocationId	Terminal provider issued Id used to differentiate between terminals associated with a single Everyware sales site, which appears in the Everyware Point of Sales Settings table ‘Location Id’ column. Ex: “11eca926e0b93ed2915f8b20”
TerminalModel	Terminal provider issued device model name, which appears in the Everyware Point of Sale Settings table ‘Type’ column.Ex: "Lane 3000"
TerminalName	Default will equal TerminalModel above. This field can be edited using the PUT /terminals call to customize the name of this device per the software application or merchant's preference to easily identify what device this is i.e. - "Register 1 - Front Counter", "Lane 5 Terminal" etc.
IsActive	True: Returns only Active terminals False/NULL: Returns all synced terminals, active or otherwise. This flag can also be updated by leveraging the PUT /terminals call.
CreatedAt	Date the terminal was initially synced to the Everyware system in year-month-day and time format in UTC. Appears in the Everyware Point of Sales Settings table ‘Date Added’ column. "2022-05-31T20:11:17.543"
UpdatedAt	Date the terminal properties were last updated by Everyware or a portal/API user. Appears in the Everyware Point of Sales Settings table ‘Date Modified’ column."2022-05-31T20:11:17.543" in UTC.

Sample JSON Response

[
    {
        "SalesSiteId": 122700,
        "EverywareTerminalId": 7,
        "ProviderTerminalId": "11ecca669ab8bc94bf60000",
        "ProviderLocationId": "11eca926e0b93ed29150000",
        "TerminalModel": "Ingenico Lane 3000 6987",
        "TerminalName": "Ingenico Lane 3000 6987",
        "IsActive": true,
        "CreatedAt": "2022-05-31T20:11:17.55",
        "UpdatedAt": "2022-06-08T20:22:40.343"
    },
      {
        "SalesSiteId": 122700,
        "EverywareTerminalId": 6,
        "ProviderTerminalId": "11ecd08f84335ffea9940000",
        "ProviderLocationId": "11eca926e0b93ed2915f0000",
        "TerminalModel": "Ingenico Lane 3000 1591 - Mel",
        "TerminalName": "Ingenico Lane 3000 1591 - Mel",
        "IsActive": false,
        "CreatedAt": "2022-05-31T20:11:17.543",
        "UpdatedAt": "2022-09-07T15:27:26.533"
    },
    {
        "SalesSiteId": 122700,
        "EverywareTerminalId": 8,
        "ProviderTerminalId": "11ecc6621246339ebf570000",
        "ProviderLocationId": "11eca926e0b93ed2915f0000",
        "TerminalModel": "Mock Terminal 1",
        "TerminalName": "Mock Terminal 1",
        "IsActive": true,
        "CreatedAt": "2022-05-31T20:11:17.55",
        "UpdatedAt": "2022-09-26T17:40:51.757"
    },
    {
        "SalesSiteId": 122700,
        "EverywareTerminalId": 9,
        "ProviderTerminalId": "11ece285efcf88c0a1d70000",
        "ProviderLocationId": "11eca926e0b93ed29150000",
        "TerminalModel": "Ingenico Lane 3000 1",
        "TerminalName": "Ingenico Lane 3000 1",
        "IsActive": true,
        "CreatedAt": "2022-06-02T21:42:34.393",
        "UpdatedAt": "2022-06-08T20:22:44.943"
    },
    {
        "SalesSiteId": 122700,
        "EverywareTerminalId": 16,
        "ProviderTerminalId": "11ed2a2edf2eeb8c93590000",
        "ProviderLocationId": "11eca926e0b93ed2915f0000",
        "TerminalModel": "Ingenico Move 5000",
        "TerminalName": "Ingenico Move 5000",
        "IsActive": true,
        "CreatedAt": "2022-09-07T15:14:23.21",
        "UpdatedAt": "2022-10-07T17:50:36.367"
    }
]

Get Terminals Portal Example UI

4804 — Terminal information as it appears in Point of Sale Settings in Everyware Portal