General settings

Create general settings

Request

This endpoint creates general settings for a specific site.

Path

sitestringrequired

The ID of the site where the settings will be applied.

Example:SITE-1

Bodyapplication/jsonrequired

The general settings to apply to the site.

serialNumberstringrequired

The serial number of the point of sale device to activate.

Example:"SN1234567890"

merchantPointOfSaleIdstring or null

The unique merchant identifier for the point of sale device.

Example:"POS-12345"

deviceModelstringrequired

The model of the point of sale device.

Enum:"CastlesSaturn1000""ZebraTC510K"

Example:"CastlesSaturn1000"

communicationProtocolstringrequired

The protocol used by the point of sale device.

Value:"HTTP"

Example:"HTTP"

communicationEndpointstring or null

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"

curl -i -X POST \
  https://api-services.pxp.io/api/v1/point-of-sales/SITE-1/general-settings \
  -H 'Content-Type: application/json' \
  -d '{
    "serialNumber": "SN1234567890",
    "merchantPointOfSaleId": "POS-12345",
    "deviceModel": "CastlesSaturn1000",
    "communicationProtocol": "HTTP",
    "communicationEndpoint": "http://pos.example.com"
  }'

Responses

Successfully created the general settings.

Bodyapplication/json

statusstring

The status of the point of sale device.

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

Example:"Active"

sitestring

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

Example:"SITE-1"

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

Response

{
  "status": "Active",
  "site": "SITE-1",
  "merchantPointOfSaleId": "POS-12345",
  "pointOfSaleId": 123456789
}