List Product Lines
Beta/v1/catalog/product-linesThis endpoint is idempotent. Learn more
Returns a paginated list of product lines, including account-owned and system product lines.
cursoroptional stringOpaque cursor token identifying where the page of results starts.
Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.
limitoptional integerMaximum number of results to return in a single page.
qoptional stringFree-text search term used to filter results.
Which fields are matched against the term varies by endpoint.
include[]optional arrayenumValues:ownerowner.accountunit_groupSub-objects to expand in the response. When omitted, sub-objects are returned as null.
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
next_page_urlstringnullableRelative URL that fetches the next page of results.
null when the last page has been reached.
previous_page_urlstringnullableRelative URL that fetches the previous page of results.
null while on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of product_lineResources in this page.
idstringProduct line ID.
objectstringenumValues:product_lineResource type identifier.
namestringDisplay name of the product line.
descriptionstringnullableFree-form description of the product line.
notesstringnullableFree-form notes about the product line.
commission_policystringenumValues:commission_appliedcommission_exemptDefault 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_freightDefault 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.
ownerownerExpandablenullableOwner 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:ownerResource type identifier.
typestringenumValues:systemaccountWhere this resource came from.
system: a platform-provided default shared across all accounts; not editable.account: created and owned by a specific account; theaccountfield identifies which.
accountaccountExpandablenullableThe account that owns this resource.
Present only when type is account; system-owned resources have no owning account.
idstringAccount ID.
objectstringenumValues:accountResource type identifier.
namestringThe account's display name.
Default billing address.
null in this endpoint.Default shipping address.
null in this endpoint.brandingaccount_brandingnullableCustomer-facing branding for the account, such as the logo, support contacts, and social links.
null in this endpoint.portalaccount_portalnullableThe account's customer portal settings, including the portal URL slug.
null in this endpoint.created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
Unit group associated with this product line.
The unit group determines the set of units available to products in this product line.
idstringUnit group ID.
objectstringenumValues:unit_groupResource type identifier.
namestringDisplay name of the unit group.
Unique within the account.
notesstringnullableFree-form notes about the unit group.
typestringenumValues:currencyquantitytimePhysical dimension shared by every unit in this group, such as mass, volume, or currency.
Only units of this dimension can belong to the group.
The reference unit designated for this group.
null in this endpoint.Units associated with this group, each with its own discount and customer portal visibility settings.
null in this endpoint.ownerownernullableOwner of this resource.
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
Successful response for List Product Lines