Update Product Line

Beta

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

Idempotent with Idempotency-Key header. Learn more

Partially updates an account-owned product line. Default system product lines cannot be updated.

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.

commission_policyoptional stringenumValues:commission_appliedcommission_exempt

Commission policy.

freight_policyoptional stringenumValues:free_freightbilled_freight

Freight policy.

unit_group_idoptional string

Unit group ID.

idstring

Product line ID.

objectstringenumValues:product_line

Resource type identifier.

namestring

Display name.

descriptionstringnullable

Description.

notesstringnullable

Notes.

commission_policystringenumValues:commission_appliedcommission_exempt

Commission policy.

freight_policystringenumValues:free_freightbilled_freight

Freight policy.

ownerobjectExpandablenullable

Owner.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

The owner type: "system" for platform defaults, "account" for account-owned resources.

accountobjectExpandablenullable

The account that owns this resource. null if the object is system-owned.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

Display name.

default_billing_addressobjectnullable

Default billing address.

Always returned as null in this endpoint.

default_shipping_addressobjectnullable

Default shipping address.

Always returned as null in this endpoint.

brandingobjectnullable

Branding configuration.

Always returned as null in this endpoint.

portalobjectnullable

Portal configuration.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

unit_groupobjectExpandablenullable

Unit group.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

Responses

200

Successful response for Update Product Line

Update Product Line

curl API_HOST/v1/catalog/product-lines/{id} \
  -X PATCH \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Updated Product Line"
}'

curl API_HOST/v1/catalog/product-lines/{id} \
  -X PATCH \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Updated Product Line"
}'

200 example

{
  "id": "pl_01jm4r6700f8nwq3v5hx2d9ktp",
  "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_01jm4r6700f8nwq3v5hx2d9ktp",
  "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

Path Parameters

Query Parameters

Request Body

Returns

Responses