API atual/Referência completa/Expedição e retirada

Estatísticas e taxas

Resume as expedições do seller por etapa e lista as taxas de expedição cobradas pela plataforma.

Estatísticas

Conta quantas expedições do seller estão em cada etapa e calcula dois tempos médios. Serve para um painel de operação.

GET/api/v1/vendor/fulfillments/statsSeller

Estatísticas das expedições do seller

Exemplo de requisição: estatísticas

bash

curl "$BASE_URL/api/v1/vendor/fulfillments/stats" \
  -H "Authorization: Bearer $TOKEN"

Resposta: estatísticas

200Estatísticas

json

{
  "total_pending": 77,
  "total_picking": 0,
  "total_packed": 0,
  "total_shipped": 2,
  "total_delivered": 0,
  "total_returned": 0,
  "avg_ship_time_days": 4.9,
  "avg_deliver_days": 0
}

Campos da resposta

total_pendinginteger

Expedições em pending.

total_pickinginteger

Em picking.

total_packedinteger

Em packed.

total_shippedinteger

Em shipped.

total_deliveredinteger

Em delivered.

total_returnedinteger

Em returned.

avg_ship_time_daysnumber

Média, em dias (2 casas), entre a criação e o envio das expedições já enviadas. 0 se nenhuma.

avg_deliver_daysnumber

Média, em dias, entre o envio e a entrega. 0 se nenhuma foi entregue.

Erros: estatísticas

Status	Quando	Corpo de exemplo
401	Sem cabeçalho `Authorization`, ou token inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O token não é de um usuário seller (por exemplo, é um token de administrador).	`{"error":"insufficient permissions"}`
404	O usuário não tem perfil de seller.	`{"error":"vendor profile not found"}`
403	O módulo `fulfillment` está desligado na loja.	`{"error":"module_disabled","module":"fulfillment"}`
500	Falha ao consultar.	`{"error":"failed to get vendor fulfillment stats"}`

Quando a loja despacha o pedido do seller (expedição pela plataforma), ela pode cobrar uma taxa, normalmente um percentual do subtotal, que é descontada do repasse. Esta rota lista essas taxas, da mais nova para a mais antiga.

GET/api/v1/vendor/fulfillments/feesSeller

Taxas de expedição cobradas do seller

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1.

per_pageintegerpadrão: 20

Itens por página, de 1 a 100. Fora disso volta para 20.

Exemplo de requisição: taxas

bash

curl "$BASE_URL/api/v1/vendor/fulfillments/fees?per_page=20" \
  -H "Authorization: Bearer $TOKEN"

Resposta: taxas

200Taxas

json

