API リファレンス / 注文

注文配送希望日時更新

リクエスト例

curl -X PUT "https://apiv2.thebase.com/api/orders/<unique_key>/delivery" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
  "delivery_date": "string",
  "delivery_time_zone": "string"
}'

パラメータ

リクエストボディ application/json

• delivery_datestring (date)必須nullable
  配送希望日（YYYY-MM-DD）。希望日を解除する場合は null です。
• delivery_time_zonestring必須nullablepattern: ^(?:[01]\d|2[0-3])(?:[01]\d|2[0-3])$
  配送希望時間帯（開始時刻と終了時刻を連結した 4 桁。例: '1214'）。時間帯を解除する場合は null です。

レスポンス

200 のレスポンスボディ（application/json）:

• shipping_methodstring必須nullable
  注文全体に設定された配送方法名。サイズ別配送（shipping_lines）利用時は null です。
• delivery_company_idinteger必須
  注文全体の配送業者 ID。未指定は 0 です。
• tracking_numberstring必須nullable
  注文全体の伝票番号
• delivery_datestring (date)必須nullable
  配送希望日（YYYY-MM-DD）。未指定は null です。
• delivery_time_zonestring必須nullable
  配送希望時間帯（4 桁。例: '1214' = 12 時-14 時）。未指定は null です。
• dispatched_atstring (date-time)必須nullable
  最終発送日時（RFC 3339, 秒精度 UTC）。未発送は null です。
• dispatchesOrderDispatch[]必須
  部分発送の履歴。古い順に並びます。
  • idinteger必須
    発送履歴 ID
  • delivery_company_idinteger必須nullable
    配送業者 ID。未指定は null です。
  • tracking_numberstring必須nullable
    追跡番号。未指定は null です。
  • commentstring必須nullable
    発送コメント
  • dispatched_atstring (date-time)必須
    発送日時（RFC 3339, 秒精度 UTC）
  • order_line_idsinteger[]必須
    この発送に含まれる明細 ID の配列。部分発送に対応するため、複数の明細 ID を含む場合があります。

エラー

エラーは application/problem+json の Problem 形式で返します。 認証・スコープ・予期しない内部エラーなど、すべてのエンドポイントに共通のエラーと 構造・判別方法は エラーレスポンス を参照してください。

このエンドポイントが返すその他のエラーは次のとおりです。