cURL
curl -sS -X PATCH 'https://apipub.firstbasehq.com/api/v1/return-orders/{returnOrderId}/items' \
-H 'Authorization: ApiKey YOUR_API_KEY' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"items": []
}'import requests
url = "https://apipub.firstbasehq.com/api/v1/return-orders/{returnOrderId}/items"
payload = { "items": [] }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({items: []})
};
fetch('https://apipub.firstbasehq.com/api/v1/return-orders/{returnOrderId}/items', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"returnOrderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedItemCount": 123,
"items": [
{
"id": "123E4567-E89B-12D3-A456-426614174000",
"skuId": "123E4567-E89B-12D3-A456-426614174000",
"title": "iPad Air - Silver, 64GB, WiFi",
"categoryCode": "COMPUTER",
"status": "PROCESSING",
"itad": false,
"shipment": {
"trackingUrl": "<string>",
"trackingCode": "1Z00000000",
"carrier": "UPS",
"status": "DELIVERED",
"trackingHistory": [
{
"status": "IN_TRANSIT",
"timestamp": "2023-11-07T05:31:56Z"
}
]
},
"returnReason": "OFFBOARDING",
"inventoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retrievalMethodStatus": "DELIVERED",
"inboundTrackingLink": "https://tracking.example.com/123456",
"inboundCarrier": "UPS",
"inboundTrackingCode": "1Z999AA10123456784",
"outboundTrackingLink": "https://tracking.example.com/789012",
"outboundCarrier": "FedEx",
"outboundTrackingCode": "1Z999AA10567890123",
"vendorSku": "APL-MK183LL/A",
"vendorCode": "APPLE",
"serialNumber": "<string>",
"holdRequested": true
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}Returns
Process return items
Bulk-update items on a return order (used when items physically arrive). Each item: id, status. When status is NOT_RETURNED, send notReturnedDisposition DEPLOYED (keep deployed; omit deploy fields) or ARCHIVE (deployReason required; non-blank deployReasonDetails when deployReason is OTHER). Matches org-app Process Return. Offboarding returns: domain validation may still require deployReason for NOT_RETURNED. Additional RETURNED validation may return 400 with domain detail.
PATCH
https://apipub.firstbasehq.com
/
api
/
v1
/
return-orders
/
{returnOrderId}
/
items
cURL
curl -sS -X PATCH 'https://apipub.firstbasehq.com/api/v1/return-orders/{returnOrderId}/items' \
-H 'Authorization: ApiKey YOUR_API_KEY' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"items": []
}'import requests
url = "https://apipub.firstbasehq.com/api/v1/return-orders/{returnOrderId}/items"
payload = { "items": [] }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({items: []})
};
fetch('https://apipub.firstbasehq.com/api/v1/return-orders/{returnOrderId}/items', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"returnOrderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedItemCount": 123,
"items": [
{
"id": "123E4567-E89B-12D3-A456-426614174000",
"skuId": "123E4567-E89B-12D3-A456-426614174000",
"title": "iPad Air - Silver, 64GB, WiFi",
"categoryCode": "COMPUTER",
"status": "PROCESSING",
"itad": false,
"shipment": {
"trackingUrl": "<string>",
"trackingCode": "1Z00000000",
"carrier": "UPS",
"status": "DELIVERED",
"trackingHistory": [
{
"status": "IN_TRANSIT",
"timestamp": "2023-11-07T05:31:56Z"
}
]
},
"returnReason": "OFFBOARDING",
"inventoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retrievalMethodStatus": "DELIVERED",
"inboundTrackingLink": "https://tracking.example.com/123456",
"inboundCarrier": "UPS",
"inboundTrackingCode": "1Z999AA10123456784",
"outboundTrackingLink": "https://tracking.example.com/789012",
"outboundCarrier": "FedEx",
"outboundTrackingCode": "1Z999AA10567890123",
"vendorSku": "APL-MK183LL/A",
"vendorCode": "APPLE",
"serialNumber": "<string>",
"holdRequested": true
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}Authorizations
Body
application/json
Response
Items updated
Returned after return-order items were processed successfully.