Serviço de consulta de status loja

import ApiDoc from '../../src/components/api-doc/ApiDoc'; import ResponseCodes from './codigos-de-resposta.md';

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

Atenção:

A loja a solicitar o status deve ter as devidas permissões e também deve estar presente no mesmo grupo em que a loja requisitada. Para mais informações sobre como habilitar a Consulta de Status de Loja, contate a nossa equipe de suporte.

Detalhes da chamada

<ApiDoc method="get" path="/e-sitef/api/v1/merchants/status/{id}" />

  • Recurso: /v1/merchants/status/{id}
  • Método HTTP: GET
  • 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 {TOKEN_JWT_EXAMPLE}.< 2000 ANNÃO

Exemplo

Resposta:

{
  "response_code": "0",
  "response_message": "OK",
  "merchant_status": "A"
}

Parâmetros de resposta

ParâmetroDescriçãoFormato
response_codeCódigo de resposta do Carat.< 4 N
response_messageMensagem de resposta do Carat.< 500 AN
merchant_statusStatus da loja consultada. A = ATIVA; I = INATIVA1 A