Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Shipment

Hierarchy

Index

Properties

Properties

Optional Readonly child

child?: Core.Graph

curie

curie: "fx:shipment"

links

links: { fx:attributes: Backend.Rels.Attributes; fx:custom_fields: Backend.Rels.CustomFields; fx:customer: Customer; fx:customer_address: Backend.Rels.CustomerAddress; fx:items: Backend.Rels.Items; fx:shipments: Shipments; fx:store: Backend.Rels.Store; fx:transaction: Backend.Rels.Transaction; self: Shipment }

Type declaration

props

props: { address1: string; address2: string; address_name: string; city: string; company: string; country: string; date_created: null | string; date_modified: null | string; first_name: string; last_name: string; phone: string; postal_code: string; region: string; shipping_service_description: string; shipping_service_id: number; total_item_price: number; total_price: number; total_shipping: number; total_tax: number }

Type declaration

  • address1: string

    The first line of the street address.

  • address2: string

    The second line of the street address.

  • address_name: string

    Either the shipto value or Default Shipping Address for non-multiship transactions.

  • city: string

    The city of this address.

  • company: string

    The company associated with this address.

  • country: string

    The country code of this address.

  • date_created: null | string

    The date this resource was created.

  • date_modified: null | string

    The date this resource was last modified.

  • first_name: string

    The given name associated with this address.

  • last_name: string

    The surname associated with this address.

  • phone: string

    The phone of this address.

  • postal_code: string

    The postal code of this address.

  • 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, the full region name will be used.

  • shipping_service_description: string

    The description of the shipping service selected for this shipment.

  • shipping_service_id: number

    The shipping service id selected during checkout. This will normally correspond with a shipping_service from one of the shipping_methods available.

  • total_item_price: number

    The total price of the items in this shipment.

  • total_price: number

    The total price of this shipment.

  • total_shipping: number

    The total shipping cost of the items in this shipment.

  • total_tax: number

    The total tax on the items in this shipment.

zooms

zooms: { attributes?: Backend.Rels.Attributes; custom_fields?: Backend.Rels.CustomFields; items?: Backend.Rels.Items }

Type declaration

Generated using TypeDoc