Item

Type.

An `Item` represents the input for a shopping cart `Item` to be quoted for Landed Cost, Shipment Rating, etc. `Item` is not intended to be stored and used long-term for things like the catalog; it is purely a method for moving data around.

Fields

•

ID!

Required

Item ID, prefixed with item_.

customsSpecs

•

[CustomsSpec!]!

Required

No description

amount

•

Decimal!

Required

Item price amount.

amountInclusive

•

Decimal

Item price all inclusive amount if inclusive amount is enabled.

attributes

•

[ItemAttribute]

Free-form Item attributes.

catalogItem

•

CatalogItem

Link to an existing CatalogItem that contains more info about this Item.

countryOfOrigin

•

CountryCode

Country where the Item originates.

countryOfOriginSource

•

ItemValueSource

Indicates where the CountryOfOrigin was sourced from.

createdAt

•

DateTime!

Required

When this Item was created.

createdBy

•

ID!

Required

The user that created this Item.

currencyCode

•

CurrencyCode!

Required

The currency this Item price amount is in.

customsDescription

•

String

The description of the Item for customs.

description

•

String

Human-readable Item description.

dutyTaxFeeConfiguration

•

DutyTaxFeeConfiguration

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

hsCode

•

String

HS code for this Item.

hsCodeSource

•

ItemValueSource

Indicates where the HS code for this Item was acquired.

imageUrl

•

String

Optional URL to an image that represents this Item.

itemType

•

ItemType

Determines whether or not an item can be physically shipped.

measurements

•

[ItemMeasurement]

List of Item weights and dimensions.

metadata

•

[ItemMetadata]

User-accessible key/value metadata.

mode

•

Mode!

Required

Whether this Item was created in live or test mode.

name

•

String

Human readable item name.

organization

•

ID!

Required

The unique identifier associated with an organization.

packingPreference

•

PackingPreference

The packing options of the item

parentProductId

•

String

The product ID of the parent Item for multi-SKU situations.

productId

•

String!

Required

The Item product ID.

provinceOfOrigin

•

String

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

quantity

•

Int!

Required

Quantity of this specific Item being represented.

restriction

•

RestrictedItem

when the item is restricted, this property will have some details as to why.

sku

•

String

SKU of this Item.

updatedAt

•

DateTime!

Required

When this Item was most recently updated.

updatedBy

•

ID!

Required

User who most recently updated this Item.

Was this page helpful?