Retrieve all POS devices

Request

This endpoint retrieves all point of sale devices for a specific owner (site, merchant, or merchant group).

Path

ownerTypestringrequired

The type of owner for which to retrieve point of sale devices.

Enum:"SITE""MERCHANT""MERCHANTGROUP"

Example:SITE

ownerIdstringrequired

The unique identifier of the owner (site ID, merchant ID, or merchant group ID).

Example:SITE-1

curl -i -X GET \
  https://api-services.pxp.io/api/v1/point-of-sales/SITE/SITE-1/all

Responses

Successfully retrieved the list of point of sale devices.

Bodyapplication/json

Array [

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

commercialModelstring or null

The commercial model for the point of sale device pricing.

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

Example:"Onetime"

authenticationSettingsobject

The authentication settings for a point of sale device.

hostUrlsArray of objects or null

The endpoint URLs used by the PXP point of sale application

Example:

[
  {
    "url": "https://transaction.example.com",
    "urlType": "Transaction"
  }
]

logSettingsobject

The log settings for a point of sale device.

featureSettingsobject

The feature settings for a point of sale device.

storeAndForwardSettingsobject

The store and forward settings for a point of sale device.

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",
    "authenticationSettings": { … },
    "hostUrls": [ … ],
    "logSettings": { … },
    "featureSettings": { … },
    "storeAndForwardSettings": { … },
    "status": "Active",
    "createdOn": "2023-09-01T12:00:00Z",
    "updatedOn": "2023-09-10T15:00:00Z"
  }
]