Request a return for an order
Lodges a return for one of the shopper’s own orders — the action getOrderStatus lists as request_return
while the order is inside the store’s return window. Omit items to return every line in full, or name
lines with order_item_id and a quantity. The store reviews the return and decides the refund; the shopper
is emailed that it was received. Requires the shopper’s credential.
curl --request POST \
--url https://api.tybritelabs.com/v1/agent/orders/{id}/returns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reason_code": "wrong_size",
"return_type": "store_credit"
}
'import requests
url = "https://api.tybritelabs.com/v1/agent/orders/{id}/returns"
payload = {
"reason_code": "wrong_size",
"return_type": "store_credit"
}
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({reason_code: 'wrong_size', return_type: 'store_credit'})
};
fetch('https://api.tybritelabs.com/v1/agent/orders/{id}/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.tybritelabs.com/v1/agent/orders/{id}/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([
'reason_code' => 'wrong_size',
'return_type' => 'store_credit'
]),
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.tybritelabs.com/v1/agent/orders/{id}/returns"
payload := strings.NewReader("{\n \"reason_code\": \"wrong_size\",\n \"return_type\": \"store_credit\"\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.tybritelabs.com/v1/agent/orders/{id}/returns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason_code\": \"wrong_size\",\n \"return_type\": \"store_credit\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/agent/orders/{id}/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 \"reason_code\": \"wrong_size\",\n \"return_type\": \"store_credit\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "df26fae0-6566-4d87-97d4-1902c20b758f",
"return_number": "RET-20261001-fb1716",
"order_id": "36f0b9c2-8c86-4034-bef7-82dfe4744ff5",
"channel": "online",
"status": "pending",
"return_type": "store_credit",
"reason_code": "wrong_size",
"reason_description": null,
"total_return_amount": 48,
"refund_amount": 0,
"refund_method": null,
"created_at": "2026-10-01T11:25:17.785759+00:00",
"processed_at": null,
"credit_offer": {
"status": "none",
"amount": null
},
"items": [
{
"id": "cf7eec28-8406-42a1-945b-bf374c89230f",
"order_item_id": "d6a0866a-322a-428b-925d-35081f37ed39",
"product_name": "Galactic Zip Hoodie",
"quantity": 1,
"unit_price": 48,
"return_amount": 48,
"condition": "sellable",
"status": "pending",
"rejection_reason": null,
"media": []
}
]
},
"evidence": [
{
"source": "returns",
"operation": "POST /v1/returns",
"id": "df26fae0-6566-4d87-97d4-1902c20b758f"
}
],
"computed_at": "2026-10-01T11:25:18.445Z",
"currency": "EUR",
"environment": "sandbox"
}Authorizations
API Key Authentication
Use your API key in the Authorization header:
Authorization: Bearer tybrite_sk_live_YOUR_KEY
Key Types:
Secret Keys (Server-Side Only):
- Format:
tybrite_sk_live_*(production) ortybrite_sk_test_*(sandbox) - Full read/write access to all endpoints
- ⚠️ NEVER expose in client-side code or public repositories
- Required for: every write a shopper does not make for themselves, authentication, payment verification, AI recommendations
Publishable Keys (Client-Safe):
- Format:
tybrite_pk_live_*(production) ortybrite_pk_test_*(sandbox) - Catalogue reads, plus the actions a shopper takes for themselves
- ✅ Safe for client-side JavaScript, mobile apps, and public code
- Allowed for: browsing products, search, CMS content, pricing queries, cart and wishlist, reviews, storefront events, and the Agent API's quotes, cart drafts and checkout intents
Endpoint-Specific Requirements:
- Authentication endpoints (
/v1/auth/*): state-changingPOSTcalls require a secret key, for store and marketplace keys alike;GET /v1/auth/meaccepts either key - Payment verification (
POST /v1/payments/verify): Secret key required - AI Recommendations (
POST /v1/recommendations): Secret key required - Semantic Search (
POST /v1/search): Both key types allowed (read-only operation) - Shopper actions (cart, wishlist, reviews, storefront events, Agent API quotes, cart drafts and checkout intents): Both key types allowed
- All other write operations: Secret key required
- All read operations: Both key types allowed
Using a publishable key for restricted operations returns 403 Forbidden.
Limited publishable keys:
A publishable key can be limited to the products that carry one tag (for example starter:jewellery), created from
the store's Developers page. The limit applies to the key, never to the shopper: shopper sign-up and sign-in stay store-wide.
- Reads return only the slice: products (with their facets, filters, search, brands and specifications), categories and
subcategories that hold in-slice products, collections, promotions, posts and lookbooks that carry the tag, reviews of
in-slice products, prices, discovery lists and the store information summary, with every count computed on the slice.
A product outside the slice answers
404, as if it did not exist. - A write that names a product or variant outside the slice (adding to the cart or wishlist, reserving stock, an order line,
a review, a promotion calculation, a storefront event) answers
403with the error codeout_of_scope, and nothing is written or reserved. An order is refused as a whole. - A route that carries no slice behaviour is not available to the key: it answers
403withendpoint_not_allowed. - Orders placed through such a key record the tag on the order's attribution as
key_scope. - Secret keys and connected-app keys cannot be limited.
- Responses are cached per key limit: a limited key never receives a response cached for the whole store, and the reverse.
Headers
Body
curl --request POST \
--url https://api.tybritelabs.com/v1/agent/orders/{id}/returns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reason_code": "wrong_size",
"return_type": "store_credit"
}
'import requests
url = "https://api.tybritelabs.com/v1/agent/orders/{id}/returns"
payload = {
"reason_code": "wrong_size",
"return_type": "store_credit"
}
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({reason_code: 'wrong_size', return_type: 'store_credit'})
};
fetch('https://api.tybritelabs.com/v1/agent/orders/{id}/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.tybritelabs.com/v1/agent/orders/{id}/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([
'reason_code' => 'wrong_size',
'return_type' => 'store_credit'
]),
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.tybritelabs.com/v1/agent/orders/{id}/returns"
payload := strings.NewReader("{\n \"reason_code\": \"wrong_size\",\n \"return_type\": \"store_credit\"\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.tybritelabs.com/v1/agent/orders/{id}/returns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason_code\": \"wrong_size\",\n \"return_type\": \"store_credit\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/agent/orders/{id}/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 \"reason_code\": \"wrong_size\",\n \"return_type\": \"store_credit\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "df26fae0-6566-4d87-97d4-1902c20b758f",
"return_number": "RET-20261001-fb1716",
"order_id": "36f0b9c2-8c86-4034-bef7-82dfe4744ff5",
"channel": "online",
"status": "pending",
"return_type": "store_credit",
"reason_code": "wrong_size",
"reason_description": null,
"total_return_amount": 48,
"refund_amount": 0,
"refund_method": null,
"created_at": "2026-10-01T11:25:17.785759+00:00",
"processed_at": null,
"credit_offer": {
"status": "none",
"amount": null
},
"items": [
{
"id": "cf7eec28-8406-42a1-945b-bf374c89230f",
"order_item_id": "d6a0866a-322a-428b-925d-35081f37ed39",
"product_name": "Galactic Zip Hoodie",
"quantity": 1,
"unit_price": 48,
"return_amount": 48,
"condition": "sellable",
"status": "pending",
"rejection_reason": null,
"media": []
}
]
},
"evidence": [
{
"source": "returns",
"operation": "POST /v1/returns",
"id": "df26fae0-6566-4d87-97d4-1902c20b758f"
}
],
"computed_at": "2026-10-01T11:25:18.445Z",
"currency": "EUR",
"environment": "sandbox"
}
