Authorizations
API key for your store
Body
application/json
Commerce Engine is now in beta. We're working hard to make it better for you.
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/pos/auth/pair-device \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{
"pairing_code": "<string>"
}'
{
"message": "<string>",
"success": true,
"content": {
"device": {
"id": "<string>",
"name": "<string>",
"device_type": "pos-terminal",
"external_device_id": "<string>",
"vendor": "<string>",
"model_number": "<string>",
"mac_address": "<string>",
"location_id": "<string>",
"location_name": "<string>",
"claimed_by": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>",
"email": "jsmith@example.com"
},
"status": "available",
"is_busy": true
}
}
}
This endpoint allows a POS device to be activated by submitting a valid pairing code received via phone or email. The endpoint requires authentication with an API key that has the scope set to โstorefrontโ for a particular store, ensuring secure access for device activation operation.
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/pos/auth/pair-device \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{
"pairing_code": "<string>"
}'
{
"message": "<string>",
"success": true,
"content": {
"device": {
"id": "<string>",
"name": "<string>",
"device_type": "pos-terminal",
"external_device_id": "<string>",
"vendor": "<string>",
"model_number": "<string>",
"mac_address": "<string>",
"location_id": "<string>",
"location_name": "<string>",
"claimed_by": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>",
"email": "jsmith@example.com"
},
"status": "available",
"is_busy": true
}
}
}
API key for your store
Was this page helpful?