コンテンツにスキップ
ShopentlyLearn
日本語

取得 — 注文

「注文」のデータを取得します。結果はこの操作のパラメーターによって決まります。

GET/api/v1/orders/{order_id}

認証
Bearer
利用可能な最低プラン
BASIC
必要な権限
orders.order:read

コード例

リクエスト例

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request GET \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/orders/example

PHP

<?php
declare(strict_types=1);

$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
    isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
    isset($origin['query']) || isset($origin['fragment'])) {
    throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
    throw new RuntimeException('Invalid credential');
}
$headers = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/orders/example');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
    CURLOPT_SSL_VERIFYPEER => true,
    CURLOPT_SSL_VERIFYHOST => 2,
    CURLOPT_CONNECTTIMEOUT => 5,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
        if (str_contains($line, ':')) {
            [$name, $value] = explode(':', $line, 2);
            $responseHeaders[strtolower(trim($name))] = trim($value);
        }
        return strlen($line);
    },
]);
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
    throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
    throw new RuntimeException('HTTP ' . $status . '; request_id=' .
        ($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;

Python

from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit

import requests  # python -m pip install requests

base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
    raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
    raise ValueError("Invalid credential")
headers = {}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
if body is not None:
    headers["Content-Type"] = "application/json"

with ExitStack() as stack:
    session = stack.enter_context(requests.Session())
    files = None
    if False:
        image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
        if os.fstat(image.fileno()).st_size > 5242880:
            raise ValueError("Image exceeds 5 MiB")
        files = {"file": ("article.png", image, "image/png")}
    response = session.request(
        'GET', base_url + '/api/v1/orders/example', headers=headers,
        data=body.encode("utf-8") if body is not None else None, files=files,
        timeout=(5, 30), allow_redirects=False,
    )
    if not 200 <= response.status_code < 300:
        raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
    if False:
        if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
            raise ValueError("Unexpected image response")
        with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
            output.write(response.content)
    else:
        result = response.json() if response.content else None
        print(json.dumps(result, ensure_ascii=False, indent=2))

レスポンス例 200

JSON
{
  "data": {
    "created_at": "2026-10-19T10:00:00Z",
    "customer": {
      "email": "customer@example.invalid",
      "first_name": "Example",
      "last_name": "Example",
      "phone": null
    },
    "delivery": {
      "amount": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "dates": {
        "dispatch_timezone": "Europe/Warsaw",
        "estimated_delivery_from": "2026-10-20",
        "estimated_delivery_to": "2026-10-21",
        "planned_dispatch_on": "2026-10-19"
      },
      "discount_gross": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "discount_net": {
        "amount": "20.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "discount_tax": {
        "amount": "4.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "discounts": [
        {
          "amount": {
            "amount": "24.60",
            "currency": "PLN",
            "minor_units": 2
          },
          "campaign_id": "saved-coupon",
          "code": "SAVE",
          "kind": "coupon",
          "name": "Saved coupon",
          "sequence": 1,
          "version": 3
        }
      ],
      "gross": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "method_code": "shipping-old",
      "method_name": "Historic carrier",
      "net": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_gross": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_net": {
        "amount": "20.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_tax": {
        "amount": "4.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "pickup_point": null,
      "recipient_mode": "full_address",
      "tax": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "tax_category_id": "standard",
      "tax_category_name": "VAT 23%",
      "tax_rate": "0.23"
    },
    "discount_amount": {
      "amount": "24.60",
      "currency": "PLN",
      "minor_units": 2
    },
    "discounts": [
      {
        "amount": {
          "amount": "12.30",
          "currency": "PLN",
          "minor_units": 2
        },
        "campaign_id": "saved-coupon",
        "code": "SAVE",
        "kind": "coupon",
        "name": "Saved coupon",
        "sequence": 1,
        "shipping_amount": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "version": 3
      }
    ],
    "id": "order-0000",
    "invoice": null,
    "invoice_requested": false,
    "lifecycle_state": "placed",
    "lines": [
      {
        "discount_amount": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discounts": [
          {
            "amount": {
              "amount": "12.30",
              "currency": "PLN",
              "minor_units": 2
            },
            "campaign_id": "saved-coupon",
            "code": "SAVE",
            "kind": "coupon",
            "name": "Saved coupon",
            "sequence": 1,
            "shipping_amount": null,
            "version": 3
          }
        ],
        "identifiers": {},
        "image": null,
        "line_id": "saved-line-a",
        "manual_discount": {
          "amount": {
            "amount": "12.30",
            "currency": "PLN",
            "minor_units": 2
          },
          "kind": "fixed",
          "value": "12.30"
        },
        "name": "Saved A",
        "original_total": {
          "amount": "246.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_gross": {
          "amount": "246.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_net": {
          "amount": "200.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_tax": {
          "amount": "46.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "position": 1,
        "product_id": "product-api",
        "quantity": 2,
        "sku": "A",
        "tax": {
          "amount": "20.70",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax_category_id": "standard",
        "tax_category_name": "VAT 23%",
        "tax_rate": "0.23",
        "total": {
          "amount": "221.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_gross": {
          "amount": "221.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_net": {
          "amount": "180.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_tax": {
          "amount": "41.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_gross": {
          "amount": "123.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_price": {
          "amount": "123.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_tax": {
          "amount": "23.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "variant_id": null,
        "variant_options": []
      },
      {
        "discount_amount": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_gross": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_net": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_tax": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discounts": [],
        "identifiers": {},
        "image": null,
        "line_id": "b548a171-c331-505f-98f8-db3a06070998",
        "manual_discount": null,
        "name": "Saved B",
        "original_total": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "position": 2,
        "product_id": "deleted-product",
        "quantity": 1,
        "sku": "B",
        "tax": null,
        "tax_category_id": "reduced",
        "tax_category_name": "VAT 8%",
        "tax_rate": "0.08",
        "total": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_price": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "variant_id": null,
        "variant_options": []
      }
    ],
    "locale": "pl",
    "market_id": "market-pl",
    "number": "0001",
    "payment": {
      "amount": {
        "amount": "329.40",
        "currency": "PLN",
        "minor_units": 2
      },
      "environment": "live",
      "method_code": "payment-old",
      "method_name": "Historic method",
      "paid_at": null,
      "status": "unpaid",
      "updated_at": "2026-10-19T10:00:00Z",
      "version": 0
    },
    "pickup_point": null,
    "prices_include_tax": true,
    "shipping_address": null,
    "shipping_discount_amount": {
      "amount": "24.60",
      "currency": "PLN",
      "minor_units": 2
    },
    "status": {
      "id": "status-0",
      "name": "Status 0",
      "updated_at": "2026-10-19T10:00:00Z",
      "version": 1
    },
    "subtotal": {
      "amount": "329.40",
      "currency": "PLN",
      "minor_units": 2
    },
    "tax": {
      "amount": "49.40",
      "currency": "PLN",
      "minor_units": 2
    },
    "tax_breakdown": {
      "groups": [
        {
          "gross": {
            "amount": "221.40",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "180.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "products",
          "tax": {
            "amount": "41.40",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.23"
        },
        {
          "gross": {
            "amount": "108.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "100.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "products",
          "tax": {
            "amount": "8.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.08"
        },
        {
          "gross": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "shipping",
          "tax": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.23"
        }
      ],
      "unallocated_tax": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      }
    },
    "tax_country_code": "PL",
    "total": {
      "amount": "329.40",
      "currency": "PLN",
      "minor_units": 2
    },
    "totals": {
      "before_discounts": {
        "gross": {
          "amount": "378.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "320.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "58.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "discounts": {
        "gross": {
          "amount": "49.20",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "40.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "9.20",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "order": {
        "gross": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "280.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "49.40",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "product_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "products": {
        "gross": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "280.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "49.40",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "products_before_discounts": {
        "gross": {
          "amount": "354.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "300.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "54.00",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping": {
        "gross": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping_before_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      }
    }
  },
  "meta": {
    "request_id": "example-request"
  }
}

仕組み

  • コレクションには注文概要と、番号、ステータス、支払いステータス、作成時刻のフィルターがあります。
  • 注文一覧と詳細には delivery.dates が含まれます。YYYY-MM-DD 形式の日付は予定であり、発送済みを示しません。現在の日付が優先され、古い注文には保存された予測が使われます。削除済みまたは不明な値は null です。詳細にはすべての注文明細と商品画像も含まれます。
  • 有効なステータス識別子は /api/v1/order-statuses から取得します。
  • 注文と支払いのステータスには、それぞれ別の PATCH エンドポイントと権限があります。
  • 記録上の支払いステータスを変えても、カードへの請求や決済事業者経由の返金は行われません。

安全な書き込み

権限とプラン

注文 · 合計

金額と税率は、項目の訂正を含む保存済み注文に基づきます。履歴が欠けている場合は null となり、現在の商品カタログの税率では補完しません。金額は十進数の文字列のまま扱います。

一覧は概要を返します。各結果に対して GET /api/v1/orders/{order_id} を取得し、完全な金額明細を出力します。GET の再試行回数は制限され、Retry-After に従います。作成日による出力は、その後の訂正を同期しません。

  • tax_country_code · 課税国 · 保存された注文データ · ISO 3166-1 alpha-2; null.
  • lines[].unit_* · 1単位 · 割引前; lines[].original_total_* · 割引前; lines[].total_* · 割引後.
  • lines[].discount_* · 割引; manual_discount · 手動割引; percentage "10" = 10%.
  • delivery.net / tax / gross · 割引後; delivery.original_* · 割引前; delivery.discount_* · 割引.
  • tax_rate: "0.23" = 23%; "0" ≠ null. 不明: null、既知のゼロ: 0.
  • totals · 合計; tax_breakdown.groups · 税グループ; 未配分の税額 = order.tax − Σ groups.tax; ±.

payment.amount は注文合計です。支払状態から支払済み額、返金額、未払額は確定できません。

パラメーター

パスパラメーター

order_id文字列必須

関連する注文の識別子。

制約
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
例: "example"

この操作は JSON 本文を受け付けません。

レスポンス

レスポンス 200

完全なモデル: ApiResponse_OrderDetailData_

dataOrderDetailData 必須

成功レスポンスのデータ。

フィールド · data

完全なモデル: OrderDetailData

created_at文字列必須

作成時刻。

format: "date-time"
customerCustomerData 必須

このリソースに記録された顧客情報。

フィールド · customer

完全なモデル: CustomerData

email文字列必須

メールアドレス。

first_name文字列 null必須

名。

last_name文字列 null必須

姓。

phone文字列 null必須

電話番号。

deliveryShippingDetailData 必須

配送方法と関連情報。

フィールド · delivery

完全なモデル: ShippingDetailData

amountMoneyData 必須

JSON 文字列として表した10進数の金額。null は許可される場合のみ。

datesDeliveryDatesData 必須

発送日と配送予定日

discount_grossMoneyData 必須

税込金額 · 割引; 不明: null、既知のゼロ: 0.

discount_netMoneyData null必須

税抜金額 · 割引; 不明: null、既知のゼロ: 0.

discount_taxMoneyData null必須

税額 · 割引; 不明: null、既知のゼロ: 0.

discounts配列 <OrderDeliveryDiscountData > null必須

割引

grossMoneyData 必須

税込金額 · 割引後; 不明: null、既知のゼロ: 0.

method_code文字列 null必須

配送方法または支払い方法のコード。

method_name文字列 null必須

配送方法または支払い方法の名前。

netMoneyData null必須

税抜金額 · 割引後; 不明: null、既知のゼロ: 0.

original_grossMoneyData 必須

税込金額 · 配送 · 割引前; 不明: null、既知のゼロ: 0.

original_netMoneyData null必須

税抜金額 · 配送 · 割引前; 不明: null、既知のゼロ: 0.

original_taxMoneyData null必須

税額 · 配送 · 割引前; 不明: null、既知のゼロ: 0.

pickup_pointDeliveryPickupPointData null必須

受取場所

recipient_mode文字列必須

許可された値で示されるデータ構造の種類。

制約
enum
["full_address", "pickup_contact"]
taxMoneyData null必須

税情報。

tax_category_id文字列 null必須

税カテゴリー識別子。

tax_category_name文字列 null必須

保存された税区分名; null.

tax_rate文字列 null必須

tax_rate · 保存された注文データ: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData 必須

JSON 文字列として表した10進数の金額。null は許可される場合のみ。

フィールド · discount_amount

完全なモデル: MoneyData

amount文字列必須

JSON 文字列として表した10進数の金額。null は許可される場合のみ。

currency文字列必須

金額の通貨コード。

制約
pattern
"^[A-Z]{3}$"
minor_units整数必須

通貨で使用する小数桁数。

minimum: 0maximum: 4
discounts配列 <OrderDiscountData > 必須

割引

フィールド · discounts

OrderDiscountData

完全なモデル: OrderDiscountData

id文字列必須

リソース識別子。返された値をそのまま保持してください。

invoiceInvoiceData null必須

請求書情報。

フィールド · invoice

InvoiceData

完全なモデル: InvoiceData

null

invoice_requested真偽値必須

請求書が要求されたかどうか。

lifecycle_stateOrderLifecycleState 必須

業務上のライフサイクル状態。

lines配列 <OrderLineData > 必須

注文明細のスナップショット。

フィールド · lines

OrderLineData

完全なモデル: OrderLineData

locale文字列必須

このリクエストで選択した言語。

market_id文字列必須

コンテキストエンドポイントが返した市場識別子。

number文字列必須

人向けの注文番号または申請番号。

paymentPaymentData 必須

注文に記録された支払い詳細。

フィールド · payment

完全なモデル: PaymentData

amountMoneyData 必須

JSON 文字列として表した10進数の金額。null は許可される場合のみ。

environment文字列必須

レコードに付随する環境情報。

制約
enum
["live", "sandbox"]
method_code文字列 null必須

配送方法または支払い方法のコード。

method_name文字列 null必須

配送方法または支払い方法の名前。

paid_at文字列 null必須

支払いを支払済みとして記録した日時。

文字列:format: "date-time"
statusOrderPaymentStatus 必須

この操作で受け付けるステータス。

updated_at文字列必須

最終更新時刻。

format: "date-time"
version整数必須

同時更新制御に使うリソースバージョン。

pickup_pointPickupPointData null必須

受取場所

フィールド · pickup_point

PickupPointData

完全なモデル: PickupPointData

null

prices_include_tax真偽値必須

表示価格が税込みかどうか。

shipping_addressAddressData null必須

配送先住所。

フィールド · shipping_address

AddressData

完全なモデル: AddressData

null

shipping_discount_amountMoneyData 必須

JSON 文字列として表した10進数の金額。null は許可される場合のみ。

フィールド · shipping_discount_amount

完全なモデル: MoneyData

amount文字列必須

JSON 文字列として表した10進数の金額。null は許可される場合のみ。

currency文字列必須

金額の通貨コード。

制約
pattern
"^[A-Z]{3}$"
minor_units整数必須

通貨で使用する小数桁数。

minimum: 0maximum: 4
statusOrderStatusData 必須

この操作で受け付けるステータス。

フィールド · status

完全なモデル: OrderStatusData

id文字列必須

リソース識別子。返された値をそのまま保持してください。

name文字列必須

該当コンテキストでのリソース名。

updated_at文字列必須

最終更新時刻。

format: "date-time"
version整数必須

同時更新制御に使うリソースバージョン。

subtotalMoneyData 必須

レスポンスに示す追加項目を含める前の金額。

フィールド · subtotal

完全なモデル: MoneyData

amount文字列必須

JSON 文字列として表した10進数の金額。null は許可される場合のみ。

currency文字列必須

金額の通貨コード。

制約
pattern
"^[A-Z]{3}$"
minor_units整数必須

通貨で使用する小数桁数。

minimum: 0maximum: 4
taxMoneyData 必須

税情報。

フィールド · tax

完全なモデル: MoneyData

amount文字列必須

JSON 文字列として表した10進数の金額。null は許可される場合のみ。

currency文字列必須

金額の通貨コード。

制約
pattern
"^[A-Z]{3}$"
minor_units整数必須

通貨で使用する小数桁数。

minimum: 0maximum: 4
tax_breakdownOrderTaxBreakdownData 必須

税グループ · source + tax_rate; unallocated_tax.

フィールド · tax_breakdown

完全なモデル: OrderTaxBreakdownData

groups配列 <OrderTaxGroupData > 必須

税グループ · source + tax_rate; 不明: null、既知のゼロ: 0.

unallocated_taxMoneyData 必須

未配分の税額 = order.tax − Σ groups.tax; ±.

tax_country_code文字列 null必須

課税国 · 保存された注文データ · ISO 3166-1 alpha-2; null.

totalMoneyData 必須

合計金額。

フィールド · total

完全なモデル: MoneyData

amount文字列必須

JSON 文字列として表した10進数の金額。null は許可される場合のみ。

currency文字列必須

金額の通貨コード。

制約
pattern
"^[A-Z]{3}$"
minor_units整数必須

通貨で使用する小数桁数。

minimum: 0maximum: 4
totalsOrderTotalsData 必須

合計 · net / tax / gross; 割引前 / 割引後.

フィールド · totals

完全なモデル: OrderTotalsData

before_discountsOrderAmountBreakdownData 必須

注文 · 割引前 · net / tax / gross.

discountsOrderAmountBreakdownData 必須

割引

orderOrderAmountBreakdownData 必須

注文 · 割引後 · net / tax / gross.

product_discountsOrderAmountBreakdownData 必須

商品 · 割引 · net / tax / gross.

productsOrderAmountBreakdownData 必須

商品 · 割引後 · net / tax / gross.

products_before_discountsOrderAmountBreakdownData 必須

商品 · 割引前 · net / tax / gross.

shippingOrderAmountBreakdownData 必須

配送 · 割引後 · net / tax / gross.

shipping_before_discountsOrderAmountBreakdownData 必須

配送 · 割引前 · net / tax / gross.

shipping_discountsOrderAmountBreakdownData 必須

配送 · 割引 · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta 必須

レスポンスのメタデータ。

フィールド · meta

ContextPageMeta

完全なモデル: ContextPageMeta

locale文字列必須

このリクエストで選択した言語。

market_code文字列必須

コンテキストエンドポイントが返した市場コード。

market_id文字列必須

コンテキストエンドポイントが返した市場識別子。

paginationPagination 必須

カーソルによるページ分割のメタデータ。

request_id文字列必須

申請識別子。レスポンスのメタデータでは HTTP リクエストを識別します。

minLength: 1maxLength: 100

ContextMeta

完全なモデル: ContextMeta

locale文字列必須

このリクエストで選択した言語。

market_code文字列必須

コンテキストエンドポイントが返した市場コード。

market_id文字列必須

コンテキストエンドポイントが返した市場識別子。

request_id文字列必須

申請識別子。レスポンスのメタデータでは HTTP リクエストを識別します。

minLength: 1maxLength: 100

PageMeta

完全なモデル: PageMeta

paginationPagination 必須

カーソルによるページ分割のメタデータ。

request_id文字列必須

申請識別子。レスポンスのメタデータでは HTTP リクエストを識別します。

minLength: 1maxLength: 100

RequestMeta

完全なモデル: RequestMeta

request_id文字列必須

申請識別子。レスポンスのメタデータでは HTTP リクエストを識別します。

minLength: 1maxLength: 100
レスポンス例

HTTP ステータス

200
成功 スキーマ
400
無効なリクエスト
401
認証が必要です
403
権限がありません
404
リソースが見つかりません
409
バージョンの競合
422
検証エラー
429
リクエスト上限を超過
その他の HTTP ステータス (7)
405
許可されていないメソッド
413
リクエストが大きすぎます
415
未対応の形式
500
サーバーエラー
502
API ゲートウェイエラー
503
サービスを利用できません
504
タイムアウト

エラー一覧: ErrorResponse

ヘッダー

401

WWW-Authenticate文字列任意

サーバーが要求する認証方式。

405

Allow文字列任意

このリソースが対応する HTTP メソッド。

429, 503

Retry-After整数任意

再試行までに最低限待つ秒数。

minimum: 0

エラー一覧 · 詳細を見る