---
title: "GET /v1/processes/ecommerce/{platform_process_id}"
method: GET
path: "/v1/processes/ecommerce/{platform_process_id}"
tags: ["Processes"]
---

# GET /v1/processes/ecommerce/{platform_process_id}

`GET /v1/processes/ecommerce/{platform_process_id}`

Get a Return Summary by the e-commerce platform process ID. Useful when the caller knows the platform's internal ID (e.g. Shopify/Shopware order or return ID) but not REVER's internal process ID.

## Path parameters

- `platform_process_id` string, required

## Response `200`

OK

- PbGetReturnSummaryResponse
  - `return_summary` PbReturnSummary
    - `basic_process_data` PbBasicProcessData
      - `customer_printed_order_id` string — Customer printed order ID
      - `ecommerce_group` string — Ecommerce Group
      - `ecommerce_id` string — Ecommerce ID
      - `is_lite` boolean — IsLite
      - `is_testing` boolean — Flag for a test process
      - `order_id` string — Order ID
      - `order_purchased_at` string, date-time — Order Purchase Date
      - `platform` 'MOCK' | 'WOOCOMMERCE' | 'SHOPIFY' | 'CUSTOM_GENERIC' | 'PRESTASHOP' | 'MAGENTO_V1' | 'MAGENTO_V2' | 'SALESFORCE', enum — Platform
      - `platform_process_id` string — Platform process ID
      - `process_id` string — Process ID
      - `started_at` string, date-time — Started at
    - `compensation` PbCompensation
      - `bank_transfer` PbBankTransferCompensation
        - `refunds` PbBankTransferRefund[]
          - `amount` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `created_at` string, date-time
        - `summary` PbCompensationSummary
          - `adjusted_commitment` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `adjustment_reason` string
          - `adjustments` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `executed` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `initial_commitment` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `timing` 'TIMING_UNSPECIFIED' | 'TIMING_NO_TIMING' | 'TIMING_ON_START' | 'TIMING_ON_SENT' | 'TIMING_ON_VERIFIED', enum
      - `editable_refund_amount` PbCompensationEditableRefundAmount
        - `is_refund_amount_editable` boolean
        - `maximum_refundable_amount` PbMoneyBag
          - `presentment_money` PbMoney
            - `amount` string, cents — Amount of the refund in cents
            - `currency_code` string, ISO 4217 currency codes — Currency of the refund
      - `exchange` PbExchangeCompensation
        - `exchange_order` PbExchangeOrder
          - `amount` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `created_at` string, date-time
          - `order_number` string
        - `summary` PbCompensationSummary
          - `adjusted_commitment` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `adjustment_reason` string
          - `adjustments` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `executed` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `initial_commitment` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `timing` 'TIMING_UNSPECIFIED' | 'TIMING_NO_TIMING' | 'TIMING_ON_START' | 'TIMING_ON_SENT' | 'TIMING_ON_VERIFIED', enum
      - `gift_card` PbGiftCardCompensation
        - `gift_card` PbGiftCard
          - `amount` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `code` string
          - `created_at` string, date-time
        - `summary` PbCompensationSummary
          - `adjusted_commitment` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `adjustment_reason` string
          - `adjustments` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `executed` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `initial_commitment` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `timing` 'TIMING_UNSPECIFIED' | 'TIMING_NO_TIMING' | 'TIMING_ON_START' | 'TIMING_ON_SENT' | 'TIMING_ON_VERIFIED', enum
      - `original_payment_method` PbOriginalPaymentMethodCompensation
        - `bt_fallback_triggered` boolean
        - `refunds` PbOriginalPaymentMethodRefund[]
          - `amount` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `created_at` string, date-time
        - `summary` PbCompensationSummary
          - `adjusted_commitment` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `adjustment_reason` string
          - `adjustments` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `executed` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `initial_commitment` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `timing` 'TIMING_UNSPECIFIED' | 'TIMING_NO_TIMING' | 'TIMING_ON_START' | 'TIMING_ON_SENT' | 'TIMING_ON_VERIFIED', enum
      - `promocode` PbPromocodeCompensation
        - `amount` PbMoneyBag
          - `presentment_money` PbMoney
            - `amount` string, cents — Amount of the refund in cents
            - `currency_code` string, ISO 4217 currency codes — Currency of the refund
        - `promocode` PbPromocode
          - `amount` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `code` string
          - `created_at` string, date-time
        - `summary` PbCompensationSummary
          - `adjusted_commitment` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `adjustment_reason` string
          - `adjustments` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `executed` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `initial_commitment` PbMoneyBag
            - `presentment_money` PbMoney
              - …
          - `timing` 'TIMING_UNSPECIFIED' | 'TIMING_NO_TIMING' | 'TIMING_ON_START' | 'TIMING_ON_SENT' | 'TIMING_ON_VERIFIED', enum
    - `currency_code` string
    - `customer` PbReturnSummaryCustomer
      - `address` PbCustomerAddress
        - `address_line_1` string
        - `address_line_2` string
        - `city` string
        - `country_code` string
        - `phone` string
        - `postal_code` string
      - `email` string
      - `first_name` string
      - `last_name` string
      - `preferred_language` string — User preferred language
    - `exchange_timing` 'TIMING_UNSPECIFIED' | 'TIMING_NO_TIMING' | 'TIMING_ON_START' | 'TIMING_ON_SENT' | 'TIMING_ON_VERIFIED', enum
    - `extra_line_items` PbExtraLineItems
      - `extra_line_items` PbExtraLineItem[]
        - `total` PbMoneyBag
          - `presentment_money` PbMoney
            - `amount` string, cents — Amount of the refund in cents
            - `currency_code` string, ISO 4217 currency codes — Currency of the refund
        - `type` 'TYPE_UNSPECIFIED' | 'TYPE_RETURN_SHIPPING_COST' | 'TYPE_ORIGINAL_SHIPPING_REFUND' | 'TYPE_KEEP_YOUR_ITEM' | 'TYPE_RDV_SURPLUS' | 'TYPE_SERVICE_FEE' | 'TYPE_ORIGINAL_PROMOTION_BROKEN', enum
      - `total` PbMoneyBag
        - `presentment_money` PbMoney
          - `amount` string, cents — Amount of the refund in cents
          - `currency_code` string, ISO 4217 currency codes — Currency of the refund
    - `keep_your_item_type` 'KEEP_YOUR_ITEM_TYPE_UNSPECIFIED' | 'KEEP_YOUR_ITEM_TYPE_NONE' | 'KEEP_YOUR_ITEM_TYPE_WITHOUT_VALIDATION', enum
    - `open_exchange_items` PbOpenExchangeItems
      - `open_exchange_items` PbOpenExchangeItem[]
        - `product_name` string
        - `quantity` integer
        - `total` PbMoneyBag
          - `presentment_money` PbMoney
            - `amount` string, cents — Amount of the refund in cents
            - `currency_code` string, ISO 4217 currency codes — Currency of the refund
      - `total` PbMoneyBag
        - `presentment_money` PbMoney
          - `amount` string, cents — Amount of the refund in cents
          - `currency_code` string, ISO 4217 currency codes — Currency of the refund
    - `ordered_items` PbOrderedItems
      - `ordered_items` PbOrderedItem[]
        - `product_id` string
        - `product_name` string
        - `quantity` integer
        - `total` PbMoneyBag
          - `presentment_money` PbMoney
            - `amount` string, cents — Amount of the refund in cents
            - `currency_code` string, ISO 4217 currency codes — Currency of the refund
        - `variant_id` string
        - `variant_name` string
      - `total` PbMoneyBag
        - `presentment_money` PbMoney
          - `amount` string, cents — Amount of the refund in cents
          - `currency_code` string, ISO 4217 currency codes — Currency of the refund
    - `payments` PbReturnSummaryPayments
      - `commitment` PbMoneyBag
        - `presentment_money` PbMoney
          - `amount` string, cents — Amount of the refund in cents
          - `currency_code` string, ISO 4217 currency codes — Currency of the refund
      - `executed` PbMoneyBag
        - `presentment_money` PbMoney
          - `amount` string, cents — Amount of the refund in cents
          - `currency_code` string, ISO 4217 currency codes — Currency of the refund
    - `refund_payment_method` 'REFUND_PAYMENT_METHOD_UNSPECIFIED' | 'REFUND_PAYMENT_METHOD_NO_PAYMENT_METHOD' | 'REFUND_PAYMENT_METHOD_BANK_TRANSFER' | 'REFUND_PAYMENT_METHOD_ORIGINAL' | 'REFUND_PAYMENT_METHOD_PROMO_CODE' | 'REFUND_PAYMENT_METHOD_GIFT_CARD', enum — Payment method chosen by the user when creating the return process. Other payment methods can be added afterwards
    - `refund_timing` 'TIMING_UNSPECIFIED' | 'TIMING_NO_TIMING' | 'TIMING_ON_START' | 'TIMING_ON_SENT' | 'TIMING_ON_VERIFIED', enum — Refund timing committed to the user when creating the return process. If other payment methods are added afterwards, the timing for them can vary
    - `returned_items` PbReturnedItems
      - `returned_items` PbReturnedItem[]
        - `action` 'ACTION_UNSPECIFIED' | 'ACTION_REFUND' | 'ACTION_EXCHANGE', enum
        - `platform_line_item_id` string
        - `product_info` PbReturnedItemProductInfo
          - `image_url` string
          - `product_id` string
          - `product_name` string
          - `product_reference` string
          - `sku` string
          - `variant_ean` string
          - `variant_id` string
          - `variant_name` string
          - `variant_reference` string
        - `quantity` integer
        - `return_reason_key` string
        - `rever_id` string
        - `total` PbMoneyBag
          - `presentment_money` PbMoney
            - `amount` string, cents — Amount of the refund in cents
            - `currency_code` string, ISO 4217 currency codes — Currency of the refund
        - `unit_price` PbMoneyBag
          - `presentment_money` PbMoney
            - `amount` string, cents — Amount of the refund in cents
            - `currency_code` string, ISO 4217 currency codes — Currency of the refund
      - `total` PbMoneyBag
        - `presentment_money` PbMoney
          - `amount` string, cents — Amount of the refund in cents
          - `currency_code` string, ISO 4217 currency codes — Currency of the refund
    - `start_return_on_platform_time` string
    - `status` 'RETURN_PROCESS_STATUS_UNSPECIFIED' | 'RETURN_PROCESS_STATUS_STARTED' | 'RETURN_PROCESS_STATUS_COLLECTED' | 'RETURN_PROCESS_STATUS_REVIEW_REQUIRED' | 'RETURN_PROCESS_STATUS_COMPLETED' | 'RETURN_PROCESS_STATUS_CANCELED' | 'RETURN_PROCESS_STATUS_AUTHORIZATION_PENDING' | 'RETURN_PROCESS_STATUS_DOCUMENT_UPLOAD_PENDING' | 'RETURN_PROCESS_STATUS_NOT_AUTHORIZED', enum
    - `upload_documents_info` PbReturnSummaryUploadDocumentsInfo
      - `upload_documents_enabled` boolean
      - `uploaded_documents` PbUploadDocumentsInfoUploadedDocuments[]
        - `document_info` string
        - `document_url` string

---

[API](https://skmtc.net/itsrever/apis/rever-admin-api.md) · [All operations](https://skmtc.net/itsrever/apis/rever-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/itsrever/rever-admin-api/versions/290da8fa387e/schema)