Retrieve Product Line

Beta
GET/v1/catalog/product-lines/{id}

This endpoint is idempotent. Learn more

Returns a product line by ID, including system-owned product lines accessible to the account.

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.

idstring

Product line ID.

objectstringenumValues:product_line

Resource type identifier.

namestring

Display name.

descriptionstringnullable

Description.

notesstringnullable

Notes.

commission_policystringenumValues:commission_appliedcommission_exempt

Commission policy of products in this product line.

freight_policystringenumValues:free_freightbilled_freight

Freight policy for all items in this product line.

ownerobjectExpandablenullable

Owner of the product line.

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 associated with this product line. This unit group dictates the available units that products in this product line may embody in your production process.

idstring

Unit group ID.

objectstringenumValues:unit_group

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes.

typestringenumValues:currencyquantitytime

Unit type.

base_unitobjectnullable

Base unit.

Always returned as null in this endpoint.
associated_unitsobjectnullable

Associated units.

Always returned as null in this endpoint.
ownerobjectExpandablenullable

Owner.

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 Retrieve Product Line