Retrieve Product

Beta

GET/v1/catalog/products/{id}

This endpoint is idempotent. Learn more

Returns a product by ID.

idstring

Product ID.

include[]optional arrayenumValues:product_lineproduct_line.unit_groupproduct_line.unit_group.base_unit

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

idstring

Product ID.

objectstringenumValues:product

Resource type identifier.

typestringenumValues:saleserviceshipping

Product type code.

portal_visibilitystringenumValues:visiblehidden

Product portal visibility.

product_lineobjectExpandablenullable

Product line.

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.

ownerobjectnullable

Owner of the product line.

Always returned as null in this endpoint.

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_unitobjectExpandablenullable

Base unit.

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Unit dimension.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension. Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions. Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator. Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension. Conversion ratios are relative to this unit.

ownerobjectnullable

Owner of this resource.

Always returned as null in this endpoint.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

associated_unitsobjectExpandablenullable

Associated units.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

URL to fetch the next page, null if no more pages.

previous_page_urlstringnullable

URL to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

idstring

Unit group unit ID.

objectstringenumValues:unit_group_unit

Resource type identifier.

unitobjectnullable

Unit.

Always returned as null in this endpoint.

discount_percentagenumber

Discount percentage.

discount_fixednumber

Fixed discount amount.

customer_portal_visibilitystringenumValues:visiblehidden

Customer portal visibility.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ownerobjectnullable

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.

itemobjectExpandablenullable

Item.

idstring

Item ID.

objectstringenumValues:item

Resource type identifier.

skustring

Stock keeping unit code.

descriptionstringnullable

Item description.

notesstringnullable

Notes.

typestringenumValues:productmaterialpart

Item type code.

categoryobjectExpandablenullable

Item category.

idstring

Item category ID.

objectstringenumValues:item_category

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes.

typestringenumValues:material_categoryproduct_category

Item category type.

ownerobjectnullable

Owner of the item category.

Always returned as null in this endpoint.

propertiesobjectExpandablenullable

Properties associated with this item category.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

URL to fetch the next page, null if no more pages.

previous_page_urlstringnullable

URL to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

idstring

Property ID.

objectstringenumValues:property

Resource type identifier.

namestring

Display name.

attributesobjectnullable

Attributes belonging to this property.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

unit_groupobjectExpandablenullable

Unit group associated with this item category. This unit group dictates the available units that items in this category 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_unitobjectExpandablenullable

Base unit.

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Unit dimension.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension. Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions. Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator. Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension. Conversion ratios are relative to this unit.

ownerobjectnullable

Owner of this resource.

Always returned as null in this endpoint.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

associated_unitsobjectExpandablenullable

Associated units.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

URL to fetch the next page, null if no more pages.

previous_page_urlstringnullable

URL to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

idstring

Unit group unit ID.

objectstringenumValues:unit_group_unit

Resource type identifier.

unitobjectnullable

Unit.

Always returned as null in this endpoint.

discount_percentagenumber

Discount percentage.

discount_fixednumber

Fixed discount amount.

customer_portal_visibilitystringenumValues:visiblehidden

Customer portal visibility.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ownerobjectnullable

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.

unit_valueobjectExpandablenullable

Unit value rate.

idstring

Rate ID.

objectstringenumValues:rate

Resource type identifier.

valuestring (decimal)

Rate value as a decimal string.

numerator_unitobjectnullable

Numerator unit.

Always returned as null in this endpoint.

denominator_unitobjectnullable

Denominator unit.

Always returned as null in this endpoint.

display_valuestring

Human-readable formatted value (e.g. "$25.50 / kg" or "100 kg / hr").

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

unit_costobjectExpandablenullable

Unit cost rate.

idstring

Rate ID.

objectstringenumValues:rate

Resource type identifier.

valuestring (decimal)

Rate value as a decimal string.

numerator_unitobjectnullable

Numerator unit.

Always returned as null in this endpoint.

denominator_unitobjectnullable

Denominator unit.

Always returned as null in this endpoint.

display_valuestring

Human-readable formatted value (e.g. "$25.50 / kg" or "100 kg / hr").

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

burn_rateobjectExpandablenullable

Burn rate.

idstring

Rate ID.

objectstringenumValues:rate

Resource type identifier.

valuestring (decimal)

Rate value as a decimal string.

numerator_unitobjectnullable

Numerator unit.

Always returned as null in this endpoint.

denominator_unitobjectnullable

Denominator unit.

Always returned as null in this endpoint.

display_valuestring

Human-readable formatted value (e.g. "$25.50 / kg" or "100 kg / hr").

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

attributesobjectExpandablenullable

Attributes assigned to this item.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

URL to fetch the next page, null if no more pages.

previous_page_urlstringnullable

URL to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

idstring

Attribute ID.

objectstringenumValues:attribute

