Serviço de listagem de lojas

Após obter o token ou assinatura na etapa anterior, a loja virtual pode consumir o serviço de listagem de lojas.

Detalhes da chamada#

  • Recurso: /v1/merchants
  • Método HTTP: GET
  • Formato da requisição: query string
  • Formato da resposta: JSON
  • Parâmetros de cabeçalho:
ParâmetroDescriçãoFormatoObrigatório
merchant_idCódigo da loja no Carat. Os códigos de produção e certificação serão diferentes.< 15 ANSIM
merchant_keyChave de autenticação da loja no Carat. As chaves de produção e certificação serão diferentes.< 80 ANSIM
tokenToken obtido no serviço de criação de token. Saiba mais.= 66 ANNÃO
AuthorizationDeve ser enviada a assinatura de autenticação da loja no formato Bearer {assinatura}. Exemplo: Bearer JHVGytfdgauygdauiw78264284527852897hagdg.< 2000 ANNÃO

Exemplo#

Abaixo estão alguns exemplos da chamada do serviço de listagem de loja utilizando a ferramenta cURL.

Listagem de loja utilizando token#

Requisição:

curl
--request GET "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/merchants?cnpj=12345678901234&merchant_status=A&page=1&limit=1"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--header "token: 1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--verbose

Listagem de loja utilizando assinatura#

Requisição:

curl
--request GET "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/merchants?cnpj=12345678901234&merchant_status=A&page=1&limit=1"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--header "Authorization: Bearer YYYYYYY"
--verbose

Resposta:

{
"response_code": "0",
"response_message": "OK",
"current_page": "0",
"total_pages": "1",
"count": "1",
"merchants": [
{
"id": "qereIoinsd3d",
"merchant_status": "A",
"fantasy_name": "Teste de Loja",
"corporate_name": "Testes de Loja Ltda.",
"cnpj": "12345678901234"
}
]
}

Parâmetros de requisição#

ParâmetroDescriçãoFormatoObrigatório
cnpjCNPJ da loja.= 14 NNão
merchant_statusStatus da loja. Pode assumir os seguintes valores: A = Ativa I = Inativa= 1 NNão
pagePágina da listagem. A primeira página tem valor 0. Caso não seja enviada, assumiremos o valor 0.< 4 NNão
limitNúmero máximo de registros por página. Caso não seja enviado, assumiremos o valor máximo 100.< 3 NNão

Parâmetros de resposta#

Em caso de sucesso, o código de resposta HTTP será 200. Qualquer outro código deve ser interpretado como erro.

ParâmetroDescriçãoFormato
response_codeCódigo de resposta do Carat.< 4 N
response_messageMensagem de resposta do Carat.< 500 AN
current_pagePágina atual dos registros.< 4 N
total_pagesNúmero total de páginas.< 4 N
countContagem total de registros.< 4 N
merchants[]Lista de lojas retornada na consulta.
idCódigo da loja consultada.< 15 AN
merchant_statusStatus da loja. Pode assumir os seguintes valores: A = Ativa I = Inativa= 1 N
fantasy_nameNome fantasia da loja.< 250 AN
corporate_nameRazão social da loja.< 250 AN
cnpjCNPJ ou CPF da loja. Apenas números.< 14 N