Get general settings

Request

This endpoint retrieves the general settings for a specific point of sale device.

Path

pointOfSaleIdinteger, (int64)required

The unique system identifier for the point of sale device.

Example:123456789

curl -i -X GET \
  https://api-services.pxp.io/api/v1/point-of-sales/123456789/general-settings

Responses

Successfully retrieved the general settings.

Bodyapplication/json

sitestring

The ID of the site where the point of sale will be deployed.

Example:"SITE-1"

serialNumberstring

The serial number of the point of sale device

Example:"SN1234567890"

merchantPointOfSaleIdstring

The unique merchant identifier for the point of sale device.

Example:"POS-12345"

pointOfSaleIdinteger, (int64)

The unique system identifier for the point of sale device.

Example:123456789

deviceModelstring

The model of the point of sale device.

Enum:"CastlesSaturn1000""ZebraTC510K""LandiP30SeriesWifiSim""LandiP30SeriesWifi""LandiP30SeriesWifiSimDS""LandiP30SeriesWifiDS""LandiP30DualWifiSim""LandiP30DualWifi""LandiP30DualWifiSimDS""LandiP30DualWifiDS"

Example:"CastlesSaturn1000"

communicationProtocolstring

The protocol used by the point of sale device.

Value:"HTTP"

Example:"HTTP"

communicationEndpointstring

The URL or network endpoint where the point of sale device actively listens for incoming connections and communications from the merchant system.

Example:"http://pos.example.com"

commercialModelstring or null

The commercial model for the point of sale device pricing.

Enum:"Onetime""Recurring""Financed""Both"

Example:"Onetime"

inUseboolean

Indicates whether the point of sale device is currently in use.

Example:false

statusstring

The status of the point of sale device.

Enum:"New""Pending""Active""Disabled"

Example:"Active"

createdOnstring, (date-time)

Example:"2023-09-01T12:00:00Z"

updatedOnstring or null, (date-time)

Example:"2023-09-10T15:00:00Z"

Response

{
  "site": "SITE-1",
  "serialNumber": "SN1234567890",
  "merchantPointOfSaleId": "POS-12345",
  "pointOfSaleId": 123456789,
  "deviceModel": "CastlesSaturn1000",
  "communicationProtocol": "HTTP",
  "communicationEndpoint": "http://pos.example.com",
  "commercialModel": "Onetime",
  "inUse": false,
  "status": "Active",
  "createdOn": "2023-09-01T12:00:00Z",
  "updatedOn": "2023-09-10T15:00:00Z"
}