Return Order Webhook

POSThttps://your_server_address/{your_return_order_endpoint}

ヘッダー

• X-Recustomer-Signature-256string必須

  ペイロードの HMAC SHA256 署名。データの完全性と送信元の認証を保証するためにヘッダーで提供される。署名は'sha256=signature'の形式と一致する必要があり、signature は 64 文字の 16 進文字列である。

  形式: ^sha256=[a-fA-F0-9]{64}$

• X-Recustomer-Sender-IDstring必須

  このヘッダは、受信者がウェブフックの送信元を識別できるように、ウェブフックをトリガーした一意の識別子を含んでいます。

リクエストボディ

• idinteger必須

  Return Order の ID

• external_order_idstring必須

  元の注文 ID

• order_numberstring必須

  注文番号

• request_idstring必須

  リクエストの ID

• created_atstring(date-time)必須

  返品作成日時

• refund_reject_reasonstring

  返金拒否理由

• approval_atstring(date-time)

  返品承認日時

• send_backed_atstring(date-time)

  返送日時

• reshipmented_atstring(date-time)

  再返送日時

• exchanged_atstring(date-time)

  交換日時

• refunded_atstring(date-time)

  返金日時

• completed_atstring(date-time)

  リクエスト完了日時

• approval_statusstring

  承認ステータス

  取りうる値: unapproved partially_unapproved approved partially_approved rejected deleted

• send_back_statusstring

  返送ステータス

  取りうる値: unarrived partially_unarrived accepted partially_accepted refused unnecessary expired

• reshipment_statusstring

  再返送ステータス

  取りうる値: unreshiped partially_unreshiped reshiped

• exchange_statusstring

  交換ステータス

  取りうる値: unexchanged partially_unexchanged exchanged partially_exchanged rejected

• refund_statusstring

  返金ステータス

  取りうる値: unrefunded processing refunded rejected

• payment_statusstring

  決済ステータス

  取りうる値: unpaid processing paid

• exchange_slip_creation_statusstring

  交換伝票発行ステータス

  取りうる値: uncreated partiallycreated created

• order_itemsarray of objects必須
  子の属性を表示12

  • idinteger必須

    返品アイテム ID

  • original_item_idstring必須

    元の item ID

  • skustring必須

    返品アイテム SKU

  • product_idstring必須

    返品商品 ID

  • image_linkstring

    返品商品画像

  • is_deletedboolean必須

    返品商品が削除されたかどうか

  • item_namestring必須

    返品商品名

  • item_pricenumber必須

    返品商品金額

  • currencystring必須

    通過

  • item_resultobject必須
    子の属性を表示13

    • idinteger必須

      返品商品の結果 ID

    • approval_statusstring

      返品商品承認ステータス

      取りうる値: unapproved manually_approved automatically_approved manually_rejected automatically_rejected deleted

    • send_back_statusstring

      返品商品返送ステータス

      取りうる値: unarrived accepted refused unnecessary expired

    • reshipment_statusstring

      返品商品再返送ステータス

      取りうる値: unreshiped reshiped

    • resolution_methodstring

      返品商品対応方法

      取りうる値: exchange refund repair

    • item_statusstring

      返品商品検品結果

    • is_required_send_backboolean必須

      返送が必要かどうか

    • is_customer_payboolean

      返送料負担がカスタマー負担かどうか

    • approval_reject_reasonstring

      承認拒否理由

    • exchange_reject_reasonstring

      交換拒否理由

    • memostring

      メモ

    • send_back_reject_reasonstring

      返送拒否理由

    • arrival_datestring(date)

      返送到着日

  • optionsarray of objects
    子の属性を表示2

    • keystring必須

      返品商品オプションキー

    • valuestring必須

      返品商品オプション値

  • exchange_itemobject
    子の属性を表示10

    • idinteger必須

      交換商品 ID

    • item_namestring必須

      交換商品名

    • optionsarray of objects
      子の属性を表示2

      • keystring必須

        返品商品オプションキー

      • valuestring必須

        返品商品オプション値

    • image_linkstring

      交換商品画像

    • skustring必須

      交換商品 SKU

    • item_pricenumber必須

      交換商品金額

    • currencystring必須

      通過

    • exchange_statusstring

      交換ステータス

      取りうる値: unexchanged exchanged rejected

    • exchange_slip_creation_statusstring

      交換伝票発行ステータス

      取りうる値: uncreated created

    • external_order_codestring

      外部交換伝票コード

• customerobject必須
  子の属性を表示10

  • idinteger必須

    顧客 ID

  • emailstring必須

    メールアドレス

  • return_countinteger必須

    返品回数

  • cancel_countinteger必須

    キャンセル回数

  • last_namestring必須

    苗字

  • first_namestring必須

    名前

  • full_namestring必須

    フルネーム

  • phone_numberstring必須

    電話番号

  • is_consent_email_marketingboolean必須

    マーケティングメールの可否

  • is_consent_sms_marketingboolean必須

    マーケティング SMS の可否

• shipping_addressobject
  子の属性を表示10

  • last_namestring必須

    苗字

  • first_namestring必須

    名前

  • full_namestring必須

    フルネーム

  • phone_numberstring必須

    電話番号

  • country_codestring必須

    国コード

  • postal_codestring必須

    郵便番号

  • provincestring必須

    都道府県

  • citystring必須

    市区町村

  • address1string必須

    住所 1（町名・番地など）

  • address2string必須

    住所 2（建物名・部屋番号など）

• billing_addressobject
  子の属性を表示10

  • last_namestring必須

    苗字

  • first_namestring必須

    名前

  • full_namestring必須

    フルネーム

  • phone_numberstring必須

    電話番号

  • country_codestring必須

    国コード

  • postal_codestring必須

    郵便番号

  • provincestring必須

    都道府県

  • citystring必須

    市区町村

  • address1string必須

    住所 1（町名・番地など）

  • address2string必須

    住所 2（建物名・部屋番号など）

• refund_infoobject
  子の属性を表示8

  • idinteger必須

    返金情報 ID

  • payment_methodstring

    決済方法

  • refund_methodstring

    返金

    取りうる値: API返金 PSP画面 銀行振込

  • refund_sub_totalnumber必須

    返金小計

  • taxnumber必須

    税

  • suggested_amountnumber必須

    返金提案金額

  • fixed_amountnumber

    返金した金額

  • discount_and_expensesarray of objects必須
    子の属性を表示4

    • idinteger必須
    • suggested_amountnumber
    • fixed_amountnumber
    • discount_expenses_namestring必須

      割引・費用名の設定名称

• is_archiveboolean必須

レスポンス

200 OK

• resultsstring