API - Visão geral

API - Encomendas

Obtenha as encomendas dos clientes, atualize os estados e as quantidades e elimine encomendas.

Visão geral dos endpoints

MétodoEndpointDescriçãoAcesso
GET/public-api/v1/customer-ordersRetorna uma lista paginada e filtrável de pedidos de clientes.orders:read
GET/public-api/v1/customer-orders/:idRetorna um pedido de cliente individual com os itens de produto configurados.orders:read
POST/public-api/v1/customer-orders/batchRetorna até 100 pedidos por ID.orders:read
PATCH/public-api/v1/customer-orders/:id/statusAtualiza o estado do pedido.orders:write
PATCH/public-api/v1/customer-orders/:orderId/quantityAtualiza as quantidades dos itens selecionados do pedido.orders:write
PATCH/public-api/v1/customer-orders/:orderId/quantity/allDefine uma única quantidade para todos os itens de um pedido.orders:write
DELETE/public-api/v1/customer-orders/:idElimina um pedido de cliente pertencente ao proprietário da loja.orders:write

Pedidos de clientes

Os endpoints de pedidos de clientes permitem que uma loja externa leia os itens configurados, atualize quantidades, mova um pedido entre estados de processamento e remova pedidos abandonados.

ParâmetroObrigatórioDetalhes
namenãoPesquisa pelo nome do design e pelo ID numérico do pedido.
category_idnãoFiltra pelo ID da categoria do produto.
order_statusnãoUm dos estados de pedido permitidos.
offsetnãoValor predefinido: 0. Deve ser >= 0.
limitnãoValor predefinido: 9 neste controlador, máximo 50.
order_bynãoid, created_at ou design_name.
directionnãoASC ou DESC.

Exemplo de solicitação (fetch)

const params = new URLSearchParams({
  limit: '20',
  offset: '0',
  order_status: 'shopping_cart',
  order_by: 'created_at',
  direction: 'DESC'
});

const orders = await alterFetch(`/customer-orders?${params.toString()}`);

const order = await alterFetch('/customer-orders/123');

const batch = await alterFetch('/customer-orders/batch', {
  method: 'POST',
  body: JSON.stringify({
    customerOrderIds: [123, 124, 125]
  })
});

Valores permitidos

EstadoDescrição
shopping_cartFluxo do carrinho; o cliente ainda pode editar a configuração.
editableO pedido continua editável pelo cliente.
paidO pedido está pago e pronto para processamento.
processingO pedido está em processamento.
completedO pedido foi concluído.
cancelledO pedido foi cancelado.

Exemplo de solicitação (fetch)

await alterFetch('/customer-orders/123/status', {
  method: 'PATCH',
  body: JSON.stringify({
    status: 'processing'
  })
});

await alterFetch('/customer-orders/123/quantity', {
  method: 'PATCH',
  body: JSON.stringify({
    items: [
      { orderDetailId: 987, quantity: 3 }
    ]
  })
});

await alterFetch('/customer-orders/123/quantity/all', {
  method: 'PATCH',
  body: JSON.stringify({
    quantity: 2
  })
});

await alterFetch('/customer-orders/123', {
  method: 'DELETE'
});

Exemplo de resposta

{
  "order": {
    "id": 123,
    "customizerId": 381,
    "orderStatus": "shopping_cart",
    "createdAt": "2026-05-28T10:15:00.000Z",
    "customizerOrderURL": "https://alterproduct.com/app/customizer/381/123",
    "productItems": [
      {
        "id": 987,
        "model3d": { "id": 381 },
        "size": {
          "id": 395,
          "name": { "pl": "M", "en": "M" },
          "measureSize": null
        },
        "material": {
          "id": 2,
          "name": { "pl": "Bawełna", "en": "Cotton" }
        },
        "printType": {
          "id": 1,
          "name": { "pl": "DTG", "en": "DTG" }
        },
        "color": {
          "id": 418,
          "name": { "pl": "Domyślny", "en": "Default" },
          "hex": "#ffffff"
        },
        "variant": {
          "id": 531,
          "metadata": null,
          "stockQuantity": 25
        },
        "unitPrice": { "value": 12.5, "currency": "EUR" },
        "totalPrice": { "value": 37.5, "currency": "EUR" },
        "quantity": 3
      }
    ],
    "customizerName": "Men's T-Shirt",
    "productGroup": {
      "id": 4,
      "name": { "pl": "Koszulka", "en": "T-Shirt" }
    },
    "totalPrice": { "value": 37.5, "currency": "EUR" }
  }
}