API legada/Referência completa/Métodos de frete

Endpoints de métodos de envio

As URLs da API de métodos de envio: a coleção (listar e criar) e um método de envio individual (consultar, atualizar e excluir), com os códigos de resposta.

A API de métodos de envio oferece endpoints para gerenciar as opções de frete disponíveis no seu sistema. Com eles você cria, recupera, atualiza e exclui métodos de envio para os seus produtos e serviços. Todos usam credenciais HTTP Basic ($EMAIL:$API_KEY) e o endereço base da loja ($BASE_URL/api).

A coleção de métodos de envio

O caminho /api/shippings acessa todos os métodos de envio ou cria um novo.

Método	Descrição
GET	Recuperar todos os métodos de envio
POST	Criar um novo método de envio

Listar métodos de envio

GET/api/shippingsAdmin

Recupera todos os métodos de envio

Parâmetros de consulta

pageintegerpadrão: 1

Página da lista, veja Paginação.

items_per_pageintegerpadrão: 10

Quantidade de métodos de envio por página.

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/shippings"

200Exemplo de resposta do GET

json

{
  "data": [
    {
      "id": "ship_001",
      "name": "Standard Delivery",
      "description": "3-5 business days shipping",
      "price": 15.90,
      "delivery_time": "3-5 days",
      "active": true,
      "created_at": "2025-01-15T10:30:00Z"
    },
    {
      "id": "ship_002",
      "name": "Express Delivery",
      "description": "Next day shipping for orders placed before 2pm",
      "price": 29.90,
      "delivery_time": "1 day",
      "active": true,
      "created_at": "2025-01-15T10:35:00Z"
    }
  ],
  "meta": {
    "total": 5,
    "page": 1,
    "per_page": 10
  }
}

Criar um método de envio

POST/api/shippingsAdmin

Cria um novo método de envio

Corpo da requisição

namestring

Nome do método de envio.

descriptionstring

Descrição do método de envio.

pricenumber

Preço do método de envio.

delivery_timestring

Prazo de entrega, por exemplo Same day.

activeboolean

Indica se o método de envio está ativo.

restrictionsobject

Restrições do método. O exemplo envia max_distance, max_weight e regions.

bash

curl -X POST -u "$EMAIL:$API_KEY" "$BASE_URL/api/shippings" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Premium Delivery",
  "description": "Same day delivery for local orders",
  "price": 39.90,
  "delivery_time": "Same day",
  "active": true,
  "restrictions": {
    "max_distance": 50,
    "max_weight": 20,
    "regions": ["São Paulo - Capital"]
  }
}'

Um método de envio

O caminho /api/shippings/{id} acessa, atualiza ou exclui um método de envio pelo ID.

Parâmetros de caminho

idstringobrigatório

O identificador único do método de envio.

Método	Descrição
GET	Recuperar um método de envio
PUT	Atualizar um método de envio
DELETE	Excluir um método de envio

Consultar um método de envio

GET/api/shippings/{id}Admin

Recupera um método de envio

Parâmetros de caminho

idstringobrigatório

O identificador único do método de envio.

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/shippings/ship_001"

Atualizar um método de envio

PUT/api/shippings/{id}Admin

Atualiza um método de envio

Parâmetros de caminho

idstringobrigatório

O identificador único do método de envio.

bash

curl -X PUT -u "$EMAIL:$API_KEY" "$BASE_URL/api/shippings/ship_001" \
  -H "Content-Type: application/json" \
  -d '{
  "price": 35.90,
  "description": "Updated: Same day delivery for local orders",
  "active": true
}'

Excluir um método de envio

DELETE/api/shippings/{id}Admin

Exclui um método de envio

Parâmetros de caminho

idstringobrigatório

O identificador único do método de envio.

bash

curl -X DELETE -u "$EMAIL:$API_KEY" "$BASE_URL/api/shippings/ship_001"

Códigos de status da resposta

Código de status	Descrição
`200 OK`	Operação concluída com sucesso
`400 Bad Request`	Parâmetros da requisição inválidos
`404 Not Found`	O método de envio com o ID informado não existe
`409 Conflict`	Não é possível excluir um método de envio que está em uso por pedidos

