Skip to main content

Documentation

Retrieve a Return

Retrieve the details of a return.

    • return

    • ID of the return. String starting with orre_.

Code Samples
    • .NET

      • using System;
        
        namespace RapydApiRequestSample
        {
            class Program
            {
                static void Main(string[] args)
                {
                    try
                    {
                        string order = "orre_0b22b74a9c5f6ea5307e9c8e044298d6";
        
                        string result = RapydApiRequestSample.Utilities.MakeRequest("GET", $"/v1/order_returns/{order}");
        
                        Console.WriteLine(result);
                    }
                    catch (Exception e)
                    {
                        Console.WriteLine("Error completing request: " + e.Message);
                    }
                }
            }
        }
    • JavaScript

      • const makeRequest = require('<path-to-your-utility-file>/utilities').makeRequest;
        
        async function main() {
          try {
            const result = await makeRequest(
              'GET',
              '/v1/order_returns/orre_0b22b74a9c5f6ea5307e9c8e044298d6'
            );
        
            console.log(result);
          } catch (error) {
            console.error('Error completing request', error);
          }
        }
    • PHP

      • <?php
        $path = $_SERVER['DOCUMENT_ROOT'];
        $path .= "/<path-to-your-utility-file>/utilities.php";
        
        include($path);
        
        try {
            $object = make_request('get', '/v1/order_returns/orre_0b22b74a9c5f6ea5307e9c8e044298d6');
            var_dump($object);
        } catch(Exception $e) {
            echo "Error: $e";
        }
        ?>
    • Python

      • from pprint import pprint
        
        from utilities import make_request
        
        result = make_request(method='get', path='/v1/order_returns/orre_0b22b74a9c5f6ea5307e9c8e044298d6')
        pprint(result)
  • /v1/order_returns/:order_return

  • Retrieve a Return

  • curl -X get
    https://sandboxapi.rapyd.net/v1/order_returns/orre_1bf55355a9334d702be0309e00e75ad4
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "5ff00715-658a-4887-b45d-5dd6f24d5d66"
        },
        "data": {
            "id": "orre_1bf55355a9334d702be0309e00e75ad4",
            "amount": 5,
            "created": 1597758667,
            "currency": "USD",
            "items": [
                {
                    "amount": 5,
                    "currency": "USD",
                    "description": 0,
                    "parent": "sku_7e7818cd3cb7c33c194bc278b5c51c88",
                    "quantity": 1,
                    "type": "sku"
                }
            ],
            "order": "order_ad4cea80c36e3469330c82c44a7b0362",
            "refund": "refund_2dbd966149fc1c92c273ef6e9ac0fb21"
        }
    }