Create Return

Create a return for specific order line items.

POST /stores/{storeId}/returns

Create Return

cURL

curl --request POST \
  --url https://api.getredo.com/v2.2/stores/{storeId}/returns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "provider": "<string>",
    "externalOrderId": "<string>",
    "items": [
      {
        "lineItemId": "<string>",
        "quantity": 2,
        "reason": "<string>",
        "reasonCode": "<string>",
        "notes": "<string>"
      }
    ],
    "shippingAddress": {
      "line1": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postalCode": "<string>",
      "country": "<string>",
      "line2": "<string>"
    },
    "notes": "<string>"
  },
  "options": {
    "createExternalRMAs": false
  }
}
'

import requests

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

payload = {
    "data": {
        "provider": "<string>",
        "externalOrderId": "<string>",
        "items": [
            {
                "lineItemId": "<string>",
                "quantity": 2,
                "reason": "<string>",
                "reasonCode": "<string>",
                "notes": "<string>"
            }
        ],
        "shippingAddress": {
            "line1": "<string>",
            "city": "<string>",
            "state": "<string>",
            "postalCode": "<string>",
            "country": "<string>",
            "line2": "<string>"
        },
        "notes": "<string>"
    },
    "options": { "createExternalRMAs": False }
}
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({
    data: {
      provider: '<string>',
      externalOrderId: '<string>',
      items: [
        {
          lineItemId: '<string>',
          quantity: 2,
          reason: '<string>',
          reasonCode: '<string>',
          notes: '<string>'
        }
      ],
      shippingAddress: {
        line1: '<string>',
        city: '<string>',
        state: '<string>',
        postalCode: '<string>',
        country: '<string>',
        line2: '<string>'
      },
      notes: '<string>'
    },
    options: {createExternalRMAs: false}
  })
};

