TBBNMerchantDocs
Available

spaces

get/v1/space/branches/{branchId}/front-desk

A location's registered tablets and front-desk staff

curl -X GET https://api.tbbnetwork.com/v1/space/branches/{branchId}/front-desk \
  -H "Authorization: Bearer <session access token>" \

Parameters

branchIdpathrequired

Possible errors

Any other failure (validation, auth, rate limiting, a resource that doesn't exist) returns this same envelope with a non-2xx status — error.code is stable and safe to branch on; error.requestId is worth logging and including in a support request.

Example error response
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "A human-readable description of what went wrong.",
    "requestId": "req_01hxyz..."
  }
}
post/v1/space/branches/{branchId}/devices

Register a tablet to this location with the code it shows

curl -X POST https://api.tbbnetwork.com/v1/space/branches/{branchId}/devices \
  -H "Authorization: Bearer <session access token>" \
  -H "Idempotency-Key: 5f2f...b91" \
  -H "Content-Type: application/json" \
  -d '{
  "registrationCode": "registrationCode",
  "label": "label"
}'

Parameters

branchIdpathrequired

Request body

FieldTypeRequired
registrationCodestringyes
labelstringyes

Possible errors

Any other failure (validation, auth, rate limiting, a resource that doesn't exist) returns this same envelope with a non-2xx status — error.code is stable and safe to branch on; error.requestId is worth logging and including in a support request.

Example error response
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "A human-readable description of what went wrong.",
    "requestId": "req_01hxyz..."
  }
}
patch/v1/space/devices/{id}

Rename a tablet

curl -X PATCH https://api.tbbnetwork.com/v1/space/devices/{id} \
  -H "Authorization: Bearer <session access token>" \
  -H "Idempotency-Key: 5f2f...b91" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "label"
}'

Parameters

idpathrequired

Request body

FieldTypeRequired
labelstringyes

Possible errors

Any other failure (validation, auth, rate limiting, a resource that doesn't exist) returns this same envelope with a non-2xx status — error.code is stable and safe to branch on; error.requestId is worth logging and including in a support request.

Example error response
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "A human-readable description of what went wrong.",
    "requestId": "req_01hxyz..."
  }
}
delete/v1/space/devices/{id}

Remove a tablet; it stops working at once

curl -X DELETE https://api.tbbnetwork.com/v1/space/devices/{id} \
  -H "Authorization: Bearer <session access token>" \
  -H "Idempotency-Key: 5f2f...b91" \

Parameters

idpathrequired

Possible errors

Any other failure (validation, auth, rate limiting, a resource that doesn't exist) returns this same envelope with a non-2xx status — error.code is stable and safe to branch on; error.requestId is worth logging and including in a support request.

Example error response
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "A human-readable description of what went wrong.",
    "requestId": "req_01hxyz..."
  }
}
post/v1/space/branches/{branchId}/staff

Add someone to this location's front desk, with a PIN of 4 to 6 digits

curl -X POST https://api.tbbnetwork.com/v1/space/branches/{branchId}/staff \
  -H "Authorization: Bearer <session access token>" \
  -H "Idempotency-Key: 5f2f...b91" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme Co.",
  "pin": "4821"
}'

Parameters

branchIdpathrequired

Request body

FieldTypeRequired
namestringyes
pinstringyes

Possible errors

Any other failure (validation, auth, rate limiting, a resource that doesn't exist) returns this same envelope with a non-2xx status — error.code is stable and safe to branch on; error.requestId is worth logging and including in a support request.

Example error response
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "A human-readable description of what went wrong.",
    "requestId": "req_01hxyz..."
  }
}
patch/v1/space/staff/{id}

Rename, set a new PIN, or disable front-desk staff

curl -X PATCH https://api.tbbnetwork.com/v1/space/staff/{id} \
  -H "Authorization: Bearer <session access token>" \
  -H "Idempotency-Key: 5f2f...b91" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme Co.",
  "pin": "4821",
  "disabled": false
}'

Parameters

idpathrequired

Request body

FieldTypeRequired
namestring—
pinstring—
disabledboolean—

Possible errors

Any other failure (validation, auth, rate limiting, a resource that doesn't exist) returns this same envelope with a non-2xx status — error.code is stable and safe to branch on; error.requestId is worth logging and including in a support request.

Example error response
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "A human-readable description of what went wrong.",
    "requestId": "req_01hxyz..."
  }
}