Update general settings

Request

This endpoint updates 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

Bodyapplication/jsonrequired

The updated general settings.

sitestring or null

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

Example:"SITE-1"

serialNumberstring or null

The serial number of the point of sale device

Example:"SN1234567890"

merchantPointOfSaleIdstring or null

The unique merchant identifier for the point of sale device.

Example:"POS-12345"

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 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"

statusstring

The status of the point of sale device.

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

Example:"Active"

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

Responses

Successfully updated the general settings.