fetch('https://api.getredo.com/v2.2/stores/{storeId}/returns', 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",
  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([
    'data' => [
        'provider' => '<string>',
        'externalOrderId' => '<string>',
        'items' => [
                [
                                'lineItemId' => '<string>',
                                'quantity' => 2,
                                'reason' => '<string>',
                                'reasonCode' => '<string>',
                                'notes' => '<string>'
                ]
        ],
        'shippingAddress' => [
                'line1' => '<string>',
                'city' => '<string>',
                'state' => '<string>',
                'postalCode' => '<string>',
                'country' => '<string>',
                'line2' => '<string>'
        ],
        'notes' => '<string>'
    ],
    'options' => [
        'createExternalRMAs' => false
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"data\": {\n    \"provider\": \"<string>\",\n    \"externalOrderId\": \"<string>\",\n    \"items\": [\n      {\n        \"lineItemId\": \"<string>\",\n        \"quantity\": 2,\n        \"reason\": \"<string>\",\n        \"reasonCode\": \"<string>\",\n        \"notes\": \"<string>\"\n      }\n    ],\n    \"shippingAddress\": {\n      \"line1\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"country\": \"<string>\",\n      \"line2\": \"<string>\"\n    },\n    \"notes\": \"<string>\"\n  },\n  \"options\": {\n    \"createExternalRMAs\": false\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"provider\": \"<string>\",\n    \"externalOrderId\": \"<string>\",\n    \"items\": [\n      {\n        \"lineItemId\": \"<string>\",\n        \"quantity\": 2,\n        \"reason\": \"<string>\",\n        \"reasonCode\": \"<string>\",\n        \"notes\": \"<string>\"\n      }\n    ],\n    \"shippingAddress\": {\n      \"line1\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"country\": \"<string>\",\n      \"line2\": \"<string>\"\n    },\n    \"notes\": \"<string>\"\n  },\n  \"options\": {\n    \"createExternalRMAs\": false\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"data\": {\n    \"provider\": \"<string>\",\n    \"externalOrderId\": \"<string>\",\n    \"items\": [\n      {\n        \"lineItemId\": \"<string>\",\n        \"quantity\": 2,\n        \"reason\": \"<string>\",\n        \"reasonCode\": \"<string>\",\n        \"notes\": \"<string>\"\n      }\n    ],\n    \"shippingAddress\": {\n      \"line1\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"postalCode\": \"<string>\",\n      \"country\": \"<string>\",\n      \"line2\": \"<string>\"\n    },\n    \"notes\": \"<string>\"\n  },\n  \"options\": {\n    \"createExternalRMAs\": false\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "return": {
    "createdAt": "2023-11-07T05:31:56Z",
    "destination": {
      "mailingAddress": {
        "city": "<string>",
        "country": "<string>",
        "line1": "<string>",
        "postalCode": "<string>",
        "state": "<string>",
        "line2": ""
      },
      "phoneNumber": "<string>"
    },
    "giftCards": [
      {
        "amount": {
          "amount": "<string>",
          "currency": "<string>"
        },
        "code": "<string>",
        "externalId": "<string>"
      }
    ],
    "id": "<string>",
    "items": [
      {
        "id": "<string>",
        "orderItem": {
          "id": "<string>",
          "line_item_id": "<string>"
        },
        "quantity": 123,
        "reason": "<string>",
        "customerComment": "<string>",
        "exchangeItem": {
          "product": {
            "externalId": "<string>",
            "name": "<string>"
          },
          "quantity": 123,
          "variant": {
            "externalId": "<string>",
            "name": "<string>"
          }
        },
        "grade": "<string>",
        "greenReturn": true,
        "outcome": "<string>",
        "shipmentGroupIds": [
          "<string>"
        ],
        "externalIdentifier": "<string>",
        "externalReturnLineItemId": "<string>",
        "productId": "<string>",
        "reasonCode": "<string>",
        "reasons": [
          "<string>"
        ],
        "reasonCodes": [
          "<string>"
        ],
        "productAdjustment": "<string>",
        "multipleChoiceQuestions": [
          {
            "question": "<string>",
            "answer": "<string>"
          }
        ],
        "assessments": [
          {
            "assignedUser": {
              "id": "<string>",
              "name": "<string>",
              "firstName": "<string>",
              "lastName": "<string>",
              "email": "<string>"
            },
            "responses": [
              {
                "type": "<string>",
                "value": "<string>"
              }
            ]
          }
        ],
        "refund": {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          },
          "type": "<string>"
        },
        "productValueNoTaxNoAdjustment": {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          }
        },
        "sku": "<string>",
        "upc": "<string>",
        "status": "<string>",
        "variantId": "<string>"
      }
    ],
    "order": {
      "id": "64e4da943dd822979a70bd12",
      "name": "<string>"
    },
    "source": {
      "emailAddress": "[e-mail]",
      "mailingAddress": {
        "city": "<string>",
        "country": "<string>",
        "line1": "<string>",
        "postalCode": "<string>",
        "state": "<string>",
        "line2": ""
      },
      "name": {
        "given": "<string>",
        "surname": "<string>"
      },
      "phoneNumber": "<string>"
    },
    "status": "open",
    "updatedAt": "2023-11-07T05:31:56Z",
    "compensationMethods": [],
    "completeWithNoAction": true,
    "exchange": {
      "items": [
        {
          "id": "<string>",
          "quantity": 1,
          "variant": {
            "name": "<string>",
            "externalId": "<string>",
            "sku": "<string>",
            "weight": {
              "kg": 1
            }
          },
          "originalPrice": {
            "amount": "<string>",
            "currency": "<string>"
          },
          "price": {
            "amount": "<string>",
            "currency": "<string>",
            "tax": "<string>"
          },
          "product": {
            "name": "<string>",
            "externalId": "<string>"
          }
        }
      ],
      "provision": "deferred",
      "itemCount": 123,
      "order": {
        "externalId": "<string>"
      },
      "totalTax": {
        "amount": "<string>",
        "currency": "<string>"
      }
    },
    "externalOrderIds": [
      "<string>"
    ],
    "internalCreatedByName": "<string>",
    "notes": [
      {
        "message": "<string>",
        "image": "<string>"
      }
    ],
    "shipment": {
      "carrier": "<string>",
      "tracker": "<string>",
      "trackingUrl": "<string>",
      "postageLabel": "<string>",
      "formLabel": "<string>",
      "shipmentGroupId": "<string>",
      "itemIds": [
        "<string>"
      ],
      "externalLocationId": "<string>",
      "estimatedDeliveryDate": "<string>",
      "deliveredAt": "<string>"
    },
    "shipments": [
      {
        "carrier": "<string>",
        "tracker": "<string>",
        "trackingUrl": "<string>",
        "postageLabel": "<string>",
        "formLabel": "<string>",
        "shipmentGroupId": "<string>",
        "itemIds": [
          "<string>"
        ],
        "externalLocationId": "<string>",
        "estimatedDeliveryDate": "<string>",
        "deliveredAt": "<string>"
      }
    ],
    "dropoffs": [
      {
        "shipmentGroupId": "<string>",
        "provider": "<string>",
        "qrCode": "<string>",
        "qrCodeUrl": "<string>"
      }
    ],
    "shopifyOrderIds": [
      "<string>"
    ],
    "tags": [
      {
        "name": "<string>",
        "source": "<string>"
      }
    ],
    "totals": {
      "charge": {
        "amount": {
          "amount": "<string>",
          "currency": "<string>"
        }
      },
      "exchange": {
        "amount": {
          "amount": "<string>",
          "currency": "<string>"
        }
      },
      "refund": {
        "amount": {
          "amount": "<string>",
          "currency": "<string>"
        }
      },
      "storeCredit": {
        "amount": {
          "amount": "<string>",
          "currency": "<string>"
        }
      }
    },
    "type": "return"
  },
  "externalRMAResponses": [
    {
      "integrationProvider": "<string>",
      "success": true,
      "errorCode": "<string>",
      "errorMessage": "<string>"
    }
  ]
}

