Update a COG line
curl --request PUT \
--url https://api.upstackdata.com/accounts/api/products/{productId}/{variantId}/cogs/{cogId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-pixel-id: <api-key>' \
--data '
{
"cost": 123,
"effectiveStartDate": "<string>",
"effectiveEndDate": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.upstackdata.com/accounts/api/products/{productId}/{variantId}/cogs/{cogId}"
payload = {
"cost": 123,
"effectiveStartDate": "<string>",
"effectiveEndDate": "<string>",
"description": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"x-pixel-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-api-key': '<api-key>',
'x-pixel-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
cost: 123,
effectiveStartDate: '<string>',
effectiveEndDate: '<string>',
description: '<string>'
})
};
fetch('https://api.upstackdata.com/accounts/api/products/{productId}/{variantId}/cogs/{cogId}', 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.upstackdata.com/accounts/api/products/{productId}/{variantId}/cogs/{cogId}",
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([
'cost' => 123,
'effectiveStartDate' => '<string>',
'effectiveEndDate' => '<string>',
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-pixel-id: <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.upstackdata.com/accounts/api/products/{productId}/{variantId}/cogs/{cogId}"
payload := strings.NewReader("{\n \"cost\": 123,\n \"effectiveStartDate\": \"<string>\",\n \"effectiveEndDate\": \"<string>\",\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-pixel-id", "<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.put("https://api.upstackdata.com/accounts/api/products/{productId}/{variantId}/cogs/{cogId}")
.header("x-api-key", "<api-key>")
.header("x-pixel-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cost\": 123,\n \"effectiveStartDate\": \"<string>\",\n \"effectiveEndDate\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upstackdata.com/accounts/api/products/{productId}/{variantId}/cogs/{cogId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["x-pixel-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cost\": 123,\n \"effectiveStartDate\": \"<string>\",\n \"effectiveEndDate\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"variant": {
"id": "<string>",
"productId": "<string>",
"sku": "<string>",
"title": "<string>",
"handlingFee": 123,
"manualCostHistory": [
{
"id": "<string>",
"cost": 123,
"effectiveStartDate": "<string>",
"effectiveEndDate": "<string>",
"description": "<string>"
}
]
}
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}PRODUCTS
Update a COG line
Update an existing COG line by its server-assigned ID. Only the supplied fields are updated; omitted fields stay as-is. Triggers a per-order COGS recalculation downstream.
Required scope: costs:write.
PUT
/
accounts
/
api
/
products
/
{productId}
/
{variantId}
/
cogs
/
{cogId}
Update a COG line
curl --request PUT \
--url https://api.upstackdata.com/accounts/api/products/{productId}/{variantId}/cogs/{cogId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-pixel-id: <api-key>' \
--data '
{
"cost": 123,
"effectiveStartDate": "<string>",
"effectiveEndDate": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.upstackdata.com/accounts/api/products/{productId}/{variantId}/cogs/{cogId}"
payload = {
"cost": 123,
"effectiveStartDate": "<string>",
"effectiveEndDate": "<string>",
"description": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"x-pixel-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-api-key': '<api-key>',
'x-pixel-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
cost: 123,
effectiveStartDate: '<string>',
effectiveEndDate: '<string>',
description: '<string>'
})
};
fetch('https://api.upstackdata.com/accounts/api/products/{productId}/{variantId}/cogs/{cogId}', 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.upstackdata.com/accounts/api/products/{productId}/{variantId}/cogs/{cogId}",
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([
'cost' => 123,
'effectiveStartDate' => '<string>',
'effectiveEndDate' => '<string>',
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-pixel-id: <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.upstackdata.com/accounts/api/products/{productId}/{variantId}/cogs/{cogId}"
payload := strings.NewReader("{\n \"cost\": 123,\n \"effectiveStartDate\": \"<string>\",\n \"effectiveEndDate\": \"<string>\",\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-pixel-id", "<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.put("https://api.upstackdata.com/accounts/api/products/{productId}/{variantId}/cogs/{cogId}")
.header("x-api-key", "<api-key>")
.header("x-pixel-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cost\": 123,\n \"effectiveStartDate\": \"<string>\",\n \"effectiveEndDate\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upstackdata.com/accounts/api/products/{productId}/{variantId}/cogs/{cogId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["x-pixel-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cost\": 123,\n \"effectiveStartDate\": \"<string>\",\n \"effectiveEndDate\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"variant": {
"id": "<string>",
"productId": "<string>",
"sku": "<string>",
"title": "<string>",
"handlingFee": 123,
"manualCostHistory": [
{
"id": "<string>",
"cost": 123,
"effectiveStartDate": "<string>",
"effectiveEndDate": "<string>",
"description": "<string>"
}
]
}
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}Authorizations
Your Upstack API key. Starts with upstack_.
The pixel id the request targets.
Body
application/json
Response
The updated variant.
A single SKU under a product. manualCostHistory is the chronological list of COG lines.
Show child attributes
Show child attributes
Was this page helpful?
⌘I