v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB

Logística - API de Frete

Criar API de Frete

Cria uma nova integração com API de Frete

post/{alias}/logistics/apis

Path parameters

aliasstring required

Alias da loja

Request body

namestring required

urlstring uri required

activeboolean required

Example request

{
  "name": "Sua API de Fretes",
  "url": "https://api.sua-api-de-fretes.com.br",
  "headers": [
    {
      "key": "Authorization",
      "value": "Bearer TOKEN"
    }
  ]
}

Response

API de Frete criada com sucesso

idinteger

activeboolean

healthyboolean

Status de saúde da integração

namestring

urlstring uri

hmac_keystring password

Example response

{
  "name": "Sua API de Fretes",
  "url": "https://api.sua-api-de-fretes.com.br",
  "created_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "updated_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "headers": [
    {
      "key": "Authorization",
      "value": "Bearer TOKEN123"
    }
  ]
}