# Outlet

Operations related to outlet, including create, get, etc

## List Outlets

 - [GET /api/v3/Outlet](https://developer.dealpos.com/openapi/openapi/outlet/getoutletlist.md): Get a list of outlets, optionally filtered by name, access, or suspended status.
Requires the "VIEW" role in the "Outlets" group.

## Update an Outlet

 - [PUT /api/v3/Outlet](https://developer.dealpos.com/openapi/openapi/outlet/putoutlet.md): Update an outlet's configuration.
Requires one of the following roles: "EDIT" in the "Outlets" module or "EDIT" in the "Global" module.

## Create an Outlet

 - [POST /api/v3/Outlet](https://developer.dealpos.com/openapi/openapi/outlet/postoutlet.md): Create an Outlet

You must have "CREATE" role in "Outlets" Module

## Delete an Outlet

 - [DELETE /api/v3/Outlet](https://developer.dealpos.com/openapi/openapi/outlet/deleteoutlet.md): Delete an Outlet

You must have "DELETE" role in "Outlets" Module

## Get Outlet By ID

 - [GET /api/v3/Outlet/ID/{id}](https://developer.dealpos.com/openapi/openapi/outlet/getoutletbyid.md): Get an outlet's details by its ID.
Requires the "VIEW" role in the "Outlets" group.

## Get Outlet List By List ID

 - [GET /api/v3/Outlet/ListID](https://developer.dealpos.com/openapi/openapi/outlet/getoutletlistbylistid.md): Get outlet names and codes for a list of outlet IDs.
Requires the "VIEW" role in the "Outlets" group.

## Get Outlet Detail

 - [GET /api/v3/Outlet/Detail](https://developer.dealpos.com/openapi/openapi/outlet/getoutletdetail.md): Get detailed information for an outlet by code or name.
Requires the "VIEW" role in the "Outlets" group.

## Get Register by Outlet

 - [GET /api/v3/Outlet/Register](https://developer.dealpos.com/openapi/openapi/outlet/get-outlet-register.md): Get the list of registers for a given outlet (or all outlets when empty).
Requires the "VIEW" role in the "Outlets" group.

## Get Register By OutletID

 - [GET /api/v3/Outlet/Register/ID](https://developer.dealpos.com/openapi/openapi/outlet/getregisterbyoutletid.md): Get register information for a list of outlet IDs.
Requires the "VIEW" role in the "Outlets" group.