Docs

Return Order Webhook

View as Markdownllms.txt

POSThttps://your_server_address/{your_return_order_endpoint}

Notifies you of a return status update.

Headers

  • X-Recustomer-Signature-256stringrequired

    HMAC SHA256 signature of the payload, sent in a header to guarantee data integrity and authenticate the sender. The signature has the form 'sha256=signature', where signature is a 64-character hexadecimal string.

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

  • X-Recustomer-Sender-IDstringrequired

    Contains a unique identifier of what triggered the webhook, so that the receiver can identify the sender.

Request body

  • idintegerrequired

    ID of the Return Order

  • external_order_idstringrequired

    ID of the original order

  • order_numberstringrequired

    Order number

  • request_idstringrequired

    ID of the request

  • created_atstring(date-time)required

    Return created at

  • refund_reject_reasonstring

    Reason for rejecting the refund

  • approval_atstring(date-time)

    Return approved at

  • send_backed_atstring(date-time)

    Sent back at

  • reshipmented_atstring(date-time)

    Reshipped at

  • exchanged_atstring(date-time)

    Exchanged at

  • refunded_atstring(date-time)

    Refunded at

  • completed_atstring(date-time)

    Request completed at

  • approval_statusstring

    Approval status

    Possible values: unapproved partially_unapproved approved partially_approved rejected deleted

  • send_back_statusstring

    Send back status

    Possible values: unarrived partially_unarrived accepted partially_accepted refused unnecessary expired

  • reshipment_statusstring

    Reship status

    Possible values: unreshiped partially_unreshiped reshiped

  • exchange_statusstring

    Exchange status

    Possible values: unexchanged partially_unexchanged exchanged partially_exchanged rejected

  • refund_statusstring

    Refund status

    Possible values: unrefunded processing refunded rejected

  • payment_statusstring

    Payment status

    Possible values: unpaid processing paid

  • exchange_slip_creation_statusstring

    Exchange order issuance status

    Possible values: uncreated partiallycreated created

  • order_itemsarray of objectsrequired
    Show child attributes12
    • idintegerrequired

      Return item ID

    • original_item_idstringrequired

      Original item ID

    • skustringrequired

      Return item SKU

    • product_idstringrequired

      Returned product ID

    • image_linkstring

      Returned product image

    • is_deletedbooleanrequired

      Whether the returned product has been deleted

    • item_namestringrequired

      Returned product name

    • item_pricenumberrequired

      Returned product price

    • currencystringrequired

      Currency

    • item_resultobjectrequired
      Show child attributes13
      • idintegerrequired

        ID of the result for the returned item

      • approval_statusstring

        Approval status of the returned item

        Possible values: unapproved manually_approved automatically_approved manually_rejected automatically_rejected deleted

      • send_back_statusstring

        Send back status of the returned item

        Possible values: unarrived accepted refused unnecessary expired

      • reshipment_statusstring

        Reship status of the returned item

        Possible values: unreshiped reshiped

      • resolution_methodstring

        Resolution for the returned item

        Possible values: exchange refund repair

      • item_statusstring

        Inspection result of the returned item

      • is_required_send_backbooleanrequired

        Whether the item needs to be sent back

      • is_customer_payboolean

        Whether the customer pays the return shipping

      • approval_reject_reasonstring

        Reason for rejecting approval

      • exchange_reject_reasonstring

        Reason for rejecting the exchange

      • memostring

        Memo

      • send_back_reject_reasonstring

        Reason for rejecting the send back

      • arrival_datestring(date)

        Date the sent-back item arrived

    • optionsarray of objects
      Show child attributes2
      • keystringrequired

        Option key of the returned item

      • valuestringrequired

        Option value of the returned item

    • exchange_itemobject
      Show child attributes10
      • idintegerrequired

        Exchange product ID

      • item_namestringrequired

        Exchange product name

      • optionsarray of objects
        Show child attributes2
        • keystringrequired

          Option key of the returned item

        • valuestringrequired

          Option value of the returned item

      • image_linkstring

        Exchange product image

      • skustringrequired

        Exchange product SKU

      • item_pricenumberrequired

        Exchange product price

      • currencystringrequired

        Currency

      • exchange_statusstring

        Exchange status

        Possible values: unexchanged exchanged rejected

      • exchange_slip_creation_statusstring

        Exchange order issuance status

        Possible values: uncreated created

      • external_order_codestring

        External exchange order code

  • customerobjectrequired
    Show child attributes10
    • idintegerrequired

      Customer ID

    • emailstringrequired

      Email address

    • return_countintegerrequired

      Number of returns

    • cancel_countintegerrequired

      Number of cancellations

    • last_namestringrequired

      Last name

    • first_namestringrequired

      First name

    • full_namestringrequired

      Full name

    • phone_numberstringrequired

      Phone number

    • is_consent_email_marketingbooleanrequired

      Whether marketing email is allowed

    • is_consent_sms_marketingbooleanrequired

      Whether marketing SMS is allowed

  • shipping_addressobject
    Show child attributes10
    • last_namestringrequired

      Last name

    • first_namestringrequired

      First name

    • full_namestringrequired

      Full name

    • phone_numberstringrequired

      Phone number

    • country_codestringrequired

      Country code

    • postal_codestringrequired

      Postal code

    • provincestringrequired

      Prefecture

    • citystringrequired

      City

    • address1stringrequired

      Address line 1 (street and number)

    • address2stringrequired

      Address line 2 (building and room number)

  • billing_addressobject
    Show child attributes10
    • last_namestringrequired

      Last name

    • first_namestringrequired

      First name

    • full_namestringrequired

      Full name

    • phone_numberstringrequired

      Phone number

    • country_codestringrequired

      Country code

    • postal_codestringrequired

      Postal code

    • provincestringrequired

      Prefecture

    • citystringrequired

      City

    • address1stringrequired

      Address line 1 (street and number)

    • address2stringrequired

      Address line 2 (building and room number)

  • refund_infoobject
    Show child attributes8
    • idintegerrequired

      Refund information ID

    • payment_methodstring

      Payment method

    • refund_methodstring

      Refund

      Possible values: API返金 PSP画面 銀行振込

    • refund_sub_totalnumberrequired

      Refund subtotal

    • taxnumberrequired

      Tax

    • suggested_amountnumberrequired

      Suggested refund amount

    • fixed_amountnumber

      Refunded amount

    • discount_and_expensesarray of objectsrequired
      Show child attributes4
      • idintegerrequired
      • suggested_amountnumber
      • fixed_amountnumber
      • discount_expenses_namestringrequired

        Name of the discount or fee setting

  • is_archivebooleanrequired

Responses

200 OK

  • resultsstring
© Recustomer, Inc.