API - 概要

API - 注文

顧客の注文を取得し、ステータスや数量を更新したり、注文を削除したりできます。

エンドポイント一覧

メソッドエンドポイント説明アクセス
GET/public-api/v1/customer-ordersページ分割と絞り込みに対応した顧客注文の一覧を返します。orders:read
GET/public-api/v1/customer-orders/:id設定済みの商品項目を含む単一の顧客注文を返します。orders:read
POST/public-api/v1/customer-orders/batchID を指定して最大 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" }
  }
}