Devices
ListDeviceCodes
Lists all DeviceCodes associated with the merchant.
get/v2/devices/codes
Query parameters
cursorstring
A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.
See Paginating results for more information.
location_idstring
If specified, only returns DeviceCodes of the specified location. Returns DeviceCodes of all locations if empty.
product_typestring
If specified, only returns DeviceCodes targeting the specified product type. Returns DeviceCodes of all product types if empty.
statusstring
If specified, returns DeviceCodes with the specified statuses. Returns DeviceCodes of status PAIRED and UNPAIRED if empty.
Response
Success
Example response
{
"device_codes": [
{
"code": "EBCARJ",
"created_at": "2020-02-06T18:44:33.000Z",
"device_id": "907CS13101300122",
"id": "B3Z6NAMYQSMTM",
"location_id": "B5E4484SHHNYH",
"name": "Counter 1",
"pair_by": "2020-02-06T18:49:33.000Z",
"product_type": "TERMINAL_API",
"status": "PAIRED",
"status_changed_at": "2020-02-06T18:47:28.000Z"
},
{
"code": "GVXNYN",
"created_at": "2020-02-07T19:55:04.000Z",
"id": "YKGMJMYK8H4PQ",
"location_id": "A6SYFRSV4WAFW",
"name": "Unused device code",
"pair_by": "2020-02-07T20:00:04.000Z",
"product_type": "TERMINAL_API",
"status": "UNPAIRED",
"status_changed_at": "2020-02-07T19:55:04.000Z"
}
]
}