Types > CustomerInventory
Commerce APITypesCustomerInventory
CustomerInventory

Description

Topic: Customer Inventory

Fields

created_at: String!

Date and time item was added to inventory

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


customer: Customer

Customer this inventory item belongs to

Expandable

Permission bit: "customers.read"


disabled_at: String

Date and time item was disabled

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


download_limit: Int

Total amount of times it is allowed to download the digital product

Example: 50


downloaded_times: Int

Amount of times the digital product was downloaded

Example: 5


email_message: Message

Email that was sent to notify customer about this item (you can use it to perform a resend)

Expandable

Permission bit: "messages.read"


expires_at: String

Date and time when item expires

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


gift_card_amount: Int

Amount of money gift card represents

Example: 10000


gift_card_code: String

Unique generated gift card code (shop owner/users only)

Example: "H35K-DJKS-75TK-TJR4"


gift_card_code_last4: String

Unique generated gift card code (last 4 symbols)

Example: "TJR4"


gift_card_used: Boolean

Whether gift card was used or not

Example: false


id: String!

Unique customer inventory item identifier. See also: Unique Identifiers

Example: "ii_EQzGqWoY"


order: Order

Order this inventory item originated from

Expandable

Permission bit: "orders.read"


type: CustomerInventoryType!

Type of item

Example: "gift_card"


updated_at: String!

Date and time when the item was last modified

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


variant: ProductVariant

Product variant of this inventory item

Expandable

Permission bit: "product_variants.read"


Used By

Mutations

customerInventoryCreate, customerInventoryModify

Queries

customerInventory

Types

CustomerInventoryExpandableItems, CustomerInventoryPage, CustomerInventorySearchResult, FulfillmentLineItem, UnifiedSearchResult

Preview (typescript)

Loading module