Update Line Items

curl --request POST \
  --url https://api.puppetvendors.com/v1/lineitems/update \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "items": [
    {
      "lineItemId": 123,
      "orderId": 123,
      "fields": {},
      "recalculate": true
    }
  ],
  "bySku": "<string>",
  "fields": {},
  "recalculate": true
}
'

import requests

url = "https://api.puppetvendors.com/v1/lineitems/update"

payload = {
    "items": [
        {
            "lineItemId": 123,
            "orderId": 123,
            "fields": {},
            "recalculate": True
        }
    ],
    "bySku": "<string>",
    "fields": {},
    "recalculate": True
}
headers = {
    "x-access-token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    items: [{lineItemId: 123, orderId: 123, fields: {}, recalculate: true}],
    bySku: '<string>',
    fields: {},
    recalculate: true
  })
};

fetch('https://api.puppetvendors.com/v1/lineitems/update', 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.puppetvendors.com/v1/lineitems/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'items' => [
        [
                'lineItemId' => 123,
                'orderId' => 123,
                'fields' => [
                                
                ],
                'recalculate' => true
        ]
    ],
    'bySku' => '<string>',
    'fields' => [
        
    ],
    'recalculate' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-access-token: <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.puppetvendors.com/v1/lineitems/update"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"lineItemId\": 123,\n      \"orderId\": 123,\n      \"fields\": {},\n      \"recalculate\": true\n    }\n  ],\n  \"bySku\": \"<string>\",\n  \"fields\": {},\n  \"recalculate\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-access-token", "<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.post("https://api.puppetvendors.com/v1/lineitems/update")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"lineItemId\": 123,\n      \"orderId\": 123,\n      \"fields\": {},\n      \"recalculate\": true\n    }\n  ],\n  \"bySku\": \"<string>\",\n  \"fields\": {},\n  \"recalculate\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.puppetvendors.com/v1/lineitems/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"lineItemId\": 123,\n      \"orderId\": 123,\n      \"fields\": {},\n      \"recalculate\": true\n    }\n  ],\n  \"bySku\": \"<string>\",\n  \"fields\": {},\n  \"recalculate\": true\n}"

response = http.request(request)
puts response.read_body

POST

lineitems

update

Update Line Items

curl --request POST \
  --url https://api.puppetvendors.com/v1/lineitems/update \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "items": [
    {
      "lineItemId": 123,
      "orderId": 123,
      "fields": {},
      "recalculate": true
    }
  ],
  "bySku": "<string>",
  "fields": {},
  "recalculate": true
}
'

import requests

url = "https://api.puppetvendors.com/v1/lineitems/update"

payload = {
    "items": [
        {
            "lineItemId": 123,
            "orderId": 123,
            "fields": {},
            "recalculate": True
        }
    ],
    "bySku": "<string>",
    "fields": {},
    "recalculate": True
}
headers = {
    "x-access-token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    items: [{lineItemId: 123, orderId: 123, fields: {}, recalculate: true}],
    bySku: '<string>',
    fields: {},
    recalculate: true
  })
};

