Autenticação

As rotas de Orders e Products utilizam autenticação por API Key do tipo orders.

Headers Obrigatórios

Todas as requisições devem incluir os seguintes headers:

X-API-Key

string

required

Sua API key do tipo orders

X-Store-Id

string

required

ID da sua loja

Content-Type

string

required

Deve ser application/json

curl -X POST https://api.appmartan.com.br/orders \
  -H "X-API-Key: sua-api-key-aqui" \
  -H "X-Store-Id: 123" \
  -H "Content-Type: application/json" \
  -d '{
    "order_id": "ORD-12345",
    "order_date": "2024-01-01T00:00:00.000Z",
    "delivery_date": "2024-01-05T00:00:00.000Z",
    "products": [...],
    "customers": [...]
  }'

Erros de Autenticação

status

number

Código HTTP do erro

error_code

number

Código de erro específico da API

message

string

Mensagem de erro em inglês

user_message

object

Mensagens de erro traduzidas

Show Ver estrutura

en_us

string

Mensagem em inglês

pt_br

string

Mensagem em português

Códigos de Erro

Status	Código	Descrição
401	8121200	API key ausente no header X-API-Key
417	8121201	Store ID ausente no header X-Store-Id
401	8121202	API key inválida ou inativa
401	8121203	Store inativa
401	8121204	API key expirada
403	8121205	Store ID não corresponde à API key
403	8121206	Limite de uso de pedidos excedido para o plano

Exemplo de Resposta de Erro

{
  "status": 401,
  "error_code": 8121202,
  "message": "Invalid or inactive API key",
  "user_message": {
    "en_us": "Invalid or inactive API key",
    "pt_br": "API key inválida ou inativa"
  },
  "more_info": null
}

​Headers Obrigatórios

​Erros de Autenticação

​Códigos de Erro

​Exemplo de Resposta de Erro

Headers Obrigatórios

Erros de Autenticação

Códigos de Erro

Exemplo de Resposta de Erro