DEV

Input.

ItemCreateWorkflowInput

Input to create a new Item.

Fields

amount

Decimal

Item unit price before multiplying by quantity. Example: if you have 2 items that cost $5 each, the amount is 5, not 10. If not provide the totalAmount is required.
Free-form Item attributes.

categories

[String!]

List of categories associated and describing the Item

countryOfOrigin

CountryCode

Country where the Item originates.

currencyCode

CurrencyCode!

Required

The currency this Item price amount is in.

description

String

Description of the Item.

dutyTaxFeeConfiguration

DutyTaxFeeConfiguration

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

hsCode

String

HS code for this Item.

hsCodeSource

ItemValueSource

HS code source for this Item.

imageUrl

String

Optional URL to an image that represents this Item.

itemType

ItemType

Determines whether or not an item can be physically shipped.

measurements

[ItemMeasurementInput]

List of Item weights and dimensions.
User-accessible key/value metadata.

name

String

Name of the Item.

productComposition

[ItemCompositionInput!]

the composition of your product

productId

String

The Item product ID.

provinceOfOrigin

String

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

quantity

Int!

Required

This value coordinates with the amount. Example: if you have 2 items that cost $5 each, then you would put a quantity of 2 and an amount of 5. amount: 5 quantity: 2 total = amount * quantity = 10 OR amount: 10 quantity: 1 total = amount * quantity = 10

reverseAmountDetail

ItemReverseAmountDetailInput

The reverse amount details for this item.

sku

String

SKU of the Item.

totalAmount

Decimal

Optional: The line items total amount. If provided the amount will be computed from the totalAmount / quantity.

Was this page helpful?