Skip to main content
POST
Criar API de Frete

Authorizations

User-Token
string
header
required
User-Secret-Key
string
header
required

Path Parameters

alias
string
required

Alias da loja

Body

application/json

Dados da API de Frete

Representa os dados necessários para criar ou atualizar uma integração com API de frete

name
string
required

Nome da integração, único na loja.

Example:

"Sua API de Fretes"

url
string<uri>
required

URL da sua API de frete consultada nas cotações, única na loja.

Example:

"https://api.sua-api-de-fretes.com.br"

active
boolean
default:true
required

Indica se a integração está ativa e é consultada nas cotações de frete.

headers
object[]

Headers HTTP enviados nas requisições à sua API de frete, no máximo 5.

Response

201 - application/json

API de Frete criada com sucesso

Representa uma integração com API de frete

id
integer

ID da integração com API de frete.

active
boolean

Indica se a integração está ativa e é consultada nas cotações de frete.

healthy
boolean

Status de saúde da integração

name
string

Nome da integração, único na loja.

Example:

"Sua API de Fretes"

url
string<uri>

URL da sua API de frete consultada nas cotações, única na loja.

Example:

"https://api.sua-api-de-fretes.com.br"

created_at
object

Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.

updated_at
object

Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.

headers
Header da API de Frete · object[]

Headers HTTP enviados nas requisições à sua API de frete, no máximo 5.