• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
DeviceCode BETA

Properties

Name Description
id
string

Read only The unique id for this device code.

name
string

An optional user-defined name for the device code.

Max Length 128
code
string

Read only The unique code that can be used to login.

device_id
string

Read only The unique id of the device that used this code. Populated when the device is paired up.

product_type
string

Required

The targeting product type of the device code.

location_id
string

The location assigned to this code.

Max Length 50
status
string

Read only The pairing status of the device code.

pair_by
string

Read only When this DeviceCode will expire and no longer login. Timestamp in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

created_at
string

Read only When this DeviceCode was created. Timestamp in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

status_changed_at
string

Read only When this DeviceCode's status was last changed. Timestamp in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

paired_at
string

Read only When this DeviceCode was paired. Timestamp in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?