CatalogItem

Type.

A representation of a `CatalogItem`.

Fields

amount

•

Decimal

The amount of a CatalogItem.

attributes

•

[ItemAttribute]

Other CatalogItem attributes.

brand

•

String

The marketing name associated with an item.

catalogItemReferences

•

[CatalogItemReference!]!

Required

Catalog Items that are referenced by this CatalogItem

catalogItemUrl

•

String

The CatalogItem location.

classification

•

The classificationId if an catalogItem was created through classification

configurations

•

[CatalogItemConfiguration]

Country configuration for the item.

countryOfOrigin

•

CountryCode

Where a CatalogItem is manufactured.

createdAt

•

DateTime!

Required

When this CatalogItem was created.

createdBy

•

ID!

Required

The user who created the CatalogItem.

currencyCode

•

CurrencyCode

The currency that the amount of this CatalogItem is in.

customsDescription

•

String

The description of the item for customs

description

•

String

The CatalogItem full description.

dutyTaxFeeConfiguration

•

DutyTaxFeeConfiguration

Allows user to remove items from duties, taxes, or fee calculations

hsCode

•

String

The default hsCode for the product

hsCodes

•

[CatalogItemHsCode]

hsCodes overrides, country or attribute specific for the item

•

ID!

Required

The ID of the CatalogItem.

imageUrl

•

String

The url of an image.

inclusivePrices

•

[CatalogItemInclusivePrice!]

Country inclusive pricing for the item

itemType

•

ItemType

Determines whether or not an item can be physically shipped.

material

•

String

The CatalogItem material composition.

measurements

•

[ItemMeasurement]

A CatalogItem physical measurements.

metadata

•

[ItemMetadata]

Other CatalogItem details ie: vendor_id.

mode

•

Mode!

Required

Whether this Item was created in live or test mode.

name

•

String

The primary name of a CatalogItem.

organization

•

ID!

Required

The unique identifier associated with an organization.

packingPreference

•

PackingPreference

How to pack the CatalogItem for shipment.

productId

•

String

Product ID of the CatalogItem.

provinceOfOrigin

•

String

Optional administrative area where this item originates. Required by some countries.

restrictedCountries

•

[CountryCode]

A list of restricted country code

sku

•

String

SKU of this CatalogItem.

source

•

CatalogItemSource!

Required

Source of CatalogItem.

updatedAt

•

DateTime!

Required

When this CatalogItem was most recently updated.

updatedBy

•

ID!

Required

The user who most recently updated the CatalogItem.

Was this page helpful?