# POS service API

This is an API reference for the Point of Sale service, which allows you to manage point of sale devices, including their settings, activation, and configuration.

Version: 1.0.0

## Servers

Production environment
```
https://api-services.pxp.io/api/v1
```

Sandbox environment
```
https://api-services.test.pxp.io/api/v1
```

## Download OpenAPI description

[POS service API](https://developer.pxp.io/_bundle/apis/point-of-sale.yaml)

## Manage POS devices

### Add a POS device

 - [POST /point-of-sales/{site}](https://developer.pxp.io/apis/point-of-sale/manage-pos-devices/add-pos-device.md): This endpoint is used to initiate a new point of sale device for a specific site. It creates the device with the provided configuration settings.

### Retrieve a POS device

 - [GET /point-of-sales/{site}/{merchantPointOfSaleId}](https://developer.pxp.io/apis/point-of-sale/manage-pos-devices/retrieve-pos-device.md): This endpoint retrieves the details of a specific point of sale device by its merchant ID.

### Delete a POS device

 - [DELETE /point-of-sales/{site}/{merchantPointOfSaleId}](https://developer.pxp.io/apis/point-of-sale/manage-pos-devices/delete-pos-device.md): This endpoint deletes a specific point of sale device.

### Update a POS device

 - [PUT /point-of-sales/{site}/{merchantPointOfSaleId}](https://developer.pxp.io/apis/point-of-sale/manage-pos-devices/update-pos-device.md): This endpoint updates the details of a specific point of sale device.

### Activate a POS device

 - [PUT /point-of-sales/{serialNumber}/activate](https://developer.pxp.io/apis/point-of-sale/manage-pos-devices/activate-pos-device.md): This endpoint activates a point of sale device using its serial number.

### Retrieve all POS devices

 - [GET /point-of-sales/{ownerType}/{ownerId}/all](https://developer.pxp.io/apis/point-of-sale/manage-pos-devices/retrieve-all-pos-devices.md): This endpoint retrieves all point of sale devices for a specific owner (site, merchant, or merchant group).

## Authentication settings

### Create authentication settings

 - [POST /point-of-sales/{pointOfSaleId}/authentication-settings](https://developer.pxp.io/apis/point-of-sale/authentication-settings/create-authentication-settings.md): This endpoint creates authentication settings for a specific point of sale device.

### Get authentication settings

 - [GET /point-of-sales/{pointOfSaleId}/authentication-settings](https://developer.pxp.io/apis/point-of-sale/authentication-settings/get-authentication-settings.md): This endpoint retrieves the authentication settings for a specific point of sale device.

### Update authentication settings

 - [PUT /point-of-sales/{pointOfSaleId}/authentication-settings](https://developer.pxp.io/apis/point-of-sale/authentication-settings/update-authentication-settings.md): This endpoint updates the authentication settings for a specific point of sale device.

## Feature settings

### Create feature settings

 - [POST /point-of-sales/{pointOfSaleId}/feature-settings](https://developer.pxp.io/apis/point-of-sale/feature-settings/create-feature-settings.md): This endpoint creates feature settings for a specific point of sale device.

### Get feature settings

 - [GET /point-of-sales/{pointOfSaleId}/feature-settings](https://developer.pxp.io/apis/point-of-sale/feature-settings/get-feature-settings.md): This endpoint retrieves the feature settings for a specific point of sale device.

### Update feature settings

 - [PUT /point-of-sales/{pointOfSaleId}/feature-settings](https://developer.pxp.io/apis/point-of-sale/feature-settings/update-feature-settings.md): This endpoint updates the feature settings for a specific point of sale device.

## General settings

### Create general settings

 - [POST /point-of-sales/{site}/general-settings](https://developer.pxp.io/apis/point-of-sale/general-settings/create-general-settings.md): This endpoint creates general settings for a specific site.

### Get general settings

 - [GET /point-of-sales/{pointOfSaleId}/general-settings](https://developer.pxp.io/apis/point-of-sale/general-settings/get-general-settings.md): This endpoint retrieves the general settings for a specific point of sale device.

### Update general settings

 - [PUT /point-of-sales/{pointOfSaleId}/general-settings](https://developer.pxp.io/apis/point-of-sale/general-settings/update-general-settings.md): This endpoint updates the general settings for a specific point of sale device.

## Log settings

### Create log settings

 - [POST /point-of-sales/{pointOfSaleId}/log-settings](https://developer.pxp.io/apis/point-of-sale/log-settings/create-log-settings.md): This endpoint creates log settings for a specific point of sale device.

### Get log settings

 - [GET /point-of-sales/{pointOfSaleId}/log-settings](https://developer.pxp.io/apis/point-of-sale/log-settings/get-log-settings.md): This endpoint retrieves the log settings for a specific point of sale device.

### Update log settings

 - [PUT /point-of-sales/{pointOfSaleId}/log-settings](https://developer.pxp.io/apis/point-of-sale/log-settings/update-log-settings.md): This endpoint updates the log settings for a specific point of sale device.

## Store and Forward settings

### Create Store and Forward settings

 - [POST /point-of-sales/{pointOfSaleId}/store-and-forward-settings](https://developer.pxp.io/apis/point-of-sale/store-and-forward-settings/create-store-and-forward-settings.md): This endpoint creates store and forward settings for a specific point of sale device.

### Get Store and Forward settings

 - [GET /point-of-sales/{pointOfSaleId}/store-and-forward-settings](https://developer.pxp.io/apis/point-of-sale/store-and-forward-settings/get-store-and-forward-settings.md): This endpoint retrieves the store and forward settings for a specific point of sale device.

### Update Store and Forward settings

 - [PUT /point-of-sales/{pointOfSaleId}/store-and-forward-settings](https://developer.pxp.io/apis/point-of-sale/store-and-forward-settings/update-store-and-forward-settings.md): This endpoint updates the store and forward settings for a specific point of sale device.

## URL settings

### Create host URL settings

 - [POST /point-of-sales/{pointOfSaleId}/host-url-settings](https://developer.pxp.io/apis/point-of-sale/url-settings/create-host-url-settings.md): This endpoint creates host URL settings for a specific point of sale device.

### Get host URL settings

 - [GET /point-of-sales/{pointOfSaleId}/{urlType}/host-url-settings](https://developer.pxp.io/apis/point-of-sale/url-settings/get-host-url-settings.md): This endpoint retrieves specific host URL settings for a point of sale device by URL type.

### Update host URL settings

 - [PUT /point-of-sales/{pointOfSaleId}/{urlType}/host-url-settings](https://developer.pxp.io/apis/point-of-sale/url-settings/update-host-url-settings.md): This endpoint updates specific host URL settings for a point of sale device by URL type.