FBfbits
Admin API · Promoções

Listar cidades

Lista as cidades presentes nos endereços cadastrados na loja, no formato aceito pelo filtro cities da busca de clientes ("Cidade - UF").

Permissão: Cadastro de promoções — visualização.

get/api/promotions/customers/cities

Request

  • Base URL
    https://sualoja.commerce-wake.tech
  • URL
    https://sualoja.commerce-wake.tech/api/promotions/customers/cities
  • Auth
    HTTP bearer

Headers

x-api-version'2.0' required

Versão da API. Obrigatório: sem ele a resposta é 400 (API_VERSION_REQUIRED).

Response

Cidades em data.

totalinteger nullable

Total informado pela listagem. Nas rotas de apoio de promoções é a quantidade de itens desta página; o total geral fica em totalGeneral.

totalGeneralinteger nullable

Total de itens que atendem aos filtros, em todas as páginas.

totalActiveinteger nullable

Total de itens ativos, quando a listagem informa.

totalInactiveinteger nullable

Total de itens inativos, quando a listagem informa.

totalArchivedinteger nullable

Total de itens arquivados, quando a listagem informa.

limitinteger nullable

Tamanho de página usado.

pageinteger nullable

Página retornada, começando em 1.

totalPageinteger nullable

Quantidade de páginas, quando a listagem informa.

messagestring nullable

Observação opcional sobre a listagem (por exemplo, por que veio vazia). Omitida quando nula.

Changes

No recorded changes to this operation across all 1 revision of this API.