fetch('https://api.puppetvendors.com/v1/lineitems/update', 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.puppetvendors.com/v1/lineitems/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'items' => [
        [
                'lineItemId' => 123,
                'orderId' => 123,
                'fields' => [
                                
                ],
                'recalculate' => true
        ]
    ],
    'bySku' => '<string>',
    'fields' => [
        
    ],
    'recalculate' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-access-token: <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.puppetvendors.com/v1/lineitems/update"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"lineItemId\": 123,\n      \"orderId\": 123,\n      \"fields\": {},\n      \"recalculate\": true\n    }\n  ],\n  \"bySku\": \"<string>\",\n  \"fields\": {},\n  \"recalculate\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-access-token", "<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.post("https://api.puppetvendors.com/v1/lineitems/update")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"lineItemId\": 123,\n      \"orderId\": 123,\n      \"fields\": {},\n      \"recalculate\": true\n    }\n  ],\n  \"bySku\": \"<string>\",\n  \"fields\": {},\n  \"recalculate\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.puppetvendors.com/v1/lineitems/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"lineItemId\": 123,\n      \"orderId\": 123,\n      \"fields\": {},\n      \"recalculate\": true\n    }\n  ],\n  \"bySku\": \"<string>\",\n  \"fields\": {},\n  \"recalculate\": true\n}"

response = http.request(request)
puts response.read_body

Overview

Update financial fields on line items (report data) and cost of goods records. Supports updating specific line items by ID or bulk-updating all line items matching a SKU. The endpoint accepts two mutually exclusive modes:

Items mode — update specific line items by Shopify line item ID and order ID
By SKU mode — update all line items matching a SKU

Items Mode

Target specific line items by Shopify line item ID and order ID.

array

required

Array of line item update objects (max 100 per request).

Show Item object properties

number

required

Shopify line item ID.

number

required

Shopify order ID.

object

Fields to update. See Updatable Fields below. Either fields or recalculate (or both) must be provided.

boolean

Set to true to trigger recalculation after updating. When combined with fields, the fields are written to the DB first, then recalculation is queued.

Example

{
  "items": [
    {
      "lineItemId": 12345678901234,
      "orderId": 98765432101234,
      "fields": {
        "costOfItem": 15.50,
        "commission": 5.00
      }
    }
  ]
}

By SKU Mode

Update all line items matching a SKU value for your shop.

string

required

The SKU value to match.

object

Fields to update. Required when recalculate is not true. See Updatable Fields below.

boolean

Set to true to trigger recalculation for all matching line items.

Example

{
  "bySku": "SKU-001",
  "fields": {
    "costOfItem": 15.50
  }
}

Updatable Fields

Only the following fields are accepted. Unknown fields will be rejected.

Field	Type	Description
`costOfItem`	Number	Cost of goods for this line item. Also updates the SKU cost of goods record (creates one if it does not exist).
`commission`	Number	Commission amount
`commissionPlan`	String	Commission plan label (e.g. “14%“)
`deduction`	Number	Vendor deduction
`payout`	Number	Vendor payout amount
`shipping`	Number	Shipping amount
`sales`	Number	Sales amount
`salesAfterDiscount`	Number	Sales after discount
`tax`	Number	Tax amount
`tcs`	Number	TCS amount
`taxOnCommissions`	Number	Tax on commissions
`totalGlobalDeductions`	Number	Global deductions
`discount`	Number	Discount amount

Recalculate Mode

You can trigger the recalculation pipeline by setting recalculate: true. This re-runs the full commission and payout calculations using current shop settings. Recalculation is asynchronous — the response confirms it has been queued, not completed. You can combine fields with recalculate: true to update fields first, then recalculate. This is useful when you want to set a new cost of goods and immediately recalculate the payout based on that value.

{
  "items": [
    {
      "lineItemId": 12345678901234,
      "orderId": 98765432101234,
      "fields": { "costOfItem": 15.50 },
      "recalculate": true
    }
  ]
}

{
  "items": [
    {
      "lineItemId": 12345678901234,
      "orderId": 98765432101234,
      "recalculate": true
    }
  ]
}

{
  "bySku": "SKU-001",
  "recalculate": true
}

Response

Success

Possible status values: "updated", "recalculate_queued", "updated_and_recalculate_queued".

200

{
  "success": true,
  "updated": 1,
  "recalculateQueued": 1,
  "results": [
    { "lineItemId": 123, "orderId": 456, "status": "updated_and_recalculate_queued" }
  ],
  "errors": []
}

Partial Failure

When some items succeed and others fail, the response includes both results and errors.

200

{
  "success": false,
  "updated": 1,
  "recalculateQueued": 0,
  "results": [
    { "lineItemId": 123, "orderId": 456, "status": "updated" }
  ],
  "errors": [
    { "lineItemId": 999, "orderId": 888, "error": "Line item not found" }
  ]
}

Validation Error

422

{
  "error": "Description of the validation error"
}

Important Notes

Frozen line items are automatically skipped and reported in the errors array.

When costOfItem is included in fields, the SKU cost of goods record is automatically updated (or created if it does not exist). This ensures future recalculations use the correct COGS value.

Shop isolation: All updates are scoped to your authenticated shop. You cannot update line items belonging to other shops.
Max 100 items per request when using items mode.
Mutually exclusive modes: Provide either items or bySku, not both.

Examples

Update cost of goods by SKU

curl -X POST https://api.puppetvendors.com/v1/lineitems/update \
  -H "Content-Type: application/json" \
  -H "x-access-token: YOUR_JWT_TOKEN" \
  -d '{
    "bySku": "SKU-001",
    "fields": { "costOfItem": 15.50 }
  }'

Update specific line items

curl -X POST https://api.puppetvendors.com/v1/lineitems/update \
  -H "Content-Type: application/json" \
  -H "x-access-token: YOUR_JWT_TOKEN" \
  -d '{
    "items": [
      {
        "lineItemId": 12345678901234,
        "orderId": 98765432101234,
        "fields": {
          "costOfItem": 15.50,
          "payout": 25.00
        }
      }
    ]
  }'

Trigger recalculation by SKU

curl -X POST https://api.puppetvendors.com/v1/lineitems/update \
  -H "Content-Type: application/json" \
  -H "x-access-token: YOUR_JWT_TOKEN" \
  -d '{
    "bySku": "SKU-001",
    "recalculate": true
  }'

Getting Started

Vendors

Users

Orders

Products

Payouts

Fulfillments

Commissions

Reports

Line Items

Update Line Items

Overview

Items Mode

Example

By SKU Mode

Example

Updatable Fields

Recalculate Mode

Response

Success

Partial Failure

Validation Error

Important Notes

Examples

Update cost of goods by SKU

Update specific line items

Trigger recalculation by SKU

​Overview

​Items Mode

​Example

​By SKU Mode

​Example

​Updatable Fields

​Recalculate Mode

​Response

​Success

​Partial Failure

​Validation Error

​Important Notes

​Examples

​Update cost of goods by SKU

​Update specific line items

​Trigger recalculation by SKU

Overview

Items Mode

Example

By SKU Mode

Example

Updatable Fields

Recalculate Mode

Response

Success

Partial Failure

Validation Error

Important Notes

Examples

Update cost of goods by SKU

Update specific line items

Trigger recalculation by SKU