Update Product Line

Beta

PATCH/v1/catalog/product-lines/{id}

Idempotent with Idempotency-Key header. Learn more

Partially updates an account-owned product line.

Only the provided fields are changed. The reserved default product lines (shipping, service, credit, tax) cannot be updated.

Permissions requiredValues:product_lines:update

The role behind your API key or agent must grant every one of these permissions.

idstring

Product line ID.

include[]optional arrayenumValues:ownerowner.accountunit_group

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

nameoptional string

Display name.

Must be unique among the account's product lines; a duplicate name returns a conflict error.

commission_policyoptional stringenumValues:commission_appliedcommission_exempt

Default commission policy for products in this product line.

commission_exempt: no commission applies to these products.
commission_applied: commission applies to these products, unless overridden elsewhere.

freight_policyoptional stringenumValues:free_freightbilled_freight

Default freight policy for products in this product line.

free_freight: these products do not incur a freight charge.
billed_freight: freight is billed for these products, unless overridden elsewhere.

unit_group_idoptional string

ID of the unit group to associate with this product line.

The unit group determines the set of units available to products in this product line.

idstring

Product line ID.

objectstringenumValues:product_line

Resource type identifier.

namestring

Display name of the product line.

descriptionstringnullable

Free-form description of the product line.

notesstringnullable

Free-form notes about the product line.

commission_policystringenumValues:commission_appliedcommission_exempt

Default commission policy for products in this product line.

commission_exempt: no commission applies to these products.
commission_applied: commission applies to these products, unless overridden elsewhere.

freight_policystringenumValues:free_freightbilled_freight

Default freight policy for products in this product line.

free_freight: these products do not incur a freight charge.
billed_freight: freight is billed for these products, unless overridden elsewhere.

ownerownerExpandablenullable

Owner of the product line.

System-owned product lines are platform-provided and shared across all accounts; account-owned product lines are custom to your account.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

system: a platform-provided default shared across all accounts; not editable.
account: created and owned by a specific account; the account field identifies which.

accountaccountExpandablenullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default billing address.

Always returned as null in this endpoint.

default_shipping_addressaddressnullable

Default shipping address.

Always returned as null in this endpoint.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

Always returned as null in this endpoint.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

unit_groupunit_groupExpandablenullable

Unit group associated with this product line.

The unit group determines the set of units available to products in this product line.

idstring

Unit group ID.

objectstringenumValues:unit_group

Resource type identifier.

namestring

Display name of the unit group.

Unique within the account.

notesstringnullable

Free-form notes about the unit group.

typestringenumValues:currencyquantitytime

Physical dimension shared by every unit in this group, such as mass, volume, or currency.

Only units of this dimension can belong to the group.

base_unitunitnullable

The reference unit designated for this group.

Always returned as null in this endpoint.

associated_unitslistnullable

Units associated with this group, each with its own discount and customer portal visibility settings.

Always returned as null in this endpoint.

ownerownerExpandablenullable

Owner of this resource.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

Responses

200

Successful response for Update Product Line

Update Product Line

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const productLine = await client.catalog.productLines.update('pl_01996357326a0d3f7b129542ea', {
  name: 'Updated Product Line',
});

console.log(productLine.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const productLine = await client.catalog.productLines.update('pl_01996357326a0d3f7b129542ea', {
  name: 'Updated Product Line',
});

console.log(productLine.id);

200 example

{
  "id": "pl_01996357326a0d3f7b129542ea",
  "object": "product_line",
  "name": "Industrial Fasteners",
  "description": null,
  "notes": null,
  "commission_policy": "commission_exempt",
  "freight_policy": "billed_freight",
  "owner": {
    "object": "owner",
    "type": "system",
    "account": null
  },
  "unit_group": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "pl_01996357326a0d3f7b129542ea",
  "object": "product_line",
  "name": "Industrial Fasteners",
  "description": null,
  "notes": null,
  "commission_policy": "commission_exempt",
  "freight_policy": "billed_freight",
  "owner": {
    "object": "owner",
    "type": "system",
    "account": null
  },
  "unit_group": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Update Product Line

Authorization

Path Parameters

Query Parameters

Request Body

Returns

Responses