Returns a paginated list of return process summaries, with optional filters (order ID, status, customer email, order number).
Query parameters
The page number to return
The order ID to search for, this is the order ID from the e-commerce not the customer order ID
The status of the return process
The email of the customer
The order number to search for, this is the order number the user received in their email
Response
OK
Changes
Changed in 1 of the 2 revisions of this API.711219
- ▲
the
return_summaries/items/compensation/bank_transfer/refunds/items/amount/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/bank_transfer/refunds/items/amount/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/bank_transfer/summary/adjusted_commitment/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/bank_transfer/summary/adjusted_commitment/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/bank_transfer/summary/adjustmentsresponse's property type/format changed fromobject/to/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/bank_transfer/summary/executed/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/bank_transfer/summary/executed/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/bank_transfer/summary/initial_commitment/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/bank_transfer/summary/initial_commitment/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/editable_refund_amount/maximum_refundable_amount/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/editable_refund_amount/maximum_refundable_amount/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/exchange/exchange_order/amount/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/exchange/exchange_order/amount/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/exchange/summary/adjusted_commitment/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/exchange/summary/adjusted_commitment/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/exchange/summary/adjustmentsresponse's property type/format changed fromobject/to/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/exchange/summary/executed/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/exchange/summary/executed/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/exchange/summary/initial_commitment/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/exchange/summary/initial_commitment/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/gift_card/gift_card/amount/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/gift_card/gift_card/amount/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/gift_card/summary/adjusted_commitment/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/gift_card/summary/adjusted_commitment/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/gift_card/summary/adjustmentsresponse's property type/format changed fromobject/to/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/gift_card/summary/executed/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/gift_card/summary/executed/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/gift_card/summary/initial_commitment/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/gift_card/summary/initial_commitment/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/original_payment_method/refunds/items/amount/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/original_payment_method/refunds/items/amount/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/original_payment_method/summary/adjusted_commitment/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/original_payment_method/summary/adjusted_commitment/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/original_payment_method/summary/adjustmentsresponse's property type/format changed fromobject/to/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/original_payment_method/summary/executed/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/original_payment_method/summary/executed/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/original_payment_method/summary/initial_commitment/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/original_payment_method/summary/initial_commitment/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/promocode/amount/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/promocode/amount/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/promocode/promocode/amount/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/promocode/promocode/amount/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/promocode/summary/adjusted_commitment/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/promocode/summary/adjusted_commitment/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/promocode/summary/adjustmentsresponse's property type/format changed fromobject/to/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/promocode/summary/executed/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/promocode/summary/executed/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/promocode/summary/initial_commitment/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/compensation/promocode/summary/initial_commitment/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/extra_line_items/extra_line_items/items/total/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/extra_line_items/extra_line_items/items/total/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/extra_line_items/total/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/extra_line_items/total/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/open_exchange_items/open_exchange_items/items/total/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/open_exchange_items/open_exchange_items/items/total/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/open_exchange_items/total/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/open_exchange_items/total/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/ordered_items/ordered_items/items/total/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/ordered_items/ordered_items/items/total/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/ordered_items/total/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/ordered_items/total/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/payments/commitment/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/payments/commitment/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/payments/executed/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/payments/executed/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/returned_items/returned_items/items/total/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/returned_items/returned_items/items/total/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/returned_items/returned_items/items/unit_price/allOf[pb.MoneyBag]/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/returned_items/returned_items/items/unit_price/allOf[pb.MoneyBag]/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/returned_items/total/presentment_money/amountresponse's property type/format changed fromstring/centstostring/for status200response-property-type-changed
- ▲
the
return_summaries/items/returned_items/total/presentment_money/currency_coderesponse's property type/format changed fromstring/ISO 4217 currency codestostring/for status200response-property-type-changed
- ●
removed the optional property
return_summaries/items/compensation/bank_transfer/summary/adjustments/presentment_moneyfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
return_summaries/items/compensation/exchange/summary/adjustments/presentment_moneyfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
return_summaries/items/compensation/gift_card/summary/adjustments/presentment_moneyfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
return_summaries/items/compensation/original_payment_method/summary/adjustments/presentment_moneyfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
return_summaries/items/compensation/promocode/summary/adjustments/presentment_moneyfrom the response with the200statusresponse-optional-property-removed
- ●
added the new
CUSTOM_INTEGRATION_V2enum value to thereturn_summaries/items/basic_process_data/platformresponse property for the response status200response-property-enum-value-added
- ●
added the new
INDITEXenum value to thereturn_summaries/items/basic_process_data/platformresponse property for the response status200response-property-enum-value-added
- ●
added the new
SHOPWAREenum value to thereturn_summaries/items/basic_process_data/platformresponse property for the response status200response-property-enum-value-added
- ●
added the new
TYPE_EXCHANGE_PROMOTIONenum value to thereturn_summaries/items/extra_line_items/extra_line_items/items/typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
TYPE_FREE_RETURN_PROMOTIONenum value to thereturn_summaries/items/extra_line_items/extra_line_items/items/typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
TYPE_INSTANT_EXCHANGEenum value to thereturn_summaries/items/extra_line_items/extra_line_items/items/typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
TYPE_RETURN_SHIPPING_TAXenum value to thereturn_summaries/items/extra_line_items/extra_line_items/items/typeresponse property for the response status200response-property-enum-value-added
- ○
added the optional property
return_summaries/items/basic_process_data/order_nameto the response with the200statusresponse-optional-property-added
- ○
added the optional property
return_summaries/items/basic_process_data/warehouse_idto the response with the200statusresponse-optional-property-added
- ○
added the optional property
return_summaries/items/checkout_idto the response with the200statusresponse-optional-property-added
- ○
added the optional property
return_summaries/items/compensation/bank_transfer/summary/adjustments_listto the response with the200statusresponse-optional-property-added
- ○
added the optional property
return_summaries/items/compensation/compensation_status_summaryto the response with the200statusresponse-optional-property-added
- ○
added the optional property
return_summaries/items/compensation/exchange/exchange_order/navigationto the response with the200statusresponse-optional-property-added
- ○
added the optional property
return_summaries/items/compensation/exchange/summary/adjustments_listto the response with the200statusresponse-optional-property-added
- ○
added the optional property
return_summaries/items/compensation/gift_card/summary/adjustments_listto the response with the200statusresponse-optional-property-added
- ○
added the optional property
return_summaries/items/compensation/original_payment_method/summary/adjustments_listto the response with the200statusresponse-optional-property-added
- ○
added the optional property
return_summaries/items/compensation/promocode/summary/adjustments_listto the response with the200statusresponse-optional-property-added
- ○
added the optional property
return_summaries/items/is_claimto the response with the200statusresponse-optional-property-added
- ○
added the optional property
return_summaries/items/navigationto the response with the200statusresponse-optional-property-added
- ○
added the optional property
return_summaries/items/ordered_items/ordered_items/items/image_urlto the response with the200statusresponse-optional-property-added
- ○
added the optional property
return_summaries/items/returned_items/returned_items/items/return_reason_commentto the response with the200statusresponse-optional-property-added
- ○
added
pb.MoneyBagto thereturn_summaries/items/compensation/bank_transfer/summary/adjustmentsresponse propertyallOflist for the response status200response-property-all-of-added
- ○
added
pb.MoneyBagto thereturn_summaries/items/compensation/exchange/summary/adjustmentsresponse propertyallOflist for the response status200response-property-all-of-added
- ○
added
pb.MoneyBagto thereturn_summaries/items/compensation/gift_card/summary/adjustmentsresponse propertyallOflist for the response status200response-property-all-of-added
- ○
added
pb.MoneyBagto thereturn_summaries/items/compensation/original_payment_method/summary/adjustmentsresponse propertyallOflist for the response status200response-property-all-of-added
- ○
added
pb.MoneyBagto thereturn_summaries/items/compensation/promocode/summary/adjustmentsresponse propertyallOflist for the response status200response-property-all-of-added
This revision also has 331 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