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

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>"
}
'

200

{
  "variant": {
    "id": "<string>",
    "productId": "<string>",
    "sku": "<string>",
    "title": "<string>",
    "handlingFee": 123,
    "manualCostHistory": [
      {
        "id": "<string>",
        "cost": 123,
        "effectiveStartDate": "<string>",
        "effectiveEndDate": "<string>",
        "description": "<string>"
      }
    ]
  }
}

Authorizations

x-api-key · string · header · required

Your Upstack API key. Starts with upstack_.

x-pixel-id · string · header · required

The pixel id the request targets.

Path Parameters

productId · string · required

variantId · string · required

cogId · string · required

Body

application/json

All fields optional — only the supplied fields are updated.

cost · number

effectiveStartDate · string

effectiveEndDate · string | null

description · string

Response

200

application/json

The updated variant.

variant · object · required

A single SKU under a product. manualCostHistory is the chronological list of COG lines.

Show child attributes