Skip to main content
POST
/
stores
/
{storeId}
/
returns
/
bulk
Import Returns
curl --request POST \
  --url https://api.getredo.com/v2.2/stores/{storeId}/returns/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "returns": [
    {
      "products": [
        {
          "productId": "<string>",
          "quantity": 2,
          "sku": "<string>",
          "barcode": "<string>",
          "productTitle": "<string>",
          "variantTitle": "<string>",
          "reason": "<string>",
          "condition": "<string>"
        }
      ],
      "customer": {
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "jsmith@example.com"
      },
      "externalReferenceId": "<string>",
      "trackingNumber": "<string>",
      "carrier": "<string>",
      "notes": "<string>",
      "idempotencyKey": "<string>",
      "currency": "<string>"
    }
  ]
}
'
import requests

url = "https://api.getredo.com/v2.2/stores/{storeId}/returns/bulk"

payload = { "returns": [
        {
            "products": [
                {
                    "productId": "<string>",
                    "quantity": 2,
                    "sku": "<string>",
                    "barcode": "<string>",
                    "productTitle": "<string>",
                    "variantTitle": "<string>",
                    "reason": "<string>",
                    "condition": "<string>"
                }
            ],
            "customer": {
                "firstName": "<string>",
                "lastName": "<string>",
                "email": "jsmith@example.com"
            },
            "externalReferenceId": "<string>",
            "trackingNumber": "<string>",
            "carrier": "<string>",
            "notes": "<string>",
            "idempotencyKey": "<string>",
            "currency": "<string>"
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    returns: [
      {
        products: [
          {
            productId: '<string>',
            quantity: 2,
            sku: '<string>',
            barcode: '<string>',
            productTitle: '<string>',
            variantTitle: '<string>',
            reason: '<string>',
            condition: '<string>'
          }
        ],
        customer: {firstName: '<string>', lastName: '<string>', email: 'jsmith@example.com'},
        externalReferenceId: '<string>',
        trackingNumber: '<string>',
        carrier: '<string>',
        notes: '<string>',
        idempotencyKey: '<string>',
        currency: '<string>'
      }
    ]
  })
};

fetch('https://api.getredo.com/v2.2/stores/{storeId}/returns/bulk', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getredo.com/v2.2/stores/{storeId}/returns/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'returns' => [
        [
                'products' => [
                                [
                                                                'productId' => '<string>',
                                                                'quantity' => 2,
                                                                'sku' => '<string>',
                                                                'barcode' => '<string>',
                                                                'productTitle' => '<string>',
                                                                'variantTitle' => '<string>',
                                                                'reason' => '<string>',
                                                                'condition' => '<string>'
                                ]
                ],
                'customer' => [
                                'firstName' => '<string>',
                                'lastName' => '<string>',
                                'email' => 'jsmith@example.com'
                ],
                'externalReferenceId' => '<string>',
                'trackingNumber' => '<string>',
                'carrier' => '<string>',
                'notes' => '<string>',
                'idempotencyKey' => '<string>',
                'currency' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getredo.com/v2.2/stores/{storeId}/returns/bulk"

	payload := strings.NewReader("{\n  \"returns\": [\n    {\n      \"products\": [\n        {\n          \"productId\": \"<string>\",\n          \"quantity\": 2,\n          \"sku\": \"<string>\",\n          \"barcode\": \"<string>\",\n          \"productTitle\": \"<string>\",\n          \"variantTitle\": \"<string>\",\n          \"reason\": \"<string>\",\n          \"condition\": \"<string>\"\n        }\n      ],\n      \"customer\": {\n        \"firstName\": \"<string>\",\n        \"lastName\": \"<string>\",\n        \"email\": \"jsmith@example.com\"\n      },\n      \"externalReferenceId\": \"<string>\",\n      \"trackingNumber\": \"<string>\",\n      \"carrier\": \"<string>\",\n      \"notes\": \"<string>\",\n      \"idempotencyKey\": \"<string>\",\n      \"currency\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.getredo.com/v2.2/stores/{storeId}/returns/bulk")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"returns\": [\n    {\n      \"products\": [\n        {\n          \"productId\": \"<string>\",\n          \"quantity\": 2,\n          \"sku\": \"<string>\",\n          \"barcode\": \"<string>\",\n          \"productTitle\": \"<string>\",\n          \"variantTitle\": \"<string>\",\n          \"reason\": \"<string>\",\n          \"condition\": \"<string>\"\n        }\n      ],\n      \"customer\": {\n        \"firstName\": \"<string>\",\n        \"lastName\": \"<string>\",\n        \"email\": \"jsmith@example.com\"\n      },\n      \"externalReferenceId\": \"<string>\",\n      \"trackingNumber\": \"<string>\",\n      \"carrier\": \"<string>\",\n      \"notes\": \"<string>\",\n      \"idempotencyKey\": \"<string>\",\n      \"currency\": \"<string>\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.getredo.com/v2.2/stores/{storeId}/returns/bulk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"returns\": [\n    {\n      \"products\": [\n        {\n          \"productId\": \"<string>\",\n          \"quantity\": 2,\n          \"sku\": \"<string>\",\n          \"barcode\": \"<string>\",\n          \"productTitle\": \"<string>\",\n          \"variantTitle\": \"<string>\",\n          \"reason\": \"<string>\",\n          \"condition\": \"<string>\"\n        }\n      ],\n      \"customer\": {\n        \"firstName\": \"<string>\",\n        \"lastName\": \"<string>\",\n        \"email\": \"jsmith@example.com\"\n      },\n      \"externalReferenceId\": \"<string>\",\n      \"trackingNumber\": \"<string>\",\n      \"carrier\": \"<string>\",\n      \"notes\": \"<string>\",\n      \"idempotencyKey\": \"<string>\",\n      \"currency\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "totalCount": 123,
  "processedCount": 123,
  "errorCount": 123,
  "results": [
    {
      "status": "created",
      "index": 123,
      "returnId": "<string>"
    }
  ]
}
{
  "detail": "<string>",
  "instance": "<string>",
  "title": "<string>",
  "type": "about:blank"
}
{
  "detail": "<string>",
  "instance": "<string>",
  "title": "<string>",
  "type": "about:blank"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
storeId
string
required

Store ID

Example:

"64e5a8a1af49a89df37e4ee7"

Body

application/json

Import returns request body.

​
returns
object[]
required

Array of returns to import (max 100).

Required array length: 1 - 100 elements

Response

Batch processed. Check individual results for per-item status. Some items may have succeeded while others failed.

Bulk external return creation response.

​
totalCount
integer
required

Total number of returns in the request.

​
processedCount
integer
required

Number of returns successfully created.

​
errorCount
integer
required

Number of returns that failed.

​
results
object[]
required

Per-item results in the same order as the request.