List merchants service
After getting the token or signature in the previous step, the virtual store may consume the store list service
#
Call details- Resource:
/v1/merchants
- HTTP Method:
GET
- Request format:
query string
- Response format:
JSON
- Header parameters:
Parameter | Description | Format | Mandatory |
---|---|---|---|
merchant_id | Merchant code on Carat Portal. The production and certification codes will be different. | < 15 AN | YES |
merchant_key | Merchant authentication key on Carat Portal. The production and certification keys will be different. | < 80 AN | YES |
token | Token obtained on the token creation service. Learn more. | = 66 AN | NO |
Authorization | The merchant's signature must be sent in the format Bearer {signature} . Exemple: Bearer JHVGytfdgauygdauiw78264284527852897hagdg . | < 2000 AN | NO |
#
Example#
Store list using tokenRequest:
To use this example, don't forget to define the variable {{url}}
to the value
esitef-homologacao.softwareexpress.com.br
#
Store list using signatureRequest:
To use this example, don't forget to define the variable {{url}}
to the value
esitef-homologacao.softwareexpress.com.br
Response:
#
Request parametersParâmetro | Descrição | Formato | Obrigatório |
---|---|---|---|
cnpj | CNPJ of the merchant. Numbers only. | = 14 N | Não |
merchant_status | Store status. Can assume the following values: A = Active I = Inactive | = 1 N | Não |
page | List Page. The first page value is 0 . If not set, defaults to 0 . | < 4 N | Não |
limit | Max records by page. If not set, defaults to 100. | < 3 N | Não |
#
Response parametersIf successful, the HTTP response code will be 200
. Any other code must be interpreted as an error.
Parameter | Description | Format |
---|---|---|
response_code | Carat Portal response code. Any code different from 0 means failure. | < 4 N |
response_message | Carat Portal response message. | < 500 AN |
current_page | Current records page. | < 4 N |
total_pages | Total pages number. | < 4 N |
count | Total register count. | < 4 N |
merchants[] | Store list returned by the query. | |
id | Code of the created merchant. | < 15 AN |
merchant_status | Store status. Can assume the following values: A = Active I = Inactive | = 1 N |
fantasy_name | Fantasy name of the merchant. | < 250 AN |
corporate_name | Corporate name of the merchant. | < 250 AN |
cnpj | CNPJ of the merchant. Numbers only. | = 14 N |