API - 订单

获取客户订单、更新状态和数量，以及删除订单。

端点概览

方法	端点	说明	访问权限
`GET`	`/public-api/v1/customer-orders`	返回可分页和筛选的客户订单列表。	`orders:read`
`GET`	`/public-api/v1/customer-orders/:id`	返回包含已配置产品条目的单个客户订单。	`orders:read`
`POST`	`/public-api/v1/customer-orders/batch`	按 ID 返回最多 100 个订单。	`orders:read`
`PATCH`	`/public-api/v1/customer-orders/:id/status`	更新订单状态。	`orders:write`
`PATCH`	`/public-api/v1/customer-orders/:orderId/quantity`	更新所选订单明细的数量。	`orders:write`
`PATCH`	`/public-api/v1/customer-orders/:orderId/quantity/all`	为订单中的每个条目设置相同数量。	`orders:write`
`DELETE`	`/public-api/v1/customer-orders/:id`	删除属于店铺所有者的客户订单。	`orders:write`

客户订单

客户订单端点允许外部店铺读取已配置的行条目、更新数量、推进订单履约状态，以及移除废弃订单。

参数	必填	详情
`name`	`否`	搜索设计名称和数字订单 ID。
`category_id`	`否`	按产品类别 ID 筛选。
`order_status`	`否`	允许的订单状态之一。
`offset`	`否`	默认为 0，必须 >= 0。
`limit`	`否`	此控制器默认为 9，最大为 50。
`order_by`	`否`	id、created_at 或 design_name。
`direction`	`否`	ASC 或 DESC。

请求示例（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]
  })
});

允许的值

状态	说明
`shopping_cart`	购物车流程；客户仍可编辑配置。
`editable`	客户仍可编辑订单。
`paid`	订单已付款，可以开始履约。
`processing`	订单正在履约。
`completed`	订单已履约。
`cancelled`	订单已取消。

请求示例（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'
});

响应示例

{
  "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" }
  }
}