Resource type identifier.

valuestring

Attribute value.

colorstringenumValues:bluebrowndefault

Color code.

sort_orderinteger

Display order.

propertyobjectnullable

Property this attribute belongs to (set when the attribute is returned under item.attributes).

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

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

Retrieve Product

import Augno from '@augno/sdk';

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

const product = await client.catalog.products.retrieve('pd_013c29ab3f1518d0004094c316');

console.log(product.id);

import Augno from '@augno/sdk';

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

const product = await client.catalog.products.retrieve('pd_013c29ab3f1518d0004094c316');

console.log(product.id);

200 example

{
  "id": "pd_013c29ab3f1518d0004094c316",
  "object": "product",
  "type": "sale",
  "portal_visibility": "visible",
  "product_line": {
    "id": "pl_01996357326a0d3f7b129542ea",
    "object": "product_line",
    "name": "Industrial Fasteners",
    "commission_policy": "commission_exempt",
    "freight_policy": "billed_freight",
    "owner": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "item": {
    "id": "it_0131e386ac683e8c29a71f6f1f",
    "object": "item",
    "sku": "ALM-2024-1001",
    "description": "6061-T6 aluminum sheet, 4ft x 8ft, 0.125in thick",
    "type": "product",
    "category": {
      "id": "ic_01ae7bd7bfd21ca0ab81e1357e",
      "object": "item_category",
      "name": "Electronics",
      "type": "material_category",
      "owner": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "unit_value": {
      "id": "ra_015aa0a9522cf222024fd21d1a",
      "object": "rate",
      "value": "25.500000000000000000000000000000",
      "numerator_unit": null,
      "denominator_unit": null,
      "display_value": "$25.50 / kg",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "unit_cost": {
      "id": "ra_015aa0a9522cf222024fd21d1a",
      "object": "rate",
      "value": "25.500000000000000000000000000000",
      "numerator_unit": null,
      "denominator_unit": null,
      "display_value": "$25.50 / kg",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "burn_rate": {
      "id": "ra_015aa0a9522cf222024fd21d1a",
      "object": "rate",
      "value": "25.500000000000000000000000000000",
      "numerator_unit": null,
      "denominator_unit": null,
      "display_value": "$25.50 / kg",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "attributes": {
      "object": "list",
      "page_info": {
        "has_next_page": false,
        "has_prev_page": false
      },
      "data": [
        {
          "id": "at_01c9493ec0c46bb0ed12708ae4",
          "object": "attribute",
          "value": "Premium",
          "color": "red",
          "sort_order": 1,
          "created_at": "2026-05-10T00:00:00Z",
          "updated_at": "2026-05-10T00:23:00Z"
        }
      ]
    },
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "pd_013c29ab3f1518d0004094c316",
  "object": "product",
  "type": "sale",
  "portal_visibility": "visible",
  "product_line": {
    "id": "pl_01996357326a0d3f7b129542ea",
    "object": "product_line",
    "name": "Industrial Fasteners",
    "commission_policy": "commission_exempt",
    "freight_policy": "billed_freight",
    "owner": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "item": {
    "id": "it_0131e386ac683e8c29a71f6f1f",
    "object": "item",
    "sku": "ALM-2024-1001",
    "description": "6061-T6 aluminum sheet, 4ft x 8ft, 0.125in thick",
    "type": "product",
    "category": {
      "id": "ic_01ae7bd7bfd21ca0ab81e1357e",
      "object": "item_category",
      "name": "Electronics",
      "type": "material_category",
      "owner": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "unit_value": {
      "id": "ra_015aa0a9522cf222024fd21d1a",
      "object": "rate",
      "value": "25.500000000000000000000000000000",
      "numerator_unit": null,
      "denominator_unit": null,
      "display_value": "$25.50 / kg",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "unit_cost": {
      "id": "ra_015aa0a9522cf222024fd21d1a",
      "object": "rate",
      "value": "25.500000000000000000000000000000",
      "numerator_unit": null,
      "denominator_unit": null,
      "display_value": "$25.50 / kg",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "burn_rate": {
      "id": "ra_015aa0a9522cf222024fd21d1a",
      "object": "rate",
      "value": "25.500000000000000000000000000000",
      "numerator_unit": null,
      "denominator_unit": null,
      "display_value": "$25.50 / kg",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "attributes": {
      "object": "list",
      "page_info": {
        "has_next_page": false,
        "has_prev_page": false
      },
      "data": [
        {
          "id": "at_01c9493ec0c46bb0ed12708ae4",
          "object": "attribute",
          "value": "Premium",
          "color": "red",
          "sort_order": 1,
          "created_at": "2026-05-10T00:00:00Z",
          "updated_at": "2026-05-10T00:23:00Z"
        }
      ]
    },
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Retrieve Product

Path Parameters

Query Parameters

Returns

Responses