Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Item

Hierarchy

Index

Properties

Properties

Optional Readonly child

child?: Core.Graph

curie

curie: "fx:item"

links

links: { fx:transaction: any; self: Customer.Rels.Item }

Type declaration

  • fx:transaction: any

    Related transaction info.

  • self: Customer.Rels.Item

    This resource.

props

props: { code: string; date_created: null | string; date_modified: null | string; discount_details: string; discount_name: string; discount_type: "" | "quantity_amount" | "quantity_percentage" | "price_amount" | "price_percentage"; expires: number; height: number; image: string; is_future_line_item: boolean; length: number; name: string; parent_code: string; price: number; quantity: number; quantity_max: number; quantity_min: number; shipto: string; subscription_end_date: string; subscription_frequency: string; subscription_next_transaction_date: string; subscription_start_date: string; url: string; weight: number; width: number }

Type declaration

  • code: string

    Item code. Can be used however you would like (internal use, product SKU, etc.).

  • date_created: null | string

    The date this resource was created.

  • date_modified: null | string

    The date this resource was last modified.

  • discount_details: string

    The details of the line item discount if this item has a discount. See the cart documentation for details on how this value should be formatted.

  • discount_name: string

    The name of the line item discount if it is included on this item.

  • discount_type: "" | "quantity_amount" | "quantity_percentage" | "price_amount" | "price_percentage"

    The type of the line item discount if this item has a discount.

  • expires: number

    As a unix timestamp, this is the point in the future when this item will no longer be valid and will be removed from the cart.

  • height: number

    The width of this item. This is currently a place holder for future use.

  • image: string

    The full image url for the customer to view an image of this item online.

  • is_future_line_item: boolean

    If this item is part of a future subscription (or a subscription originally set up to start in the future), this will be set to true.

  • length: number

    The length of this item. This is currently a place holder for future use.

  • name: string

    The name of this item.

  • parent_code: string

    Parent item code. Used if this should be a child product in a bundle.

  • price: number

    The price of this item. This represents the base price of the item before any item option modifiers.

  • quantity: number

    The number of items in the cart or transaction. When adding products to the cart, if all properties are identical, the quantity will be incremented accordingly.

  • quantity_max: number

    Maximum quantity that should be allowed per product, per cart. If the quantity is more than this, the quantity will be updated automatically to this amount.

  • quantity_min: number

    Minimum quantity that should be allowed per product, per cart. If the quantity is less than this, the quantity will be updated automatically to this number.

  • shipto: string

    Used for multiship to assign this item to a specific shipment. This value will be the address name of the shipment.

  • subscription_end_date: string

    If set, the date this subscription will end. The subscription will not run on this day.

  • subscription_frequency: string

    This determines how often this subscription will be processed. The format is a number followed by a date type such as d (day), w (week), m (month), or y (year). You can also use .5m for twice a month. To modify this value for an existing subscription, you must modify the subscription directly.

  • subscription_next_transaction_date: string

    The date for when this subscription will run again. To modify this value for an existing subscription, you must modify the subscription directly.

  • subscription_start_date: string

    The original date this subscription began or will begin if set in the future. To modify this value for an existing subscription, you must modify the subscription directly.

  • url: string

    The full item url for the customer to view this item online.

  • weight: number

    This item's per-item weight, used for shipping rate requests.

  • width: number

    The width of this item. This is currently a place holder for future use.

Optional Readonly zooms

zooms?: Readonly<Record<string, undefined | Core.Graph>>

Generated using TypeDoc