{
  "fees": [
    {
      "id": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4a5b",
      "fulfillment_id": "e1a2b3c4-d5e6-4f70-8a9b-0c1d2e3f4a5b",
      "vendor_id": "5f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
      "order_id": "b4d2f0a8-6c1e-4b3d-9a7f-2e5c8d1b0a96",
      "amount": 450,
      "fee_type": "shipping",
      "description": "Taxa de expedição",
      "rate_bps": 250,
      "base_amount": 18000,
      "is_deducted": false,
      "created_at": "2026-10-03T13:05:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 20
}

Campos da resposta

feesarray | null

Taxas da página. É null (não []) quando o seller não tem nenhuma.

iduuid

Id da taxa.

fulfillment_iduuid

Expedição que gerou a taxa.

vendor_iduuid

Seller cobrado.

order_iduuid

Pedido da taxa.

amountinteger

Valor da taxa, em centavos.

fee_typestring

Categoria da taxa (shipping por padrão).

descriptionstring

Texto livre. Ausente quando vazio.

rate_bpsinteger

Taxa aplicada, em pontos-base (250 = 2,5%).

base_amountinteger

Subtotal do pedido sobre o qual a taxa foi calculada, em centavos.

is_deductedboolean

Se a taxa já foi descontada de um repasse.

payout_iduuid

Repasse em que foi descontada. Ausente enquanto pendente.

created_atstring

Criação, RFC 3339.

totalinteger

Total de taxas do seller.

pageinteger

Página devolvida.

per_pageinteger

Tamanho da página usado.

Erros: taxas

Status	Quando	Corpo de exemplo
401	Sem cabeçalho `Authorization`, ou token inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O token não é de um usuário seller (por exemplo, é um token de administrador).	`{"error":"insufficient permissions"}`
404	O usuário não tem perfil de seller.	`{"error":"vendor profile not found"}`
403	O módulo `fulfillment` está desligado na loja.	`{"error":"module_disabled","module":"fulfillment"}`
500	Falha ao consultar.	`{"error":"failed to list fees"}`

Veja também

API atual/Referência completa/Expedição e retirada

Estatísticas e taxas

Resume as expedições do seller por etapa e lista as taxas de expedição cobradas pela plataforma.

Estatísticas

Conta quantas expedições do seller estão em cada etapa e calcula dois tempos médios. Serve para um painel de operação.

GET/api/v1/vendor/fulfillments/statsSeller

Estatísticas das expedições do seller

Exemplo de requisição: estatísticas

bash

curl "$BASE_URL/api/v1/vendor/fulfillments/stats" \
  -H "Authorization: Bearer $TOKEN"

Resposta: estatísticas

200Estatísticas

json

{
  "total_pending": 77,
  "total_picking": 0,
  "total_packed": 0,
  "total_shipped": 2,
  "total_delivered": 0,
  "total_returned": 0,
  "avg_ship_time_days": 4.9,
  "avg_deliver_days": 0
}

Campos da resposta

total_pendinginteger

Expedições em pending.

total_pickinginteger

Em picking.

total_packedinteger

Em packed.

total_shippedinteger

Em shipped.

total_deliveredinteger

Em delivered.

total_returnedinteger

Em returned.

avg_ship_time_daysnumber

Média, em dias (2 casas), entre a criação e o envio das expedições já enviadas. 0 se nenhuma.

avg_deliver_daysnumber

Média, em dias, entre o envio e a entrega. 0 se nenhuma foi entregue.

Erros: estatísticas

Status	Quando	Corpo de exemplo
401	Sem cabeçalho `Authorization`, ou token inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O token não é de um usuário seller (por exemplo, é um token de administrador).	`{"error":"insufficient permissions"}`
404	O usuário não tem perfil de seller.	`{"error":"vendor profile not found"}`
403	O módulo `fulfillment` está desligado na loja.	`{"error":"module_disabled","module":"fulfillment"}`
500	Falha ao consultar.	`{"error":"failed to get vendor fulfillment stats"}`

Taxas

GET/api/v1/vendor/fulfillments/feesSeller

Taxas de expedição cobradas do seller

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1.

per_pageintegerpadrão: 20

Itens por página, de 1 a 100. Fora disso volta para 20.

Exemplo de requisição: taxas

bash

curl "$BASE_URL/api/v1/vendor/fulfillments/fees?per_page=20" \
  -H "Authorization: Bearer $TOKEN"

Resposta: taxas

200Taxas

json

{
  "fees": [
    {
      "id": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4a5b",
      "fulfillment_id": "e1a2b3c4-d5e6-4f70-8a9b-0c1d2e3f4a5b",
      "vendor_id": "5f1c2d3e-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
      "order_id": "b4d2f0a8-6c1e-4b3d-9a7f-2e5c8d1b0a96",
      "amount": 450,
      "fee_type": "shipping",
      "description": "Taxa de expedição",
      "rate_bps": 250,
      "base_amount": 18000,
      "is_deducted": false,
      "created_at": "2026-10-03T13:05:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 20
}

Campos da resposta

feesarray | null

Taxas da página. É null (não []) quando o seller não tem nenhuma.

iduuid

Id da taxa.

fulfillment_iduuid

Expedição que gerou a taxa.

vendor_iduuid

Seller cobrado.

order_iduuid

Pedido da taxa.

amountinteger

Valor da taxa, em centavos.

fee_typestring

Categoria da taxa (shipping por padrão).

descriptionstring

Texto livre. Ausente quando vazio.

rate_bpsinteger

Taxa aplicada, em pontos-base (250 = 2,5%).

base_amountinteger

Subtotal do pedido sobre o qual a taxa foi calculada, em centavos.

is_deductedboolean

Se a taxa já foi descontada de um repasse.

payout_iduuid

Repasse em que foi descontada. Ausente enquanto pendente.

created_atstring

Criação, RFC 3339.

totalinteger

Total de taxas do seller.

pageinteger

Página devolvida.

per_pageinteger

Tamanho da página usado.

Erros: taxas

Status	Quando	Corpo de exemplo
401	Sem cabeçalho `Authorization`, ou token inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O token não é de um usuário seller (por exemplo, é um token de administrador).	`{"error":"insufficient permissions"}`
404	O usuário não tem perfil de seller.	`{"error":"vendor profile not found"}`
403	O módulo `fulfillment` está desligado na loja.	`{"error":"module_disabled","module":"fulfillment"}`
500	Falha ao consultar.	`{"error":"failed to list fees"}`