Veja também

Métodos de envio

As rotas dos métodos de envio, com tarifas e filtros.

Campos

Todas as propriedades de um método de envio.

API legada/Referência completa/Métodos de frete

Endpoints de métodos de envio

As URLs da API de métodos de envio: a coleção (listar e criar) e um método de envio individual (consultar, atualizar e excluir), com os códigos de resposta.

A coleção de métodos de envio

O caminho /api/shippings acessa todos os métodos de envio ou cria um novo.

Método	Descrição
GET	Recuperar todos os métodos de envio
POST	Criar um novo método de envio

Listar métodos de envio

GET/api/shippingsAdmin

Recupera todos os métodos de envio

Parâmetros de consulta

pageintegerpadrão: 1

Página da lista, veja Paginação.

items_per_pageintegerpadrão: 10

Quantidade de métodos de envio por página.

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/shippings"

200Exemplo de resposta do GET

json

{
  "data": [
    {
      "id": "ship_001",
      "name": "Standard Delivery",
      "description": "3-5 business days shipping",
      "price": 15.90,
      "delivery_time": "3-5 days",
      "active": true,
      "created_at": "2025-01-15T10:30:00Z"
    },
    {
      "id": "ship_002",
      "name": "Express Delivery",
      "description": "Next day shipping for orders placed before 2pm",
      "price": 29.90,
      "delivery_time": "1 day",
      "active": true,
      "created_at": "2025-01-15T10:35:00Z"
    }
  ],
  "meta": {
    "total": 5,
    "page": 1,
    "per_page": 10
  }
}

Criar um método de envio

POST/api/shippingsAdmin

Cria um novo método de envio

Corpo da requisição

namestring

Nome do método de envio.

descriptionstring

Descrição do método de envio.

pricenumber

Preço do método de envio.

delivery_timestring

Prazo de entrega, por exemplo Same day.

activeboolean

Indica se o método de envio está ativo.

restrictionsobject

Restrições do método. O exemplo envia max_distance, max_weight e regions.

bash

curl -X POST -u "$EMAIL:$API_KEY" "$BASE_URL/api/shippings" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Premium Delivery",
  "description": "Same day delivery for local orders",
  "price": 39.90,
  "delivery_time": "Same day",
  "active": true,
  "restrictions": {
    "max_distance": 50,
    "max_weight": 20,
    "regions": ["São Paulo - Capital"]
  }
}'

Um método de envio

O caminho /api/shippings/{id} acessa, atualiza ou exclui um método de envio pelo ID.

Parâmetros de caminho

idstringobrigatório

O identificador único do método de envio.

Método	Descrição
GET	Recuperar um método de envio
PUT	Atualizar um método de envio
DELETE	Excluir um método de envio

Consultar um método de envio

GET/api/shippings/{id}Admin

Recupera um método de envio

Parâmetros de caminho

idstringobrigatório

O identificador único do método de envio.

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/shippings/ship_001"

Atualizar um método de envio

PUT/api/shippings/{id}Admin

Atualiza um método de envio

Parâmetros de caminho

idstringobrigatório

O identificador único do método de envio.

bash

curl -X PUT -u "$EMAIL:$API_KEY" "$BASE_URL/api/shippings/ship_001" \
  -H "Content-Type: application/json" \
  -d '{
  "price": 35.90,
  "description": "Updated: Same day delivery for local orders",
  "active": true
}'

Excluir um método de envio

DELETE/api/shippings/{id}Admin

Exclui um método de envio

Parâmetros de caminho

idstringobrigatório

O identificador único do método de envio.

bash

curl -X DELETE -u "$EMAIL:$API_KEY" "$BASE_URL/api/shippings/ship_001"

Códigos de status da resposta

Código de status	Descrição
`200 OK`	Operação concluída com sucesso
`400 Bad Request`	Parâmetros da requisição inválidos
`404 Not Found`	O método de envio com o ID informado não existe
`409 Conflict`	Não é possível excluir um método de envio que está em uso por pedidos

Veja também

Métodos de envio

As rotas dos métodos de envio, com tarifas e filtros.

Campos

Todas as propriedades de um método de envio.