{
  "return": {
    "createdAt": "2023-11-07T05:31:56Z",
    "destination": {
      "mailingAddress": {
        "city": "<string>",
        "country": "<string>",
        "line1": "<string>",
        "postalCode": "<string>",
        "state": "<string>",
        "line2": ""
      },
      "phoneNumber": "<string>"
    },
    "giftCards": [
      {
        "amount": {
          "amount": "<string>",
          "currency": "<string>"
        },
        "code": "<string>",
        "externalId": "<string>"
      }
    ],
    "id": "<string>",
    "items": [
      {
        "id": "<string>",
        "orderItem": {
          "id": "<string>",
          "line_item_id": "<string>"
        },
        "quantity": 123,
        "reason": "<string>",
        "customerComment": "<string>",
        "exchangeItem": {
          "product": {
            "externalId": "<string>",
            "name": "<string>"
          },
          "quantity": 123,
          "variant": {
            "externalId": "<string>",
            "name": "<string>"
          }
        },
        "grade": "<string>",
        "greenReturn": true,
        "outcome": "<string>",
        "shipmentGroupIds": [
          "<string>"
        ],
        "externalIdentifier": "<string>",
        "externalReturnLineItemId": "<string>",
        "productId": "<string>",
        "reasonCode": "<string>",
        "reasons": [
          "<string>"
        ],
        "reasonCodes": [
          "<string>"
        ],
        "productAdjustment": "<string>",
        "multipleChoiceQuestions": [
          {
            "question": "<string>",
            "answer": "<string>"
          }
        ],
        "assessments": [
          {
            "assignedUser": {
              "id": "<string>",
              "name": "<string>",
              "firstName": "<string>",
              "lastName": "<string>",
              "email": "<string>"
            },
            "responses": [
              {
                "type": "<string>",
                "value": "<string>"
              }
            ]
          }
        ],
        "refund": {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          },
          "type": "<string>"
        },
        "productValueNoTaxNoAdjustment": {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          }
        },
        "sku": "<string>",
        "upc": "<string>",
        "status": "<string>",
        "variantId": "<string>"
      }
    ],
    "order": {
      "id": "64e4da943dd822979a70bd12",
      "name": "<string>"
    },
    "source": {
      "emailAddress": "[e-mail]",
      "mailingAddress": {
        "city": "<string>",
        "country": "<string>",
        "line1": "<string>",
        "postalCode": "<string>",
        "state": "<string>",
        "line2": ""
      },
      "name": {
        "given": "<string>",
        "surname": "<string>"
      },
      "phoneNumber": "<string>"
    },
    "status": "open",
    "updatedAt": "2023-11-07T05:31:56Z",
    "compensationMethods": [],
    "completeWithNoAction": true,
    "exchange": {
      "items": [
        {
          "id": "<string>",
          "quantity": 1,
          "variant": {
            "name": "<string>",
            "externalId": "<string>",
            "sku": "<string>",
            "weight": {
              "kg": 1
            }
          },
          "originalPrice": {
            "amount": "<string>",
            "currency": "<string>"
          },
          "price": {
            "amount": "<string>",
            "currency": "<string>",
            "tax": "<string>"
          },
          "product": {
            "name": "<string>",
            "externalId": "<string>"
          }
        }
      ],
      "provision": "deferred",
      "itemCount": 123,
      "order": {
        "externalId": "<string>"
      },
      "totalTax": {
        "amount": "<string>",
        "currency": "<string>"
      }
    },
    "externalOrderIds": [
      "<string>"
    ],
    "internalCreatedByName": "<string>",
    "notes": [
      {
        "message": "<string>",
        "image": "<string>"
      }
    ],
    "shipment": {
      "carrier": "<string>",
      "tracker": "<string>",
      "trackingUrl": "<string>",
      "postageLabel": "<string>",
      "formLabel": "<string>",
      "shipmentGroupId": "<string>",
      "itemIds": [
        "<string>"
      ],
      "externalLocationId": "<string>",
      "estimatedDeliveryDate": "<string>",
      "deliveredAt": "<string>"
    },
    "shipments": [
      {
        "carrier": "<string>",
        "tracker": "<string>",
        "trackingUrl": "<string>",
        "postageLabel": "<string>",
        "formLabel": "<string>",
        "shipmentGroupId": "<string>",
        "itemIds": [
          "<string>"
        ],
        "externalLocationId": "<string>",
        "estimatedDeliveryDate": "<string>",
        "deliveredAt": "<string>"
      }
    ],
    "dropoffs": [
      {
        "shipmentGroupId": "<string>",
        "provider": "<string>",
        "qrCode": "<string>",
        "qrCodeUrl": "<string>"
      }
    ],
    "shopifyOrderIds": [
      "<string>"
    ],
    "tags": [
      {
        "name": "<string>",
        "source": "<string>"
      }
    ],
    "totals": {
      "charge": {
        "amount": {
          "amount": "<string>",
          "currency": "<string>"
        }
      },
      "exchange": {
        "amount": {
          "amount": "<string>",
          "currency": "<string>"
        }
      },
      "refund": {
        "amount": {
          "amount": "<string>",
          "currency": "<string>"
        }
      },
      "storeCredit": {
        "amount": {
          "amount": "<string>",
          "currency": "<string>"
        }
      }
    },
    "type": "return"
  },
  "externalRMAResponses": [
    {
      "integrationProvider": "<string>",
      "success": true,
      "errorCode": "<string>",
      "errorMessage": "<string>"
    }
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "title": "<string>",
  "type": "about:blank"
}

{
  "detail": "<string>",
  "instance": "<string>",
  "title": "<string>",
  "type": "about:blank"
}

{
  "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.

Headers

Idempotency-Key · string

Optional idempotency key for safely retrying create requests.

Path Parameters

storeId · string · required

Store ID

Example:

"64e5a8a1af49a89df37e4ee7"

Body

application/json

Create return request body.

data · object · required

Return information payload.

Show child attributes

options · object

Options controlling side effects of the return creation.

Show child attributes

Response

200

application/json

Success (idempotent replay; existing return returned)

Create return response body.

return · Return · object · required

Return read.

Show child attributes

externalRMAResponses · object[] · required

Show child attributes