Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StoreShippingMethod

Hierarchy

Index

Properties

Properties

Optional Readonly child

child?: Core.Graph

curie

curie: "fx:store_shipping_method"

links

links: { fx:shipping_container: ShippingContainer; fx:shipping_containers: ShippingContainers; fx:shipping_drop_type: ShippingDropType; fx:shipping_drop_types: ShippingDropTypes; fx:shipping_method: ShippingMethod; fx:shipping_methods: ShippingMethods; fx:shipping_services: ShippingServices; fx:store: Backend.Rels.Store; fx:store_shipping_services: StoreShippingServices; self: StoreShippingMethod }

Type declaration

props

props: { accountid?: null | string; authentication_key?: null | string; custom_code?: string; date_created: null | string; date_modified: null | string; deployment_status?: "error" | "deploying" | "deployed"; meter_number?: null | string; password?: null | string; shipping_container_uri?: string; shipping_drop_type_uri?: string; shipping_method_uri: string; use_for_domestic: boolean; use_for_international: boolean }

Type declaration

  • Optional accountid?: null | string

    If using account specific rates, enter your shipping account id here. If using the CUSTOM-ENDPOINT-POST method, enter your endpoint URL here.

  • Optional authentication_key?: null | string

    If using account specific rates, enter your shipping account authentication key here, if applicable.

  • Optional custom_code?: string

    For the CUSTOM-CODE shipping method. JavaScript used to create and modify shipping rates.

  • date_created: null | string

    The date this resource was created.

  • date_modified: null | string

    The date this resource was last modified.

  • Optional deployment_status?: "error" | "deploying" | "deployed"

    For the CUSTOM-CODE shipping method. Values are deploying, deployed, and error.

  • Optional meter_number?: null | string

    If using account specific rates, enter your shipping account meter number here, if applicable.

  • Optional password?: null | string

    If using account specific rates, enter your shipping account password here.

  • Optional shipping_container_uri?: string

    The full API URI of the shipping method container defined in our property helpers. Each shipping method will have it's own shipping containers.

  • Optional shipping_drop_type_uri?: string

    The full API URI of the shipping method drop type defined in our property helpers. Each shipping method will have it's own shipping drop types.

  • shipping_method_uri: string

    The full API URI of the shipping method defined in our property helpers.

  • use_for_domestic: boolean

    Set to true if you want this shipping method to apply to domestic shipping rate requests.
    Note: This value is read only true for CUSTOM-CODE.

  • use_for_international: boolean

    Set to true if you want this shipping method to apply to international shipping rate requests.
    Note: This value is read only true for CUSTOM-CODE.

zooms

zooms: { shipping_container?: ShippingContainer; shipping_drop_type?: ShippingDropType; shipping_method?: ShippingMethod; store_shipping_services?: StoreShippingServices }

Type declaration

Generated using TypeDoc