Sync Custom Order
curl --request POST \
--url https://api.getredo.com/v2.2/stores/{storeId}/custom/orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"type": "order",
"createdAt": "<string>",
"presentmentCurrency": "<string>",
"shopCurrency": "<string>",
"customer": {
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"id": "<string>",
"tags": []
},
"lineItems": [
{
"id": "<string>",
"quantity": 123,
"priceSet": {
"presentmentMoney": {
"amount": "<string>",
"currencyCode": "<string>"
},
"shopMoney": {
"amount": "<string>",
"currencyCode": "<string>"
}
},
"title": "<string>",
"productId": "<string>",
"sku": "<string>",
"returnableQuantity": 123,
"variantTitle": "<string>",
"vendor": "<string>",
"fulfillmentService": "<string>",
"variantId": "<string>",
"additionalProductId": "<string>",
"properties": [],
"tags": [],
"weight": {
"value": 123,
"unit": "<string>"
},
"image": "<string>",
"images": [],
"discounts": [],
"taxLines": []
}
],
"orderDiscounts": [
{
"amountSet": {
"presentmentMoney": {
"amount": "<string>",
"currencyCode": "<string>"
},
"shopMoney": {
"amount": "<string>",
"currencyCode": "<string>"
}
},
"discountId": "<string>",
"discountTitle": "<string>",
"discountCode": "<string>"
}
],
"shippingLines": [
{
"id": "<string>",
"title": "<string>",
"priceSet": {
"presentmentMoney": {
"amount": "<string>",
"currencyCode": "<string>"
},
"shopMoney": {
"amount": "<string>",
"currencyCode": "<string>"
}
},
"code": "<string>",
"discounts": [],
"taxLines": []
}
],
"fulfillments": [
{
"id": "<string>",
"lineItems": [
{
"id": "<string>",
"quantity": 123
}
],
"trackingNumbers": [],
"trackingUrls": [],
"shippingDate": "<string>",
"deliveryDate": "<string>"
}
],
"shippingAddress": {
"address1": "<string>",
"city": "<string>",
"provinceCode": "<string>",
"zip": "<string>",
"countryCode": "<string>",
"address2": "<string>",
"company": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>"
},
"updatedAt": "<string>",
"billingAddress": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"company": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"provinceCode": "<string>",
"zip": "<string>",
"countryCode": "<string>",
"phone": "<string>"
},
"salesChannel": "<string>",
"tags": [],
"transactions": []
}
'import requests
url = "https://api.getredo.com/v2.2/stores/{storeId}/custom/orders"
payload = {
"id": "<string>",
"type": "order",
"createdAt": "<string>",
"presentmentCurrency": "<string>",
"shopCurrency": "<string>",
"customer": {
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"id": "<string>",
"tags": []
},
"lineItems": [
{
"id": "<string>",
"quantity": 123,
"priceSet": {
"presentmentMoney": {
"amount": "<string>",
"currencyCode": "<string>"
},
"shopMoney": {
"amount": "<string>",
"currencyCode": "<string>"
}
},
"title": "<string>",
"productId": "<string>",
"sku": "<string>",
"returnableQuantity": 123,
"variantTitle": "<string>",
"vendor": "<string>",
"fulfillmentService": "<string>",
"variantId": "<string>",
"additionalProductId": "<string>",
"properties": [],
"tags": [],
"weight": {
"value": 123,
"unit": "<string>"
},
"image": "<string>",
"images": [],
"discounts": [],
"taxLines": []
}
],
"orderDiscounts": [
{
"amountSet": {
"presentmentMoney": {
"amount": "<string>",
"currencyCode": "<string>"
},
"shopMoney": {
"amount": "<string>",
"currencyCode": "<string>"
}
},
"discountId": "<string>",
"discountTitle": "<string>",
"discountCode": "<string>"
}
],
"shippingLines": [
{
"id": "<string>",
"title": "<string>",
"priceSet": {
"presentmentMoney": {
"amount": "<string>",
"currencyCode": "<string>"
},
"shopMoney": {
"amount": "<string>",
"currencyCode": "<string>"
}
},
"code": "<string>",
"discounts": [],
"taxLines": []
}
],
"fulfillments": [
{
"id": "<string>",
"lineItems": [
{
"id": "<string>",
"quantity": 123
}
],
"trackingNumbers": [],
"trackingUrls": [],
"shippingDate": "<string>",
"deliveryDate": "<string>"
}
],
"shippingAddress": {
"address1": "<string>",
"city": "<string>",
"provinceCode": "<string>",
"zip": "<string>",
"countryCode": "<string>",
"address2": "<string>",
"company": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>"
},
"updatedAt": "<string>",
"billingAddress": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"company": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"provinceCode": "<string>",
"zip": "<string>",
"countryCode": "<string>",
"phone": "<string>"
},
"salesChannel": "<string>",
"tags": [],
"transactions": []
}
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({
id: '<string>',
type: 'order',
createdAt: '<string>',
presentmentCurrency: '<string>',
shopCurrency: '<string>',
customer: {
email: 'jsmith@example.com',
firstName: '<string>',
lastName: '<string>',
phone: '<string>',
id: '<string>',
tags: []
},
lineItems: [
{
id: '<string>',
quantity: 123,
priceSet: {
presentmentMoney: {amount: '<string>', currencyCode: '<string>'},
shopMoney: {amount: '<string>', currencyCode: '<string>'}
},
title: '<string>',
productId: '<string>',
sku: '<string>',
returnableQuantity: 123,
variantTitle: '<string>',
vendor: '<string>',
fulfillmentService: '<string>',
variantId: '<string>',
additionalProductId: '<string>',
properties: [],
tags: [],
weight: {value: 123, unit: '<string>'},
image: '<string>',
images: [],
discounts: [],
taxLines: []
}
],
orderDiscounts: [
{
amountSet: {
presentmentMoney: {amount: '<string>', currencyCode: '<string>'},
shopMoney: {amount: '<string>', currencyCode: '<string>'}
},
discountId: '<string>',
discountTitle: '<string>',
discountCode: '<string>'
}
],
shippingLines: [
{
id: '<string>',
title: '<string>',
priceSet: {
presentmentMoney: {amount: '<string>', currencyCode: '<string>'},
shopMoney: {amount: '<string>', currencyCode: '<string>'}
},
code: '<string>',
discounts: [],
taxLines: []
}
],
fulfillments: [
{
id: '<string>',
lineItems: [{id: '<string>', quantity: 123}],
trackingNumbers: [],
trackingUrls: [],
shippingDate: '<string>',
deliveryDate: '<string>'
}
],
shippingAddress: {
address1: '<string>',
city: '<string>',
provinceCode: '<string>',
zip: '<string>',
countryCode: '<string>',
address2: '<string>',
company: '<string>',
firstName: '<string>',
lastName: '<string>',
phone: '<string>'
},
updatedAt: '<string>',
billingAddress: {
address1: '<string>',
address2: '<string>',
city: '<string>',
company: '<string>',
firstName: '<string>',
lastName: '<string>',
provinceCode: '<string>',
zip: '<string>',
countryCode: '<string>',
phone: '<string>'
},
salesChannel: '<string>',
tags: [],
transactions: []
})
};
fetch('https://api.getredo.com/v2.2/stores/{storeId}/custom/orders', 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}/custom/orders",
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([
'id' => '<string>',
'type' => 'order',
'createdAt' => '<string>',
'presentmentCurrency' => '<string>',
'shopCurrency' => '<string>',
'customer' => [
'email' => 'jsmith@example.com',
'firstName' => '<string>',
'lastName' => '<string>',
'phone' => '<string>',
'id' => '<string>',
'tags' => [
]
],
'lineItems' => [
[
'id' => '<string>',
'quantity' => 123,
'priceSet' => [
'presentmentMoney' => [
'amount' => '<string>',
'currencyCode' => '<string>'
],
'shopMoney' => [
'amount' => '<string>',
'currencyCode' => '<string>'
]
],
'title' => '<string>',
'productId' => '<string>',
'sku' => '<string>',
'returnableQuantity' => 123,
'variantTitle' => '<string>',
'vendor' => '<string>',
'fulfillmentService' => '<string>',
'variantId' => '<string>',
'additionalProductId' => '<string>',
'properties' => [
],
'tags' => [
],
'weight' => [
'value' => 123,
'unit' => '<string>'
],
'image' => '<string>',
'images' => [
],
'discounts' => [
],
'taxLines' => [
]
]
],
'orderDiscounts' => [
[
'amountSet' => [
'presentmentMoney' => [
'amount' => '<string>',
'currencyCode' => '<string>'
],
'shopMoney' => [
'amount' => '<string>',
'currencyCode' => '<string>'
]
],
'discountId' => '<string>',
'discountTitle' => '<string>',
'discountCode' => '<string>'
]
],
'shippingLines' => [
[
'id' => '<string>',
'title' => '<string>',
'priceSet' => [
'presentmentMoney' => [
'amount' => '<string>',
'currencyCode' => '<string>'
],
'shopMoney' => [
'amount' => '<string>',
'currencyCode' => '<string>'
]
],
'code' => '<string>',
'discounts' => [
],
'taxLines' => [
]
]
],
'fulfillments' => [
[
'id' => '<string>',
'lineItems' => [
[
'id' => '<string>',
'quantity' => 123
]
],
'trackingNumbers' => [
],
'trackingUrls' => [
],
'shippingDate' => '<string>',
'deliveryDate' => '<string>'
]
],
'shippingAddress' => [
'address1' => '<string>',
'city' => '<string>',
'provinceCode' => '<string>',
'zip' => '<string>',
'countryCode' => '<string>',
'address2' => '<string>',
'company' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'phone' => '<string>'
],
'updatedAt' => '<string>',
'billingAddress' => [
'address1' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'company' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'provinceCode' => '<string>',
'zip' => '<string>',
'countryCode' => '<string>',
'phone' => '<string>'
],
'salesChannel' => '<string>',
'tags' => [
],
'transactions' => [
]
]),
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}/custom/orders"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"type\": \"order\",\n \"createdAt\": \"<string>\",\n \"presentmentCurrency\": \"<string>\",\n \"shopCurrency\": \"<string>\",\n \"customer\": {\n \"email\": \"jsmith@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"id\": \"<string>\",\n \"tags\": []\n },\n \"lineItems\": [\n {\n \"id\": \"<string>\",\n \"quantity\": 123,\n \"priceSet\": {\n \"presentmentMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n },\n \"shopMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n }\n },\n \"title\": \"<string>\",\n \"productId\": \"<string>\",\n \"sku\": \"<string>\",\n \"returnableQuantity\": 123,\n \"variantTitle\": \"<string>\",\n \"vendor\": \"<string>\",\n \"fulfillmentService\": \"<string>\",\n \"variantId\": \"<string>\",\n \"additionalProductId\": \"<string>\",\n \"properties\": [],\n \"tags\": [],\n \"weight\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"image\": \"<string>\",\n \"images\": [],\n \"discounts\": [],\n \"taxLines\": []\n }\n ],\n \"orderDiscounts\": [\n {\n \"amountSet\": {\n \"presentmentMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n },\n \"shopMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n }\n },\n \"discountId\": \"<string>\",\n \"discountTitle\": \"<string>\",\n \"discountCode\": \"<string>\"\n }\n ],\n \"shippingLines\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"priceSet\": {\n \"presentmentMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n },\n \"shopMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n }\n },\n \"code\": \"<string>\",\n \"discounts\": [],\n \"taxLines\": []\n }\n ],\n \"fulfillments\": [\n {\n \"id\": \"<string>\",\n \"lineItems\": [\n {\n \"id\": \"<string>\",\n \"quantity\": 123\n }\n ],\n \"trackingNumbers\": [],\n \"trackingUrls\": [],\n \"shippingDate\": \"<string>\",\n \"deliveryDate\": \"<string>\"\n }\n ],\n \"shippingAddress\": {\n \"address1\": \"<string>\",\n \"city\": \"<string>\",\n \"provinceCode\": \"<string>\",\n \"zip\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"address2\": \"<string>\",\n \"company\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"updatedAt\": \"<string>\",\n \"billingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"company\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"provinceCode\": \"<string>\",\n \"zip\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"salesChannel\": \"<string>\",\n \"tags\": [],\n \"transactions\": []\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}/custom/orders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"type\": \"order\",\n \"createdAt\": \"<string>\",\n \"presentmentCurrency\": \"<string>\",\n \"shopCurrency\": \"<string>\",\n \"customer\": {\n \"email\": \"jsmith@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"id\": \"<string>\",\n \"tags\": []\n },\n \"lineItems\": [\n {\n \"id\": \"<string>\",\n \"quantity\": 123,\n \"priceSet\": {\n \"presentmentMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n },\n \"shopMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n }\n },\n \"title\": \"<string>\",\n \"productId\": \"<string>\",\n \"sku\": \"<string>\",\n \"returnableQuantity\": 123,\n \"variantTitle\": \"<string>\",\n \"vendor\": \"<string>\",\n \"fulfillmentService\": \"<string>\",\n \"variantId\": \"<string>\",\n \"additionalProductId\": \"<string>\",\n \"properties\": [],\n \"tags\": [],\n \"weight\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"image\": \"<string>\",\n \"images\": [],\n \"discounts\": [],\n \"taxLines\": []\n }\n ],\n \"orderDiscounts\": [\n {\n \"amountSet\": {\n \"presentmentMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n },\n \"shopMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n }\n },\n \"discountId\": \"<string>\",\n \"discountTitle\": \"<string>\",\n \"discountCode\": \"<string>\"\n }\n ],\n \"shippingLines\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"priceSet\": {\n \"presentmentMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n },\n \"shopMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n }\n },\n \"code\": \"<string>\",\n \"discounts\": [],\n \"taxLines\": []\n }\n ],\n \"fulfillments\": [\n {\n \"id\": \"<string>\",\n \"lineItems\": [\n {\n \"id\": \"<string>\",\n \"quantity\": 123\n }\n ],\n \"trackingNumbers\": [],\n \"trackingUrls\": [],\n \"shippingDate\": \"<string>\",\n \"deliveryDate\": \"<string>\"\n }\n ],\n \"shippingAddress\": {\n \"address1\": \"<string>\",\n \"city\": \"<string>\",\n \"provinceCode\": \"<string>\",\n \"zip\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"address2\": \"<string>\",\n \"company\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"updatedAt\": \"<string>\",\n \"billingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"company\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"provinceCode\": \"<string>\",\n \"zip\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"salesChannel\": \"<string>\",\n \"tags\": [],\n \"transactions\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getredo.com/v2.2/stores/{storeId}/custom/orders")
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 \"id\": \"<string>\",\n \"type\": \"order\",\n \"createdAt\": \"<string>\",\n \"presentmentCurrency\": \"<string>\",\n \"shopCurrency\": \"<string>\",\n \"customer\": {\n \"email\": \"jsmith@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"id\": \"<string>\",\n \"tags\": []\n },\n \"lineItems\": [\n {\n \"id\": \"<string>\",\n \"quantity\": 123,\n \"priceSet\": {\n \"presentmentMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n },\n \"shopMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n }\n },\n \"title\": \"<string>\",\n \"productId\": \"<string>\",\n \"sku\": \"<string>\",\n \"returnableQuantity\": 123,\n \"variantTitle\": \"<string>\",\n \"vendor\": \"<string>\",\n \"fulfillmentService\": \"<string>\",\n \"variantId\": \"<string>\",\n \"additionalProductId\": \"<string>\",\n \"properties\": [],\n \"tags\": [],\n \"weight\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"image\": \"<string>\",\n \"images\": [],\n \"discounts\": [],\n \"taxLines\": []\n }\n ],\n \"orderDiscounts\": [\n {\n \"amountSet\": {\n \"presentmentMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n },\n \"shopMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n }\n },\n \"discountId\": \"<string>\",\n \"discountTitle\": \"<string>\",\n \"discountCode\": \"<string>\"\n }\n ],\n \"shippingLines\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"priceSet\": {\n \"presentmentMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n },\n \"shopMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n }\n },\n \"code\": \"<string>\",\n \"discounts\": [],\n \"taxLines\": []\n }\n ],\n \"fulfillments\": [\n {\n \"id\": \"<string>\",\n \"lineItems\": [\n {\n \"id\": \"<string>\",\n \"quantity\": 123\n }\n ],\n \"trackingNumbers\": [],\n \"trackingUrls\": [],\n \"shippingDate\": \"<string>\",\n \"deliveryDate\": \"<string>\"\n }\n ],\n \"shippingAddress\": {\n \"address1\": \"<string>\",\n \"city\": \"<string>\",\n \"provinceCode\": \"<string>\",\n \"zip\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"address2\": \"<string>\",\n \"company\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"updatedAt\": \"<string>\",\n \"billingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"company\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"provinceCode\": \"<string>\",\n \"zip\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"salesChannel\": \"<string>\",\n \"tags\": [],\n \"transactions\": []\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"orderId": "<string>",
"redoId": "<string>"
}{
"error": "<string>",
"errors": {}
}{
"error": "<string>",
"errors": {}
}{
"detail": "<string>",
"instance": "<string>",
"title": "<string>",
"type": "about:blank"
}{
"detail": "<string>",
"instance": "<string>",
"title": "<string>",
"type": "about:blank"
}{
"error": "<string>",
"errors": {}
}{
"detail": "<string>",
"instance": "<string>",
"title": "<string>",
"type": "about:blank"
}Returns Custom Integration
Sync Custom Order
Sync an order to Redo so your shoppers can return it.
This is the returns integration path for commerce platforms Redo does not support directly. Orders pushed here become returnable: the shopper can look up the order in the return portal, and Redo uses the line items, discounts, and taxes you send to decide what is eligible for return and what to refund.
Syncing the same order ID again updates the existing Redo order, so this is safe to call on every order create and update.
For a walkthrough of the full integration, including field-by-field mapping and a complete example payload, see the Custom Returns Integration guide.
Important: If Redo protection is attached to this order, include a line item with:
- vendor: “re:do”
- sku: “x-redo”
- tags: “returns”, “package protection”, or “both”
- properties: _redo_type with value “return”, “package protection”, or “both”
POST
/
stores
/
{storeId}
/
custom
/
orders
Sync Custom Order
curl --request POST \
--url https://api.getredo.com/v2.2/stores/{storeId}/custom/orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"type": "order",
"createdAt": "<string>",
"presentmentCurrency": "<string>",
"shopCurrency": "<string>",
"customer": {
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"id": "<string>",
"tags": []
},
"lineItems": [
{
"id": "<string>",
"quantity": 123,
"priceSet": {
"presentmentMoney": {
"amount": "<string>",
"currencyCode": "<string>"
},
"shopMoney": {
"amount": "<string>",
"currencyCode": "<string>"
}
},
"title": "<string>",
"productId": "<string>",
"sku": "<string>",
"returnableQuantity": 123,
"variantTitle": "<string>",
"vendor": "<string>",
"fulfillmentService": "<string>",
"variantId": "<string>",
"additionalProductId": "<string>",
"properties": [],
"tags": [],
"weight": {
"value": 123,
"unit": "<string>"
},
"image": "<string>",
"images": [],
"discounts": [],
"taxLines": []
}
],
"orderDiscounts": [
{
"amountSet": {
"presentmentMoney": {
"amount": "<string>",
"currencyCode": "<string>"
},
"shopMoney": {
"amount": "<string>",
"currencyCode": "<string>"
}
},
"discountId": "<string>",
"discountTitle": "<string>",
"discountCode": "<string>"
}
],
"shippingLines": [
{
"id": "<string>",
"title": "<string>",
"priceSet": {
"presentmentMoney": {
"amount": "<string>",
"currencyCode": "<string>"
},
"shopMoney": {
"amount": "<string>",
"currencyCode": "<string>"
}
},
"code": "<string>",
"discounts": [],
"taxLines": []
}
],
"fulfillments": [
{
"id": "<string>",
"lineItems": [
{
"id": "<string>",
"quantity": 123
}
],
"trackingNumbers": [],
"trackingUrls": [],
"shippingDate": "<string>",
"deliveryDate": "<string>"
}
],
"shippingAddress": {
"address1": "<string>",
"city": "<string>",
"provinceCode": "<string>",
"zip": "<string>",
"countryCode": "<string>",
"address2": "<string>",
"company": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>"
},
"updatedAt": "<string>",
"billingAddress": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"company": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"provinceCode": "<string>",
"zip": "<string>",
"countryCode": "<string>",
"phone": "<string>"
},
"salesChannel": "<string>",
"tags": [],
"transactions": []
}
'import requests
url = "https://api.getredo.com/v2.2/stores/{storeId}/custom/orders"
payload = {
"id": "<string>",
"type": "order",
"createdAt": "<string>",
"presentmentCurrency": "<string>",
"shopCurrency": "<string>",
"customer": {
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"id": "<string>",
"tags": []
},
"lineItems": [
{
"id": "<string>",
"quantity": 123,
"priceSet": {
"presentmentMoney": {
"amount": "<string>",
"currencyCode": "<string>"
},
"shopMoney": {
"amount": "<string>",
"currencyCode": "<string>"
}
},
"title": "<string>",
"productId": "<string>",
"sku": "<string>",
"returnableQuantity": 123,
"variantTitle": "<string>",
"vendor": "<string>",
"fulfillmentService": "<string>",
"variantId": "<string>",
"additionalProductId": "<string>",
"properties": [],
"tags": [],
"weight": {
"value": 123,
"unit": "<string>"
},
"image": "<string>",
"images": [],
"discounts": [],
"taxLines": []
}
],
"orderDiscounts": [
{
"amountSet": {
"presentmentMoney": {
"amount": "<string>",
"currencyCode": "<string>"
},
"shopMoney": {
"amount": "<string>",
"currencyCode": "<string>"
}
},
"discountId": "<string>",
"discountTitle": "<string>",
"discountCode": "<string>"
}
],
"shippingLines": [
{
"id": "<string>",
"title": "<string>",
"priceSet": {
"presentmentMoney": {
"amount": "<string>",
"currencyCode": "<string>"
},
"shopMoney": {
"amount": "<string>",
"currencyCode": "<string>"
}
},
"code": "<string>",
"discounts": [],
"taxLines": []
}
],
"fulfillments": [
{
"id": "<string>",
"lineItems": [
{
"id": "<string>",
"quantity": 123
}
],
"trackingNumbers": [],
"trackingUrls": [],
"shippingDate": "<string>",
"deliveryDate": "<string>"
}
],
"shippingAddress": {
"address1": "<string>",
"city": "<string>",
"provinceCode": "<string>",
"zip": "<string>",
"countryCode": "<string>",
"address2": "<string>",
"company": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>"
},
"updatedAt": "<string>",
"billingAddress": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"company": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"provinceCode": "<string>",
"zip": "<string>",
"countryCode": "<string>",
"phone": "<string>"
},
"salesChannel": "<string>",
"tags": [],
"transactions": []
}
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({
id: '<string>',
type: 'order',
createdAt: '<string>',
presentmentCurrency: '<string>',
shopCurrency: '<string>',
customer: {
email: 'jsmith@example.com',
firstName: '<string>',
lastName: '<string>',
phone: '<string>',
id: '<string>',
tags: []
},
lineItems: [
{
id: '<string>',
quantity: 123,
priceSet: {
presentmentMoney: {amount: '<string>', currencyCode: '<string>'},
shopMoney: {amount: '<string>', currencyCode: '<string>'}
},
title: '<string>',
productId: '<string>',
sku: '<string>',
returnableQuantity: 123,
variantTitle: '<string>',
vendor: '<string>',
fulfillmentService: '<string>',
variantId: '<string>',
additionalProductId: '<string>',
properties: [],
tags: [],
weight: {value: 123, unit: '<string>'},
image: '<string>',
images: [],
discounts: [],
taxLines: []
}
],
orderDiscounts: [
{
amountSet: {
presentmentMoney: {amount: '<string>', currencyCode: '<string>'},
shopMoney: {amount: '<string>', currencyCode: '<string>'}
},
discountId: '<string>',
discountTitle: '<string>',
discountCode: '<string>'
}
],
shippingLines: [
{
id: '<string>',
title: '<string>',
priceSet: {
presentmentMoney: {amount: '<string>', currencyCode: '<string>'},
shopMoney: {amount: '<string>', currencyCode: '<string>'}
},
code: '<string>',
discounts: [],
taxLines: []
}
],
fulfillments: [
{
id: '<string>',
lineItems: [{id: '<string>', quantity: 123}],
trackingNumbers: [],
trackingUrls: [],
shippingDate: '<string>',
deliveryDate: '<string>'
}
],
shippingAddress: {
address1: '<string>',
city: '<string>',
provinceCode: '<string>',
zip: '<string>',
countryCode: '<string>',
address2: '<string>',
company: '<string>',
firstName: '<string>',
lastName: '<string>',
phone: '<string>'
},
updatedAt: '<string>',
billingAddress: {
address1: '<string>',
address2: '<string>',
city: '<string>',
company: '<string>',
firstName: '<string>',
lastName: '<string>',
provinceCode: '<string>',
zip: '<string>',
countryCode: '<string>',
phone: '<string>'
},
salesChannel: '<string>',
tags: [],
transactions: []
})
};
fetch('https://api.getredo.com/v2.2/stores/{storeId}/custom/orders', 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}/custom/orders",
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([
'id' => '<string>',
'type' => 'order',
'createdAt' => '<string>',
'presentmentCurrency' => '<string>',
'shopCurrency' => '<string>',
'customer' => [
'email' => 'jsmith@example.com',
'firstName' => '<string>',
'lastName' => '<string>',
'phone' => '<string>',
'id' => '<string>',
'tags' => [
]
],
'lineItems' => [
[
'id' => '<string>',
'quantity' => 123,
'priceSet' => [
'presentmentMoney' => [
'amount' => '<string>',
'currencyCode' => '<string>'
],
'shopMoney' => [
'amount' => '<string>',
'currencyCode' => '<string>'
]
],
'title' => '<string>',
'productId' => '<string>',
'sku' => '<string>',
'returnableQuantity' => 123,
'variantTitle' => '<string>',
'vendor' => '<string>',
'fulfillmentService' => '<string>',
'variantId' => '<string>',
'additionalProductId' => '<string>',
'properties' => [
],
'tags' => [
],
'weight' => [
'value' => 123,
'unit' => '<string>'
],
'image' => '<string>',
'images' => [
],
'discounts' => [
],
'taxLines' => [
]
]
],
'orderDiscounts' => [
[
'amountSet' => [
'presentmentMoney' => [
'amount' => '<string>',
'currencyCode' => '<string>'
],
'shopMoney' => [
'amount' => '<string>',
'currencyCode' => '<string>'
]
],
'discountId' => '<string>',
'discountTitle' => '<string>',
'discountCode' => '<string>'
]
],
'shippingLines' => [
[
'id' => '<string>',
'title' => '<string>',
'priceSet' => [
'presentmentMoney' => [
'amount' => '<string>',
'currencyCode' => '<string>'
],
'shopMoney' => [
'amount' => '<string>',
'currencyCode' => '<string>'
]
],
'code' => '<string>',
'discounts' => [
],
'taxLines' => [
]
]
],
'fulfillments' => [
[
'id' => '<string>',
'lineItems' => [
[
'id' => '<string>',
'quantity' => 123
]
],
'trackingNumbers' => [
],
'trackingUrls' => [
],
'shippingDate' => '<string>',
'deliveryDate' => '<string>'
]
],
'shippingAddress' => [
'address1' => '<string>',
'city' => '<string>',
'provinceCode' => '<string>',
'zip' => '<string>',
'countryCode' => '<string>',
'address2' => '<string>',
'company' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'phone' => '<string>'
],
'updatedAt' => '<string>',
'billingAddress' => [
'address1' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'company' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'provinceCode' => '<string>',
'zip' => '<string>',
'countryCode' => '<string>',
'phone' => '<string>'
],
'salesChannel' => '<string>',
'tags' => [
],
'transactions' => [
]
]),
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}/custom/orders"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"type\": \"order\",\n \"createdAt\": \"<string>\",\n \"presentmentCurrency\": \"<string>\",\n \"shopCurrency\": \"<string>\",\n \"customer\": {\n \"email\": \"jsmith@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"id\": \"<string>\",\n \"tags\": []\n },\n \"lineItems\": [\n {\n \"id\": \"<string>\",\n \"quantity\": 123,\n \"priceSet\": {\n \"presentmentMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n },\n \"shopMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n }\n },\n \"title\": \"<string>\",\n \"productId\": \"<string>\",\n \"sku\": \"<string>\",\n \"returnableQuantity\": 123,\n \"variantTitle\": \"<string>\",\n \"vendor\": \"<string>\",\n \"fulfillmentService\": \"<string>\",\n \"variantId\": \"<string>\",\n \"additionalProductId\": \"<string>\",\n \"properties\": [],\n \"tags\": [],\n \"weight\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"image\": \"<string>\",\n \"images\": [],\n \"discounts\": [],\n \"taxLines\": []\n }\n ],\n \"orderDiscounts\": [\n {\n \"amountSet\": {\n \"presentmentMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n },\n \"shopMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n }\n },\n \"discountId\": \"<string>\",\n \"discountTitle\": \"<string>\",\n \"discountCode\": \"<string>\"\n }\n ],\n \"shippingLines\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"priceSet\": {\n \"presentmentMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n },\n \"shopMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n }\n },\n \"code\": \"<string>\",\n \"discounts\": [],\n \"taxLines\": []\n }\n ],\n \"fulfillments\": [\n {\n \"id\": \"<string>\",\n \"lineItems\": [\n {\n \"id\": \"<string>\",\n \"quantity\": 123\n }\n ],\n \"trackingNumbers\": [],\n \"trackingUrls\": [],\n \"shippingDate\": \"<string>\",\n \"deliveryDate\": \"<string>\"\n }\n ],\n \"shippingAddress\": {\n \"address1\": \"<string>\",\n \"city\": \"<string>\",\n \"provinceCode\": \"<string>\",\n \"zip\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"address2\": \"<string>\",\n \"company\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"updatedAt\": \"<string>\",\n \"billingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"company\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"provinceCode\": \"<string>\",\n \"zip\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"salesChannel\": \"<string>\",\n \"tags\": [],\n \"transactions\": []\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}/custom/orders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"type\": \"order\",\n \"createdAt\": \"<string>\",\n \"presentmentCurrency\": \"<string>\",\n \"shopCurrency\": \"<string>\",\n \"customer\": {\n \"email\": \"jsmith@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"id\": \"<string>\",\n \"tags\": []\n },\n \"lineItems\": [\n {\n \"id\": \"<string>\",\n \"quantity\": 123,\n \"priceSet\": {\n \"presentmentMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n },\n \"shopMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n }\n },\n \"title\": \"<string>\",\n \"productId\": \"<string>\",\n \"sku\": \"<string>\",\n \"returnableQuantity\": 123,\n \"variantTitle\": \"<string>\",\n \"vendor\": \"<string>\",\n \"fulfillmentService\": \"<string>\",\n \"variantId\": \"<string>\",\n \"additionalProductId\": \"<string>\",\n \"properties\": [],\n \"tags\": [],\n \"weight\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"image\": \"<string>\",\n \"images\": [],\n \"discounts\": [],\n \"taxLines\": []\n }\n ],\n \"orderDiscounts\": [\n {\n \"amountSet\": {\n \"presentmentMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n },\n \"shopMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n }\n },\n \"discountId\": \"<string>\",\n \"discountTitle\": \"<string>\",\n \"discountCode\": \"<string>\"\n }\n ],\n \"shippingLines\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"priceSet\": {\n \"presentmentMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n },\n \"shopMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n }\n },\n \"code\": \"<string>\",\n \"discounts\": [],\n \"taxLines\": []\n }\n ],\n \"fulfillments\": [\n {\n \"id\": \"<string>\",\n \"lineItems\": [\n {\n \"id\": \"<string>\",\n \"quantity\": 123\n }\n ],\n \"trackingNumbers\": [],\n \"trackingUrls\": [],\n \"shippingDate\": \"<string>\",\n \"deliveryDate\": \"<string>\"\n }\n ],\n \"shippingAddress\": {\n \"address1\": \"<string>\",\n \"city\": \"<string>\",\n \"provinceCode\": \"<string>\",\n \"zip\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"address2\": \"<string>\",\n \"company\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"updatedAt\": \"<string>\",\n \"billingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"company\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"provinceCode\": \"<string>\",\n \"zip\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"salesChannel\": \"<string>\",\n \"tags\": [],\n \"transactions\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getredo.com/v2.2/stores/{storeId}/custom/orders")
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 \"id\": \"<string>\",\n \"type\": \"order\",\n \"createdAt\": \"<string>\",\n \"presentmentCurrency\": \"<string>\",\n \"shopCurrency\": \"<string>\",\n \"customer\": {\n \"email\": \"jsmith@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"id\": \"<string>\",\n \"tags\": []\n },\n \"lineItems\": [\n {\n \"id\": \"<string>\",\n \"quantity\": 123,\n \"priceSet\": {\n \"presentmentMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n },\n \"shopMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n }\n },\n \"title\": \"<string>\",\n \"productId\": \"<string>\",\n \"sku\": \"<string>\",\n \"returnableQuantity\": 123,\n \"variantTitle\": \"<string>\",\n \"vendor\": \"<string>\",\n \"fulfillmentService\": \"<string>\",\n \"variantId\": \"<string>\",\n \"additionalProductId\": \"<string>\",\n \"properties\": [],\n \"tags\": [],\n \"weight\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"image\": \"<string>\",\n \"images\": [],\n \"discounts\": [],\n \"taxLines\": []\n }\n ],\n \"orderDiscounts\": [\n {\n \"amountSet\": {\n \"presentmentMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n },\n \"shopMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n }\n },\n \"discountId\": \"<string>\",\n \"discountTitle\": \"<string>\",\n \"discountCode\": \"<string>\"\n }\n ],\n \"shippingLines\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"priceSet\": {\n \"presentmentMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n },\n \"shopMoney\": {\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\"\n }\n },\n \"code\": \"<string>\",\n \"discounts\": [],\n \"taxLines\": []\n }\n ],\n \"fulfillments\": [\n {\n \"id\": \"<string>\",\n \"lineItems\": [\n {\n \"id\": \"<string>\",\n \"quantity\": 123\n }\n ],\n \"trackingNumbers\": [],\n \"trackingUrls\": [],\n \"shippingDate\": \"<string>\",\n \"deliveryDate\": \"<string>\"\n }\n ],\n \"shippingAddress\": {\n \"address1\": \"<string>\",\n \"city\": \"<string>\",\n \"provinceCode\": \"<string>\",\n \"zip\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"address2\": \"<string>\",\n \"company\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"updatedAt\": \"<string>\",\n \"billingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"company\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"provinceCode\": \"<string>\",\n \"zip\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"salesChannel\": \"<string>\",\n \"tags\": [],\n \"transactions\": []\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"orderId": "<string>",
"redoId": "<string>"
}{
"error": "<string>",
"errors": {}
}{
"error": "<string>",
"errors": {}
}{
"detail": "<string>",
"instance": "<string>",
"title": "<string>",
"type": "about:blank"
}{
"detail": "<string>",
"instance": "<string>",
"title": "<string>",
"type": "about:blank"
}{
"error": "<string>",
"errors": {}
}{
"detail": "<string>",
"instance": "<string>",
"title": "<string>",
"type": "about:blank"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Store ID
Example:
"64e5a8a1af49a89df37e4ee7"
Body
application/json
An order synced into Redo so it can be returned.
Redo reads the line items, discounts, and taxes below to decide what the shopper is allowed to return and what to refund, so send the values that were actually charged.
Note: If Redo is attached to this order, you must add a single line item with:
- vendor: "re:do"
- sku: "x-redo"
- Include the price of Redo as the line item price
- In tags, include: "returns", "package protection", or "both"
- In properties, include _redo_type with value: "return", "package protection", or "both"
Order ID in external system
Type of resource (must be "order")
Available options:
order Order creation timestamp
Currency shown to customer
Shop's base currency
Customer information
Show child attributes
Show child attributes
Order line items. Line item IDs must be unique within an order.
Show child attributes
Show child attributes
Order-level discounts (not line item or shipping discounts)
Show child attributes
Show child attributes
Shipping methods
Show child attributes
Show child attributes
Order fulfillments
Show child attributes
Show child attributes
Shipping address
Show child attributes
Show child attributes
Last update timestamp
Billing address
Show child attributes
Show child attributes
Sales channel where order was placed
Order tags
Payment transactions
Show child attributes
Show child attributes
Was this page helpful?
⌘I