Brandtrack Zones API
The Zones API from Brandtrack — 3 operation(s) for zones.
OpenAPI Specification
openapi: 3.0.3
info:
title: Brandtrack API Documentation Accounts Zones API
description: This is the official documentation for the Brandtrack API.
version: 1.0.0
servers:
- url: api.brandtrack.fm
security:
- default: []
tags:
- name: Zones
description: ''
paths:
/v2/zones:
get:
summary: List zones
operationId: listZones
description: Return a paginated list of zones available for the authenticated user.
parameters:
- in: query
name: page
description: The page requested. Default to 1.
example: 1
required: false
schema:
type: integer
description: The page requested. Default to 1.
example: 1
nullable: false
- in: query
name: per_page
description: The number of items per page. Default to 25.
example: 100
required: false
schema:
type: integer
description: The number of items per page. Default to 25.
example: 100
nullable: false
- in: query
name: order_by
description: The field to order the results by. Default to id.
example: id
required: false
schema:
type: string
description: The field to order the results by. Default to id.
example: id
nullable: false
- in: query
name: direction
description: The direction method to sort results. Default to asc.
example: desc
required: false
schema:
type: string
description: The direction method to sort results. Default to asc.
example: desc
nullable: false
- in: header
name: x-customer-api-key
description: ''
example: '{YOUR_AUTH_KEY}'
schema:
type: string
responses: {}
tags:
- Zones
post:
summary: Create a zone
operationId: createAZone
description: 'It has an acknowledgement of the creation of the zone. If set to true, the zone will be created even if it is
over the limits of the account and the subscription will be updated as well. Be aware with it, because you
might update your subscription.
<aside class="notice">This endpoint might affect your subscription according to the parameters provided.</aside>'
parameters:
- in: header
name: x-customer-api-key
description: ''
example: '{YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: Success
content:
application/json:
schema:
type: object
example:
data:
id: 30120
account_id: 19120
account_name: John's Bakery US
code: '207642'
uuid: d1f91b09-f1f9-41d9-ad59-417f6b37766d
name: Downtown Bakery
store_id: 26440
storage_info:
available: null
required: null
is_critical: false
volume: 100
has_volume_change_pending: false
send_logs: false
reset_state: false
fudo_integration_id: null
created_at: '2024-07-31T14:53:07+00:00'
updated_at: '2024-07-31T14:53:07+00:00'
properties:
data:
type: object
properties:
id:
type: integer
example: 30120
account_id:
type: integer
example: 19120
account_name:
type: string
example: John's Bakery US
code:
type: string
example: '207642'
uuid:
type: string
example: d1f91b09-f1f9-41d9-ad59-417f6b37766d
name:
type: string
example: Downtown Bakery
store_id:
type: integer
example: 26440
storage_info:
type: object
properties:
available:
type: string
example: null
required:
type: string
example: null
is_critical:
type: boolean
example: false
volume:
type: integer
example: 100
has_volume_change_pending:
type: boolean
example: false
send_logs:
type: boolean
example: false
reset_state:
type: boolean
example: false
fudo_integration_id:
type: string
example: null
created_at:
type: string
example: '2024-07-31T14:53:07+00:00'
updated_at:
type: string
example: '2024-07-31T14:53:07+00:00'
404:
description: Wrong Store ID
content:
application/json:
schema:
type: object
example:
message: 404 Not Found
status_code: 404
properties:
message:
type: string
example: 404 Not Found
status_code:
type: integer
example: 404
tags:
- Zones
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Must not be greater than 255 characters.
example: wksbjvmkcdvigzoocmgbmak
nullable: false
normalization_type:
type: string
description: ''
example: '2020'
nullable: false
enum:
- default
- '2020'
- '2021'
acknowledgement:
type: boolean
description: ''
example: false
nullable: false
account_id:
type: string
description: ''
example: dolores
nullable: false
smart_integration_ids:
type: array
description: Must not be greater than 20 characters.
example:
- ittbqvsmn
items:
type: string
store_id:
type: string
description: This field is required when <code>store</code> is not present. The <code>id</code> of an existing record in the stores table.
example: null
nullable: false
store:
type: object
description: This field is required when <code>store_id</code> is not present.
example: null
nullable: false
properties:
account_id:
type: string
description: This field is required when <code>store_id</code> is not present. The <code>id</code> of an existing record in the accounts table.
example: null
nullable: false
name:
type: string
description: This field is required when <code>store_id</code> is not present. Must not be greater than 100 characters.
example: nakazflogfmasszhyfusegkj
nullable: false
country:
type: string
description: This field is required when <code>store_id</code> is not present. The <code>iso</code> of an existing record in the countries table. Must be 2 characters.
example: ty
nullable: false
type:
type: string
description: This field is required when <code>store_id</code> is not present.
example: franchise
nullable: false
enum:
- own
- franchise
address:
type: string
description: Must not be greater than 255 characters.
example: eeqr
nullable: true
phone_number:
type: string
description: Must not be greater than 40 characters.
example: smunsajmopwln
nullable: true
email:
type: string
description: Must be a valid email address. Must not be greater than 100 characters.
example: heaney.clair@example.org
nullable: true
manager:
type: string
description: Must not be greater than 255 characters.
example: ulbq
nullable: true
timezone:
type: string
description: ''
example: America/Argentina/San_Luis
nullable: true
enum:
- Africa/Abidjan
- Africa/Accra
- Africa/Addis_Ababa
- Africa/Algiers
- Africa/Asmara
- Africa/Bamako
- Africa/Bangui
- Africa/Banjul
- Africa/Bissau
- Africa/Blantyre
- Africa/Brazzaville
- Africa/Bujumbura
- Africa/Cairo
- Africa/Casablanca
- Africa/Ceuta
- Africa/Conakry
- Africa/Dakar
- Africa/Dar_es_Salaam
- Africa/Djibouti
- Africa/Douala
- Africa/El_Aaiun
- Africa/Freetown
- Africa/Gaborone
- Africa/Harare
- Africa/Johannesburg
- Africa/Juba
- Africa/Kampala
- Africa/Khartoum
- Africa/Kigali
- Africa/Kinshasa
- Africa/Lagos
- Africa/Libreville
- Africa/Lome
- Africa/Luanda
- Africa/Lubumbashi
- Africa/Lusaka
- Africa/Malabo
- Africa/Maputo
- Africa/Maseru
- Africa/Mbabane
- Africa/Mogadishu
- Africa/Monrovia
- Africa/Nairobi
- Africa/Ndjamena
- Africa/Niamey
- Africa/Nouakchott
- Africa/Ouagadougou
- Africa/Porto-Novo
- Africa/Sao_Tome
- Africa/Tripoli
- Africa/Tunis
- Africa/Windhoek
- America/Adak
- America/Anchorage
- America/Anguilla
- America/Antigua
- America/Araguaina
- America/Argentina/Buenos_Aires
- America/Argentina/Catamarca
- America/Argentina/Cordoba
- America/Argentina/Jujuy
- America/Argentina/La_Rioja
- America/Argentina/Mendoza
- America/Argentina/Rio_Gallegos
- America/Argentina/Salta
- America/Argentina/San_Juan
- America/Argentina/San_Luis
- America/Argentina/Tucuman
- America/Argentina/Ushuaia
- America/Aruba
- America/Asuncion
- America/Atikokan
- America/Bahia
- America/Bahia_Banderas
- America/Barbados
- America/Belem
- America/Belize
- America/Blanc-Sablon
- America/Boa_Vista
- America/Bogota
- America/Boise
- America/Cambridge_Bay
- America/Campo_Grande
- America/Cancun
- America/Caracas
- America/Cayenne
- America/Cayman
- America/Chicago
- America/Chihuahua
- America/Ciudad_Juarez
- America/Costa_Rica
- America/Creston
- America/Cuiaba
- America/Curacao
- America/Danmarkshavn
- America/Dawson
- America/Dawson_Creek
- America/Denver
- America/Detroit
- America/Dominica
- America/Edmonton
- America/Eirunepe
- America/El_Salvador
- America/Fort_Nelson
- America/Fortaleza
- America/Glace_Bay
- America/Goose_Bay
- America/Grand_Turk
- America/Grenada
- America/Guadeloupe
- America/Guatemala
- America/Guayaquil
- America/Guyana
- America/Halifax
- America/Havana
- America/Hermosillo
- America/Indiana/Indianapolis
- America/Indiana/Knox
- America/Indiana/Marengo
- America/Indiana/Petersburg
- America/Indiana/Tell_City
- America/Indiana/Vevay
- America/Indiana/Vincennes
- America/Indiana/Winamac
- America/Inuvik
- America/Iqaluit
- America/Jamaica
- America/Juneau
- America/Kentucky/Louisville
- America/Kentucky/Monticello
- America/Kralendijk
- America/La_Paz
- America/Lima
- America/Los_Angeles
- America/Lower_Princes
- America/Maceio
- America/Managua
- America/Manaus
- America/Marigot
- America/Martinique
- America/Matamoros
- America/Mazatlan
- America/Menominee
- America/Merida
- America/Metlakatla
- America/Mexico_City
- America/Miquelon
- America/Moncton
- America/Monterrey
- America/Montevideo
- America/Montserrat
- America/Nassau
- America/New_York
- America/Nome
- America/Noronha
- America/North_Dakota/Beulah
- America/North_Dakota/Center
- America/North_Dakota/New_Salem
- America/Nuuk
- America/Ojinaga
- America/Panama
- America/Paramaribo
- America/Phoenix
- America/Port-au-Prince
- America/Port_of_Spain
- America/Porto_Velho
- America/Puerto_Rico
- America/Punta_Arenas
- America/Rankin_Inlet
- America/Recife
- America/Regina
- America/Resolute
- America/Rio_Branco
- America/Santarem
- America/Santiago
- America/Santo_Domingo
- America/Sao_Paulo
- America/Scoresbysund
- America/Sitka
- America/St_Barthelemy
- America/St_Johns
- America/St_Kitts
- America/St_Lucia
- America/St_Thomas
- America/St_Vincent
- America/Swift_Current
- America/Tegucigalpa
- America/Thule
- America/Tijuana
- America/Toronto
- America/Tortola
- America/Vancouver
- America/Whitehorse
- America/Winnipeg
- America/Yakutat
- Antarctica/Casey
- Antarctica/Davis
- Antarctica/DumontDUrville
- Antarctica/Macquarie
- Antarctica/Mawson
- Antarctica/McMurdo
- Antarctica/Palmer
- Antarctica/Rothera
- Antarctica/Syowa
- Antarctica/Troll
- Antarctica/Vostok
- Arctic/Longyearbyen
- Asia/Aden
- Asia/Almaty
- Asia/Amman
- Asia/Anadyr
- Asia/Aqtau
- Asia/Aqtobe
- Asia/Ashgabat
- Asia/Atyrau
- Asia/Baghdad
- Asia/Bahrain
- Asia/Baku
- Asia/Bangkok
- Asia/Barnaul
- Asia/Beirut
- Asia/Bishkek
- Asia/Brunei
- Asia/Chita
- Asia/Choibalsan
- Asia/Colombo
- Asia/Damascus
- Asia/Dhaka
- Asia/Dili
- Asia/Dubai
- Asia/Dushanbe
- Asia/Famagusta
- Asia/Gaza
- Asia/Hebron
- Asia/Ho_Chi_Minh
- Asia/Hong_Kong
- Asia/Hovd
- Asia/Irkutsk
- Asia/Jakarta
- Asia/Jayapura
- Asia/Jerusalem
- Asia/Kabul
- Asia/Kamchatka
- Asia/Karachi
- Asia/Kathmandu
- Asia/Khandyga
- Asia/Kolkata
- Asia/Krasnoyarsk
- Asia/Kuala_Lumpur
- Asia/Kuching
- Asia/Kuwait
- Asia/Macau
- Asia/Magadan
- Asia/Makassar
- Asia/Manila
- Asia/Muscat
- Asia/Nicosia
- Asia/Novokuznetsk
- Asia/Novosibirsk
- Asia/Omsk
- Asia/Oral
- Asia/Phnom_Penh
- Asia/Pontianak
- Asia/Pyongyang
- Asia/Qatar
- Asia/Qostanay
- Asia/Qyzylorda
- Asia/Riyadh
- Asia/Sakhalin
- Asia/Samarkand
- Asia/Seoul
- Asia/Shanghai
- Asia/Singapore
- Asia/Srednekolymsk
- Asia/Taipei
- Asia/Tashkent
- Asia/Tbilisi
- Asia/Tehran
- Asia/Thimphu
- Asia/Tokyo
- Asia/Tomsk
- Asia/Ulaanbaatar
- Asia/Urumqi
- Asia/Ust-Nera
- Asia/Vientiane
- Asia/Vladivostok
- Asia/Yakutsk
- Asia/Yangon
- Asia/Yekaterinburg
- Asia/Yerevan
- Atlantic/Azores
- Atlantic/Bermuda
- Atlantic/Canary
- Atlantic/Cape_Verde
- Atlantic/Faroe
- Atlantic/Madeira
- Atlantic/Reykjavik
- Atlantic/South_Georgia
- Atlantic/St_Helena
- Atlantic/Stanley
- Australia/Adelaide
- Australia/Brisbane
- Australia/Broken_Hill
- Australia/Darwin
- Australia/Eucla
- Australia/Hobart
- Australia/Lindeman
- Australia/Lord_Howe
- Australia/Melbourne
- Australia/Perth
- Australia/Sydney
- Europe/Amsterdam
- Europe/Andorra
- Europe/Astrakhan
- Europe/Athens
- Europe/Belgrade
- Europe/Berlin
- Europe/Bratislava
- Europe/Brussels
- Europe/Bucharest
- Europe/Budapest
- Europe/Busingen
- Europe/Chisinau
- Europe/Copenhagen
- Europe/Dublin
- Europe/Gibraltar
- Europe/Guernsey
- Europe/Helsinki
- Europe/Isle_of_Man
- Europe/Istanbul
- Europe/Jersey
- Europe/Kaliningrad
- Europe/Kirov
- Europe/Kyiv
- Europe/Lisbon
- Europe/Ljubljana
- Europe/London
- Europe/Luxembourg
- Europe/Madrid
- Europe/Malta
- Europe/Mariehamn
- Europe/Minsk
- Europe/Monaco
- Europe/Moscow
- Europe/Oslo
- Europe/Paris
- Europe/Podgorica
- Europe/Prague
- Europe/Riga
- Europe/Rome
- Europe/Samara
- Europe/San_Marino
- Europe/Sarajevo
- Europe/Saratov
- Europe/Simferopol
- Europe/Skopje
- Europe/Sofia
- Europe/Stockholm
- Europe/Tallinn
- Europe/Tirane
- Europe/Ulyanovsk
- Europe/Vaduz
- Europe/Vatican
- Europe/Vienna
- Europe/Vilnius
- Europe/Volgograd
- Europe/Warsaw
- Europe/Zagreb
- Europe/Zurich
- Indian/Antananarivo
- Indian/Chagos
- Indian/Christmas
- Indian/Cocos
- Indian/Comoro
- Indian/Kerguelen
- Indian/Mahe
- Indian/Maldives
- Indian/Mauritius
- Indian/Mayotte
- Indian/Reunion
- Pacific/Apia
- Pacific/Auckland
- Pacific/Bougainville
- Pacific/Chatham
- Pacific/Chuuk
- Pacific/Easter
- Pacific/Efate
- Pacific/Fakaofo
- Pacific/Fiji
- Pacific/Funafuti
- Pacific/Galapagos
- Pacific/Gambier
- Pacific/Guadalcanal
- Pacific/Guam
- Pacific/Honolulu
- Pacific/Kanton
- Pacific/Kiritimati
- Pacific/Kosrae
- Pacific/Kwajalein
- Pacific/Majuro
- Pacific/Marquesas
- Pacific/Midway
- Pacific/Nauru
- Pacific/Niue
- Pacific/Norfolk
- Pacific/Noumea
- Pacific/Pago_Pago
- Pacific/Palau
- Pacific/Pitcairn
- Pacific/Pohnpei
- Pacific/Port_Moresby
- Pacific/Rarotonga
- Pacific/Saipan
- Pacific/Tahiti
- Pacific/Tarawa
- Pacific/Tongatapu
- Pacific/Wake
- Pacific/Wallis
- UTC
city:
type: string
description: Must not be greater than 100 characters.
example: sipfqyniwoqkxoqmqztrraaei
nullable: true
zip_code:
type: string
description: Must not be greater than 20 characters.
example: cvlwjh
nullable: true
additional_information:
type: string
description: Must not be greater than 1024 characters.
example: pqidxjf
nullable: true
box:
type: object
description: ''
example: null
nullable: false
properties:
recipient:
type: object
description: This field is required when <code>box</code> is present.
example: null
nullable: false
properties:
name:
type: string
description: This field is required when <code>box</code> is present. Must be at least 3 characters. Must not be greater than 100 characters.
example: fvzwzdfklpkdvrrjiifbesfk
nullable: false
address:
type: string
description: This field is required when <code>box</code> is present. Must be at least 6 characters. Must not be greater than 255 characters.
example: tttdqjjaflmwugos
nullable: false
city:
type: string
description: This field is required when <code>box</code> is present. Must be at least 6 characters. Must not be greater than 100 characters.
example: ze
nullable: false
zip_code:
type: string
description: This field is required when <code>box</code> is present. Must be at least 3 characters. Must not be greater than 20 characters.
example: xxxesuwlwqwcs
nullable: false
identification_type:
type: string
description: This field is required when <code>box</code> is present.
example: PASSPORT
nullable: false
enum:
- DNI
- ID
- PASSPORT
identification_number:
type: string
description: This field is required when <code>box</code> is present. Must be at least 4 characters. Must not be greater than 20 characters.
example: qaeu
nullable: false
phone:
type: string
description: This field is required when <code>box</code> is present. Must be at least 8 characters. Must not be greater than 40 characters.
example: ukgzevuvvrfsoypg
nullable: false
additional_information:
type: string
description: Must not be greater than 1024 characters.
example: tyxnhiinvnmylehopb
nullable: true
connection_settings:
type: object
description: This field is required when <code>box</code> is present.
example: null
nullable: false
properties:
connection_type:
type: string
description: This field is required when <code>box</code> is present.
example: ETHERNET
nullable: false
enum:
- WIFI
- ETHERNET
network:
type: string
description: This field is required when <code>box.connection_settings.connection_type</code> is <code>WIFI</code>. Must not be greater than 255 characters.
example: tecxxs
nullable: false
password:
type: string
description: This field is required when <code>box.connection_settings.connection_type</code> is <code>WIFI</code>. Must not be greater than 255 characters.
example: faiP]=(ge69'
nullable: false
type_of_network:
type: string
description: This field is required when <code>box.connection_settings.connection_type</code> is <code>WIFI</code>.
example: WEP
nullable: false
# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/brandtrack/refs/heads/main/openapi/brandtrack-zones-api-openapi.yml