Update Product Variant
curl --request PATCH \
--url https://api.loopreturns.com/api/v1/products/{productId}/product-variants/{id} \
--header 'Content-Type: application/json' \
--header 'X-Authorization: <api-key>' \
--data '
{
"name": "<string>",
"external_id": "<string>",
"sku": "<string>",
"weight_grams": 123,
"barcode": "<string>",
"price": {
"amount": 50000,
"currency_code": "USD"
},
"images": [
"<string>"
],
"options": [
{
"position": 123,
"value": "<string>"
}
],
"logistics_information": {
"origin_country_code": "<string>",
"origin_region_code": "<string>",
"default_hs_code": "<string>",
"requires_shipping": true,
"cost": {
"amount": 50000,
"currency_code": "USD"
},
"destination_country_hs_codes": [
{
"destination_country_code": "<string>",
"hs_code": "<string>"
}
]
},
"dimensions": {
"depth": 123,
"width": 123,
"height": 123
},
"locale_data": [
{
"locale": "<string>",
"name": "<string>"
}
]
}
'import requests
url = "https://api.loopreturns.com/api/v1/products/{productId}/product-variants/{id}"
payload = {
"name": "<string>",
"external_id": "<string>",
"sku": "<string>",
"weight_grams": 123,
"barcode": "<string>",
"price": {
"amount": 50000,
"currency_code": "USD"
},
"images": ["<string>"],
"options": [
{
"position": 123,
"value": "<string>"
}
],
"logistics_information": {
"origin_country_code": "<string>",
"origin_region_code": "<string>",
"default_hs_code": "<string>",
"requires_shipping": True,
"cost": {
"amount": 50000,
"currency_code": "USD"
},
"destination_country_hs_codes": [
{
"destination_country_code": "<string>",
"hs_code": "<string>"
}
]
},
"dimensions": {
"depth": 123,
"width": 123,
"height": 123
},
"locale_data": [
{
"locale": "<string>",
"name": "<string>"
}
]
}
headers = {
"X-Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
external_id: '<string>',
sku: '<string>',
weight_grams: 123,
barcode: '<string>',
price: {amount: 50000, currency_code: 'USD'},
images: ['<string>'],
options: [{position: 123, value: '<string>'}],
logistics_information: {
origin_country_code: '<string>',
origin_region_code: '<string>',
default_hs_code: '<string>',
requires_shipping: true,
cost: {amount: 50000, currency_code: 'USD'},
destination_country_hs_codes: [{destination_country_code: '<string>', hs_code: '<string>'}]
},
dimensions: {depth: 123, width: 123, height: 123},
locale_data: [{locale: '<string>', name: '<string>'}]
})
};
fetch('https://api.loopreturns.com/api/v1/products/{productId}/product-variants/{id}', 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.loopreturns.com/api/v1/products/{productId}/product-variants/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'external_id' => '<string>',
'sku' => '<string>',
'weight_grams' => 123,
'barcode' => '<string>',
'price' => [
'amount' => 50000,
'currency_code' => 'USD'
],
'images' => [
'<string>'
],
'options' => [
[
'position' => 123,
'value' => '<string>'
]
],
'logistics_information' => [
'origin_country_code' => '<string>',
'origin_region_code' => '<string>',
'default_hs_code' => '<string>',
'requires_shipping' => true,
'cost' => [
'amount' => 50000,
'currency_code' => 'USD'
],
'destination_country_hs_codes' => [
[
'destination_country_code' => '<string>',
'hs_code' => '<string>'
]
]
],
'dimensions' => [
'depth' => 123,
'width' => 123,
'height' => 123
],
'locale_data' => [
[
'locale' => '<string>',
'name' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Authorization: <api-key>"
],
]);
$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.loopreturns.com/api/v1/products/{productId}/product-variants/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"sku\": \"<string>\",\n \"weight_grams\": 123,\n \"barcode\": \"<string>\",\n \"price\": {\n \"amount\": 50000,\n \"currency_code\": \"USD\"\n },\n \"images\": [\n \"<string>\"\n ],\n \"options\": [\n {\n \"position\": 123,\n \"value\": \"<string>\"\n }\n ],\n \"logistics_information\": {\n \"origin_country_code\": \"<string>\",\n \"origin_region_code\": \"<string>\",\n \"default_hs_code\": \"<string>\",\n \"requires_shipping\": true,\n \"cost\": {\n \"amount\": 50000,\n \"currency_code\": \"USD\"\n },\n \"destination_country_hs_codes\": [\n {\n \"destination_country_code\": \"<string>\",\n \"hs_code\": \"<string>\"\n }\n ]\n },\n \"dimensions\": {\n \"depth\": 123,\n \"width\": 123,\n \"height\": 123\n },\n \"locale_data\": [\n {\n \"locale\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Authorization", "<api-key>")
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.patch("https://api.loopreturns.com/api/v1/products/{productId}/product-variants/{id}")
.header("X-Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"sku\": \"<string>\",\n \"weight_grams\": 123,\n \"barcode\": \"<string>\",\n \"price\": {\n \"amount\": 50000,\n \"currency_code\": \"USD\"\n },\n \"images\": [\n \"<string>\"\n ],\n \"options\": [\n {\n \"position\": 123,\n \"value\": \"<string>\"\n }\n ],\n \"logistics_information\": {\n \"origin_country_code\": \"<string>\",\n \"origin_region_code\": \"<string>\",\n \"default_hs_code\": \"<string>\",\n \"requires_shipping\": true,\n \"cost\": {\n \"amount\": 50000,\n \"currency_code\": \"USD\"\n },\n \"destination_country_hs_codes\": [\n {\n \"destination_country_code\": \"<string>\",\n \"hs_code\": \"<string>\"\n }\n ]\n },\n \"dimensions\": {\n \"depth\": 123,\n \"width\": 123,\n \"height\": 123\n },\n \"locale_data\": [\n {\n \"locale\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.loopreturns.com/api/v1/products/{productId}/product-variants/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"sku\": \"<string>\",\n \"weight_grams\": 123,\n \"barcode\": \"<string>\",\n \"price\": {\n \"amount\": 50000,\n \"currency_code\": \"USD\"\n },\n \"images\": [\n \"<string>\"\n ],\n \"options\": [\n {\n \"position\": 123,\n \"value\": \"<string>\"\n }\n ],\n \"logistics_information\": {\n \"origin_country_code\": \"<string>\",\n \"origin_region_code\": \"<string>\",\n \"default_hs_code\": \"<string>\",\n \"requires_shipping\": true,\n \"cost\": {\n \"amount\": 50000,\n \"currency_code\": \"USD\"\n },\n \"destination_country_hs_codes\": [\n {\n \"destination_country_code\": \"<string>\",\n \"hs_code\": \"<string>\"\n }\n ]\n },\n \"dimensions\": {\n \"depth\": 123,\n \"width\": 123,\n \"height\": 123\n },\n \"locale_data\": [\n {\n \"locale\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"product_variant": {
"id": 2,
"external_id": "<string>",
"sku": "<string>",
"name": "<string>",
"weight_grams": 123,
"barcode": "<string>",
"product": {
"id": 2,
"external_id": "<string>",
"sku": "<string>",
"name": "<string>"
},
"price": {
"amount": 50000,
"currency_code": "USD"
},
"images": [
"<string>"
],
"inventories": [
{
"id": 2,
"available_count": 123,
"location": {
"id": 2,
"external_id": "<string>",
"name": "<string>"
}
}
],
"options": [
{
"position": 123,
"value": "<string>"
}
],
"logistics_information": {
"origin_country_code": "<string>",
"origin_region_code": "<string>",
"default_hs_code": "<string>",
"requires_shipping": true,
"cost": {
"amount": 50000,
"currency_code": "USD"
},
"destination_country_hs_codes": [
{
"destination_country_code": "<string>",
"hs_code": "<string>"
}
]
},
"dimensions": {
"depth": 123,
"width": 123,
"height": 123
}
}
}"<unknown>""<unknown>"Products
Update Product Variant
Update a product variant.
PATCH
/
products
/
{productId}
/
product-variants
/
{id}
Update Product Variant
curl --request PATCH \
--url https://api.loopreturns.com/api/v1/products/{productId}/product-variants/{id} \
--header 'Content-Type: application/json' \
--header 'X-Authorization: <api-key>' \
--data '
{
"name": "<string>",
"external_id": "<string>",
"sku": "<string>",
"weight_grams": 123,
"barcode": "<string>",
"price": {
"amount": 50000,
"currency_code": "USD"
},
"images": [
"<string>"
],
"options": [
{
"position": 123,
"value": "<string>"
}
],
"logistics_information": {
"origin_country_code": "<string>",
"origin_region_code": "<string>",
"default_hs_code": "<string>",
"requires_shipping": true,
"cost": {
"amount": 50000,
"currency_code": "USD"
},
"destination_country_hs_codes": [
{
"destination_country_code": "<string>",
"hs_code": "<string>"
}
]
},
"dimensions": {
"depth": 123,
"width": 123,
"height": 123
},
"locale_data": [
{
"locale": "<string>",
"name": "<string>"
}
]
}
'import requests
url = "https://api.loopreturns.com/api/v1/products/{productId}/product-variants/{id}"
payload = {
"name": "<string>",
"external_id": "<string>",
"sku": "<string>",
"weight_grams": 123,
"barcode": "<string>",
"price": {
"amount": 50000,
"currency_code": "USD"
},
"images": ["<string>"],
"options": [
{
"position": 123,
"value": "<string>"
}
],
"logistics_information": {
"origin_country_code": "<string>",
"origin_region_code": "<string>",
"default_hs_code": "<string>",
"requires_shipping": True,
"cost": {
"amount": 50000,
"currency_code": "USD"
},
"destination_country_hs_codes": [
{
"destination_country_code": "<string>",
"hs_code": "<string>"
}
]
},
"dimensions": {
"depth": 123,
"width": 123,
"height": 123
},
"locale_data": [
{
"locale": "<string>",
"name": "<string>"
}
]
}
headers = {
"X-Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
external_id: '<string>',
sku: '<string>',
weight_grams: 123,
barcode: '<string>',
price: {amount: 50000, currency_code: 'USD'},
images: ['<string>'],
options: [{position: 123, value: '<string>'}],
logistics_information: {
origin_country_code: '<string>',
origin_region_code: '<string>',
default_hs_code: '<string>',
requires_shipping: true,
cost: {amount: 50000, currency_code: 'USD'},
destination_country_hs_codes: [{destination_country_code: '<string>', hs_code: '<string>'}]
},
dimensions: {depth: 123, width: 123, height: 123},
locale_data: [{locale: '<string>', name: '<string>'}]
})
};
fetch('https://api.loopreturns.com/api/v1/products/{productId}/product-variants/{id}', 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.loopreturns.com/api/v1/products/{productId}/product-variants/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'external_id' => '<string>',
'sku' => '<string>',
'weight_grams' => 123,
'barcode' => '<string>',
'price' => [
'amount' => 50000,
'currency_code' => 'USD'
],
'images' => [
'<string>'
],
'options' => [
[
'position' => 123,
'value' => '<string>'
]
],
'logistics_information' => [
'origin_country_code' => '<string>',
'origin_region_code' => '<string>',
'default_hs_code' => '<string>',
'requires_shipping' => true,
'cost' => [
'amount' => 50000,
'currency_code' => 'USD'
],
'destination_country_hs_codes' => [
[
'destination_country_code' => '<string>',
'hs_code' => '<string>'
]
]
],
'dimensions' => [
'depth' => 123,
'width' => 123,
'height' => 123
],
'locale_data' => [
[
'locale' => '<string>',
'name' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Authorization: <api-key>"
],
]);
$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.loopreturns.com/api/v1/products/{productId}/product-variants/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"sku\": \"<string>\",\n \"weight_grams\": 123,\n \"barcode\": \"<string>\",\n \"price\": {\n \"amount\": 50000,\n \"currency_code\": \"USD\"\n },\n \"images\": [\n \"<string>\"\n ],\n \"options\": [\n {\n \"position\": 123,\n \"value\": \"<string>\"\n }\n ],\n \"logistics_information\": {\n \"origin_country_code\": \"<string>\",\n \"origin_region_code\": \"<string>\",\n \"default_hs_code\": \"<string>\",\n \"requires_shipping\": true,\n \"cost\": {\n \"amount\": 50000,\n \"currency_code\": \"USD\"\n },\n \"destination_country_hs_codes\": [\n {\n \"destination_country_code\": \"<string>\",\n \"hs_code\": \"<string>\"\n }\n ]\n },\n \"dimensions\": {\n \"depth\": 123,\n \"width\": 123,\n \"height\": 123\n },\n \"locale_data\": [\n {\n \"locale\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Authorization", "<api-key>")
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.patch("https://api.loopreturns.com/api/v1/products/{productId}/product-variants/{id}")
.header("X-Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"sku\": \"<string>\",\n \"weight_grams\": 123,\n \"barcode\": \"<string>\",\n \"price\": {\n \"amount\": 50000,\n \"currency_code\": \"USD\"\n },\n \"images\": [\n \"<string>\"\n ],\n \"options\": [\n {\n \"position\": 123,\n \"value\": \"<string>\"\n }\n ],\n \"logistics_information\": {\n \"origin_country_code\": \"<string>\",\n \"origin_region_code\": \"<string>\",\n \"default_hs_code\": \"<string>\",\n \"requires_shipping\": true,\n \"cost\": {\n \"amount\": 50000,\n \"currency_code\": \"USD\"\n },\n \"destination_country_hs_codes\": [\n {\n \"destination_country_code\": \"<string>\",\n \"hs_code\": \"<string>\"\n }\n ]\n },\n \"dimensions\": {\n \"depth\": 123,\n \"width\": 123,\n \"height\": 123\n },\n \"locale_data\": [\n {\n \"locale\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.loopreturns.com/api/v1/products/{productId}/product-variants/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"sku\": \"<string>\",\n \"weight_grams\": 123,\n \"barcode\": \"<string>\",\n \"price\": {\n \"amount\": 50000,\n \"currency_code\": \"USD\"\n },\n \"images\": [\n \"<string>\"\n ],\n \"options\": [\n {\n \"position\": 123,\n \"value\": \"<string>\"\n }\n ],\n \"logistics_information\": {\n \"origin_country_code\": \"<string>\",\n \"origin_region_code\": \"<string>\",\n \"default_hs_code\": \"<string>\",\n \"requires_shipping\": true,\n \"cost\": {\n \"amount\": 50000,\n \"currency_code\": \"USD\"\n },\n \"destination_country_hs_codes\": [\n {\n \"destination_country_code\": \"<string>\",\n \"hs_code\": \"<string>\"\n }\n ]\n },\n \"dimensions\": {\n \"depth\": 123,\n \"width\": 123,\n \"height\": 123\n },\n \"locale_data\": [\n {\n \"locale\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"product_variant": {
"id": 2,
"external_id": "<string>",
"sku": "<string>",
"name": "<string>",
"weight_grams": 123,
"barcode": "<string>",
"product": {
"id": 2,
"external_id": "<string>",
"sku": "<string>",
"name": "<string>"
},
"price": {
"amount": 50000,
"currency_code": "USD"
},
"images": [
"<string>"
],
"inventories": [
{
"id": 2,
"available_count": 123,
"location": {
"id": 2,
"external_id": "<string>",
"name": "<string>"
}
}
],
"options": [
{
"position": 123,
"value": "<string>"
}
],
"logistics_information": {
"origin_country_code": "<string>",
"origin_region_code": "<string>",
"default_hs_code": "<string>",
"requires_shipping": true,
"cost": {
"amount": 50000,
"currency_code": "USD"
},
"destination_country_hs_codes": [
{
"destination_country_code": "<string>",
"hs_code": "<string>"
}
]
},
"dimensions": {
"depth": 123,
"width": 123,
"height": 123
}
}
}"<unknown>""<unknown>"Authorizations
API Scope: "Product (write)"
Path Parameters
The unique Loop identifier of the parent product.
The product variant's unique identifier.
Body
application/json
The name of the product variant.
Example:
"Classic Brown Dress Shoes - Size 12"
The identifier used by an external source to identify the product variant. Must be unique within the shop. If a non-unique external_id is provided, the API will respond with an error.
Maximum string length:
64Example:
"564400c7-7a6b-4f29-b6a5-7bb580b2992c"
The SKU of the product variant.
Maximum string length:
255Example:
"SHOES-US44-M-Brwn"
The weight of the product variant in grams.
Example:
440
The barcode of the product variant.
Maximum string length:
255Example:
712345000019
The price of the product variant in minor units, such as cents, with its corresponding currency.
Show child attributes
Show child attributes
Example:
{ "amount": 50000, "currency_code": "USD" }
An array of URLs which reference images of the product.
Minimum string length:
1An array of optional features or characteristics of the product variant that can be selected by the customer.
Show child attributes
Show child attributes
The logistics information for the product variant such as code classification, shipping, and cost.
Show child attributes
Show child attributes
The dimensions of the product variant, interpreted as inches. Optional and nullable. When provided, depth, width, and height are all required. Omit dimensions to leave any stored dimensions untouched, or send null to delete the stored dimensions.
Show child attributes
Show child attributes
Translated content for this product variant, one entry per locale. Locales must be unique within the array. Update-time behavior (overwrite vs. merge with any existing translations) is not yet defined — this field is currently validation-only, ahead of the persistence work that will define it.
Show child attributes
Show child attributes
Response
Success
Show child attributes
Show child attributes
⌘I