API — Envio

Documentacao tecnica gerada automaticamente a partir da especificacao OpenAPI.

---

GET /api/shipping/zones

List Zones

Exemplo resposta (200):

[{
  "id": 0,
  "tenant_id": 0,
  "name": "string",
  "countries": [
    "..."
  ],
  "postcodes": null,
  "is_active": true,
  "display_order": 0,
  "methods": [
    "..."
  ]
}]

---

POST /api/shipping/zones

Create Zone

Corpo do pedido:

Campo	Tipo	Obrigatorio	Descricao
name	string	Sim	Name
countries	array	Nao	Countries
postcodes	object	Nao	Postcodes
is_active	boolean	Nao	Is Active
display_order	integer	Nao	Display Order

Exemplo pedido:

{
  "name": "string",
  "countries": [
    "..."
  ],
  "postcodes": null,
  "is_active": true,
  "display_order": 0
}

Exemplo resposta (201):

{
  "id": 0,
  "tenant_id": 0,
  "name": "string",
  "countries": [
    "..."
  ],
  "postcodes": null,
  "is_active": true,
  "display_order": 0,
  "methods": [
    "..."
  ]
}

Erros possiveis: 422 Validation Error

---

PUT /api/shipping/zones/{zone_id}

Update Zone

Parametros:

Nome	Tipo	Obrigatorio	Descricao
zone_id	integer	Sim	—

Corpo do pedido:

Campo	Tipo	Obrigatorio	Descricao
name	object	Nao	Name
countries	object	Nao	Countries
postcodes	object	Nao	Postcodes
is_active	object	Nao	Is Active
display_order	object	Nao	Display Order

Exemplo pedido:

{
  "name": null,
  "countries": null,
  "postcodes": null,
  "is_active": null,
  "display_order": null
}

Exemplo resposta (200):

{
  "id": 0,
  "tenant_id": 0,
  "name": "string",
  "countries": [
    "..."
  ],
  "postcodes": null,
  "is_active": true,
  "display_order": 0,
  "methods": [
    "..."
  ]
}

Erros possiveis: 422 Validation Error

---

DELETE /api/shipping/zones/{zone_id}

Delete Zone

Parametros:

Nome	Tipo	Obrigatorio	Descricao
zone_id	integer	Sim	—

Resposta (204): Successful Response

Erros possiveis: 422 Validation Error

---

POST /api/shipping/zones/{zone_id}/methods

Add Method

Parametros:

Nome	Tipo	Obrigatorio	Descricao
zone_id	integer	Sim	—

Corpo do pedido:

Campo	Tipo	Obrigatorio	Descricao
name	string	Sim	Name
type	string	Sim	Type
cost	object	Nao	Cost
free_above	object	Nao	Free Above
weight_rates	object	Nao	Weight Rates
estimated_days_min	object	Nao	Estimated Days Min
estimated_days_max	object	Nao	Estimated Days Max
is_active	boolean	Nao	Is Active

Exemplo pedido:

{
  "name": "string",
  "type": "string",
  "cost": null,
  "free_above": null,
  "weight_rates": null,
  "estimated_days_min": null,
  "estimated_days_max": null,
  "is_active": true
}

Exemplo resposta (201):

{
  "id": 0,
  "zone_id": 0,
  "name": "string",
  "type": "string",
  "cost": "string",
  "free_above": null,
  "weight_rates": null,
  "estimated_days_min": null,
  "estimated_days_max": null,
  "is_active": true
}

Erros possiveis: 422 Validation Error

---

PUT /api/shipping/methods/{method_id}

Update Method

Parametros:

Nome	Tipo	Obrigatorio	Descricao
method_id	integer	Sim	—

Corpo do pedido:

Campo	Tipo	Obrigatorio	Descricao
name	object	Nao	Name
type	object	Nao	Type
cost	object	Nao	Cost
free_above	object	Nao	Free Above
weight_rates	object	Nao	Weight Rates
estimated_days_min	object	Nao	Estimated Days Min
estimated_days_max	object	Nao	Estimated Days Max
is_active	object	Nao	Is Active

Exemplo pedido:

{
  "name": null,
  "type": null,
  "cost": null,
  "free_above": null,
  "weight_rates": null,
  "estimated_days_min": null,
  "estimated_days_max": null,
  "is_active": null
}

Exemplo resposta (200):

{
  "id": 0,
  "zone_id": 0,
  "name": "string",
  "type": "string",
  "cost": "string",
  "free_above": null,
  "weight_rates": null,
  "estimated_days_min": null,
  "estimated_days_max": null,
  "is_active": true
}

Erros possiveis: 422 Validation Error

---

DELETE /api/shipping/methods/{method_id}

Delete Method

Parametros:

Nome	Tipo	Obrigatorio	Descricao
method_id	integer	Sim	—

Resposta (204): Successful Response

Erros possiveis: 422 Validation Error

---

GET /api/shipping/calculate

Calculate Shipping Get

Parametros:

Nome	Tipo	Obrigatorio	Descricao
postal_code	string	Sim	Codigo postal (ex: 1000-001)
country	string	Nao	Codigo ISO do pais (ex: PT, ES, FR)
weight	string	Nao	Peso total em kg
total	string	Nao	Subtotal do carrinho em EUR

Exemplo resposta (200):

{
  "zone": "string",
  "zone_label": "string",
  "postcode_valid": true,
  "methods": [
    "..."
  ],
  "options": [
    "..."
  ]
}

Erros possiveis: 422 Validation Error

---

POST /api/shipping/calculate

Calculate Shipping Post

Corpo do pedido:

Campo	Tipo	Obrigatorio	Descricao
country	string	Sim	Country
postcode	object	Nao	Postcode
weight	object	Nao	Weight
subtotal	object	Nao	Subtotal

Exemplo pedido:

{
  "country": "string",
  "postcode": null,
  "weight": null,
  "subtotal": null
}

Exemplo resposta (200):

{
  "zone": "string",
  "zone_label": "string",
  "postcode_valid": true,
  "methods": [
    "..."
  ],
  "options": [
    "..."
  ]
}

Erros possiveis: 422 Validation Error

---

Documentacao gerada automaticamente.