API atual/Referência completa/Frete e entrega

Pontos de retirada

Lista os pontos de retirada em loja e a disponibilidade dos itens do carrinho em cada um.

Retirada em loja (BOPIS: buy online, pick up in store) deixa o cliente comprar na internet e buscar o pedido num depósito ou loja física, sem frete. Cada ponto é um depósito da loja habilitado para retirada. Um ponto fica available: true só se todos os itens pedidos têm estoque ali.

GET/api/v1/storefront/pickup-pointsPública

Lista os pontos de retirada

Lista os pontos onde o cliente pode retirar o pedido, com a disponibilidade dos itens em cada um. Não exige token.

Parâmetros de consulta

itemsstring

Itens do carrinho no formato produto:quantidade, separados por vírgula: UUID1:2,UUID2:1. Quantidade ausente ou inválida vale 1; o mesmo produto repetido soma. Sem o parâmetro, todos os pontos vêm como disponíveis.

postal_codestring

Aceito, mas ignorado hoje: os pontos não são ordenados por distância ao CEP.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/pickup-points?items=22fbd12a-1b6e-41ea-a84f-4d9cf06c8766:2"

Resposta

200Pontos de retirada

json

{
  "points": [
    {
      "warehouse_id": "d7a4cba9-5ae2-4d0c-a613-6a7943ac82c8",
      "name": "Depósito Principal",
      "address": "Rua das Flores, 100",
      "city": "Curitiba",
      "state": "PR",
      "zipcode": "80010-000",
      "distance_rank": 1,
      "available": true,
      "ready_estimate_date": "2026-10-11",
      "has_slots": false,
      "pickup_expires_days": 7
    }
  ]
}

Campos da resposta

pointsobject[]

Pontos de retirada. [] quando a loja não habilitou nenhum.

points[].warehouse_iduuid

Id do depósito. É o ponto escolhido ao fechar o pedido.

points[].namestring

Nome para exibir.

points[].addressstring

Endereço. Pode vir vazio.

points[].citystring

Cidade.

points[].statestring

UF.

points[].zipcodestring

CEP do ponto. Pode vir vazio.

points[].vendor_iduuid

Seller dono do ponto. Ausente quando o ponto é da loja.

points[].distance_rankinteger

Posição na lista (1 é o primeiro). Não é distância.

points[].availableboolean

Todos os itens pedidos têm estoque neste ponto.

points[].ready_estimate_datestring

YYYY-MM-DD: quando o pedido fica pronto. Hoje é sempre a data de hoje.

points[].opening_hoursobject

Horário de funcionamento, como cadastrado. Ausente quando não há.

points[].has_slotsboolean

O ponto oferece horários de retirada agendada.

points[].pickup_expires_daysinteger

Dias que o pedido espera pela retirada antes de expirar.

Erros

Status	Quando	Corpo
500	Falha ao listar os pontos.	`{"error":"failed to list pickup points","detail":"..."}`

Veja também