curl --request PUT \
--url https://api.quivo.co/returns/{returnShipmentId} \
--header 'Content-Type: application/json' \
--data '
{
"customerExamined": true
}
'import requests
url = "https://api.quivo.co/returns/{returnShipmentId}"
payload = { "customerExamined": True }
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({customerExamined: true})
};
fetch('https://api.quivo.co/returns/{returnShipmentId}', 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.quivo.co/returns/{returnShipmentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'customerExamined' => true
]),
CURLOPT_HTTPHEADER => [
"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.quivo.co/returns/{returnShipmentId}"
payload := strings.NewReader("{\n \"customerExamined\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.put("https://api.quivo.co/returns/{returnShipmentId}")
.header("Content-Type", "application/json")
.body("{\n \"customerExamined\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quivo.co/returns/{returnShipmentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerExamined\": true\n}"
response = http.request(request)
puts response.read_body{
"returnShipmentId": 123,
"warehouseId": 123,
"returnShipmentIdentifier": "<string>",
"sellerId": 123,
"receivedDate": "2023-11-07T05:31:56Z",
"trackingNumber": "<string>",
"trackingLink": "<string>",
"carrierSlug": "<string>",
"orderId": 123,
"fulfillmentOrderId": 123,
"returnAnnouncementId": 123,
"shipFrom": {
"name1": "<string>",
"name2": "<string>",
"company": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"zip": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"phone": "<string>",
"email": "<string>"
},
"returnShipmentReference": "<string>",
"customerExamined": true,
"positions": [
{
"returnShipmentPositionId": 123,
"sellerSku": "<string>",
"warehouseSku": "<string>",
"name": "<string>",
"quantity": 123,
"lot": "<string>",
"expirationDate": "2023-11-07T05:31:56Z",
"serialNumbers": [
"<string>"
],
"classCode": "<string>",
"classDescription": "<string>",
"reasonCode": "<string>",
"reasonDescription": "<string>",
"resolutionCode": "<string>",
"resolutionDescription": "<string>",
"positionIdentifier": "<string>",
"storageCode": "<string>",
"storageBlocked": true
}
],
"groupedPositions": [
{
"sellerSku": "<string>",
"warehouseSku": "<string>",
"name": "<string>",
"quantity": 123,
"lot": "<string>",
"expirationDate": "2023-11-07T05:31:56Z",
"serialNumbers": [
"<string>"
],
"classCode": "<string>",
"classDescription": "<string>",
"reasonCode": "<string>",
"reasonDescription": "<string>",
"resolutionCode": "<string>",
"resolutionDescription": "<string>"
}
],
"comments": [
{
"returnShipmentCommentId": 123,
"text": "<string>",
"addedByClient": true,
"fileKey": "<string>",
"url": {
"link": "<string>"
},
"returnShipmentImages": [
{
"text": "<string>",
"fileKey": "<string>",
"url": {
"link": "<string>"
}
}
]
}
],
"piiDataRemoved": true
}Update return shipment
Update an existing return shipment.
curl --request PUT \
--url https://api.quivo.co/returns/{returnShipmentId} \
--header 'Content-Type: application/json' \
--data '
{
"customerExamined": true
}
'import requests
url = "https://api.quivo.co/returns/{returnShipmentId}"
payload = { "customerExamined": True }
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({customerExamined: true})
};
fetch('https://api.quivo.co/returns/{returnShipmentId}', 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.quivo.co/returns/{returnShipmentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'customerExamined' => true
]),
CURLOPT_HTTPHEADER => [
"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.quivo.co/returns/{returnShipmentId}"
payload := strings.NewReader("{\n \"customerExamined\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.put("https://api.quivo.co/returns/{returnShipmentId}")
.header("Content-Type", "application/json")
.body("{\n \"customerExamined\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quivo.co/returns/{returnShipmentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerExamined\": true\n}"
response = http.request(request)
puts response.read_body{
"returnShipmentId": 123,
"warehouseId": 123,
"returnShipmentIdentifier": "<string>",
"sellerId": 123,
"receivedDate": "2023-11-07T05:31:56Z",
"trackingNumber": "<string>",
"trackingLink": "<string>",
"carrierSlug": "<string>",
"orderId": 123,
"fulfillmentOrderId": 123,
"returnAnnouncementId": 123,
"shipFrom": {
"name1": "<string>",
"name2": "<string>",
"company": "<string>",
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"zip": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"phone": "<string>",
"email": "<string>"
},
"returnShipmentReference": "<string>",
"customerExamined": true,
"positions": [
{
"returnShipmentPositionId": 123,
"sellerSku": "<string>",
"warehouseSku": "<string>",
"name": "<string>",
"quantity": 123,
"lot": "<string>",
"expirationDate": "2023-11-07T05:31:56Z",
"serialNumbers": [
"<string>"
],
"classCode": "<string>",
"classDescription": "<string>",
"reasonCode": "<string>",
"reasonDescription": "<string>",
"resolutionCode": "<string>",
"resolutionDescription": "<string>",
"positionIdentifier": "<string>",
"storageCode": "<string>",
"storageBlocked": true
}
],
"groupedPositions": [
{
"sellerSku": "<string>",
"warehouseSku": "<string>",
"name": "<string>",
"quantity": 123,
"lot": "<string>",
"expirationDate": "2023-11-07T05:31:56Z",
"serialNumbers": [
"<string>"
],
"classCode": "<string>",
"classDescription": "<string>",
"reasonCode": "<string>",
"reasonDescription": "<string>",
"resolutionCode": "<string>",
"resolutionDescription": "<string>"
}
],
"comments": [
{
"returnShipmentCommentId": 123,
"text": "<string>",
"addedByClient": true,
"fileKey": "<string>",
"url": {
"link": "<string>"
},
"returnShipmentImages": [
{
"text": "<string>",
"fileKey": "<string>",
"url": {
"link": "<string>"
}
}
]
}
],
"piiDataRemoved": true
}Path Parameters
The unique identifier for a return shipment.
Body
Complete resource data to update at /returns/{returnShipmentId}
Request payload for updating a return shipment when a customer examination has been completed. Contains examination results and return status information.
Customer identifier or information
Response
Returns the updated return shipment with current status and processing details.
Complete return shipment information with all details. Contains return identifiers, original order reference, return reason, status, and processing information.
The unique identifier for the returnshipment
The unique identifier for the warehouse
The unique identifier for the returnshipmententifier
The unique identifier for the seller
The received date date
Tracking information or tracking enabled status
Tracking information or tracking enabled status
Carrier identifier or information
The unique identifier for the order
The unique identifier for the fulfillmentorder
The unique identifier for the returnannouncement
Detailed address information
Show child attributes
Show child attributes
Reference number or identifier for the return shipment
Customer identifier or information
Array of position items
Show child attributes
Show child attributes
Array of grouped position
Show child attributes
Show child attributes
Comment or notes
Show child attributes
Show child attributes
Boolean flag indicating pii data removed