Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TransactionTemplate

Hierarchy

Index

Properties

Properties

Optional Readonly child

child?: Core.Graph

curie

curie: "fx:transaction_template"

links

links: { fx:customer: Customer.Graph; fx:items: Customer.Rels.Items; self: Customer.Rels.TransactionTemplate }

Type declaration

props

props: { billing_address1: string; billing_address2: string; billing_address_name: string; billing_city: string; billing_company: string; billing_country: string; billing_first_name: string; billing_last_name: string; billing_phone: string; billing_postal_code: string; billing_region: string; currency_code: string; currency_symbol: string; date_created: null | string; date_modified: null | string; language: string; shipping_address1: string; shipping_address2: string; shipping_address_name: string; shipping_city: string; shipping_company: string; shipping_country: string; shipping_first_name: string; shipping_last_name: string; shipping_phone: string; shipping_postal_code: string; shipping_region: string; template_set_uri: string; total_future_shipping: string; total_item_price: string; total_order: string; total_shipping: string; total_tax: string; use_customer_shipping_address: boolean }

Type declaration

  • billing_address1: string

    The first line of billing street address.

  • billing_address2: string

    The second line of the billing street address.

  • billing_address_name: string

    The name of the billing address. This is also the value used as the shipto entry for a multiship item.

  • billing_city: string

    The city of this address.

  • billing_company: string

    The company associated with the billing address.

  • billing_country: string

    The country code of the billing address.

  • billing_first_name: string

    The given name associated with the billing address.

  • billing_last_name: string

    The surname associated with the billing address.

  • billing_phone: string

    The phone of the billing address.

  • billing_postal_code: string

    The postal code of the billing address.

  • billing_region: string

    The two character code for states in the United States. Other countries may call this a province. When a two character code isn't available, use the full region name.

  • currency_code: string

    The 3 character ISO code for the currency.

  • currency_symbol: string

    The currency symbol, such as $, £, €, etc.

  • date_created: null | string

    The date this resource was created.

  • date_modified: null | string

    The date this resource was last modified.

  • language: string

    The language defined by the template set being used.

  • shipping_address1: string

    The first line of shipping street address.

  • shipping_address2: string

    The second line of the shipping street address.

  • shipping_address_name: string

    The name of the shipping address. This is also the value used as the shipto entry for a multiship item.

  • shipping_city: string

    The city of this address.

  • shipping_company: string

    The company associated with the shipping address.

  • shipping_country: string

    The country code of the shipping address.

  • shipping_first_name: string

    The given name associated with the shipping address.

  • shipping_last_name: string

    The surname associated with the shipping address.

  • shipping_phone: string

    The phone of the shipping address.

  • shipping_postal_code: string

    The postal code of the shipping address.

  • shipping_region: string

    The two character code for states in the United States. Other countries may call this a province. When a two character code isn't available, use the full region name.

  • template_set_uri: string

    The full API URI of the template set for this cart, if one has been specified.

  • total_future_shipping: string

    If this cart has any shippable subscription items which will process in the future, this will be the total amount of shipping costs for those items.

  • total_item_price: string

    Total amount of the items in this cart.

  • total_order: string

    Total order amount of this cart including all items, taxes, shipping costs and discounts.

  • total_shipping: string

    Total amount of the shipping costs for this cart.

  • total_tax: string

    Total amount of the taxes for this cart.

  • use_customer_shipping_address: boolean

    This value determines how an attached customer's addresses should be handled in the event the cart resource is POSTed to. When false, the customer's billing address will be used for both the billing and shipping addresses. Defaults to true, so a customer's shipping address will be used if it exists.

zooms

zooms: { customer?: Customer.Graph; items?: Customer.Rels.Items }

Type declaration

Generated using TypeDoc