Type alias Address

Address: {
    address: string;
    address2: string;
    city: string;
    company_name: string;
    country_code: string;
    created: string;
    customer: string;
    fax: string;
    first_name: string;
    last_name: string;
    live: boolean;
    phone: string;
    public_id: string;
    state_province_code: string;
    store_public_id: string;
    zip_postal_code: string;
}

Object that represents an address and contains the following fields:

Type declaration

  • address: string

    The first line of the address which typically includes a street names and house number.

  • address2: string

    The second line of the address which is typically used to specify additional address details such as apartment number.

  • city: string

    The city of the address.

  • company_name: string

    The name of the company tied to the address.

  • country_code: string

    The two-letter country code tied to the address.

  • created: string

    The time stamp of when the address record was created.

    Example

    2021-04-04
  • customer: string

    This field represents your customer's id. This id is used to map the customer between Ordergroove and your e-commerce system.

  • fax: string

    The fax number tied to the address.

  • first_name: string

    The first name of person for whom the shipment is meant for.

  • last_name: string

    The last name of person for whom the shipment is meant for.

  • live: boolean

    Determines if an address is currently actively tied to an upcoming order or subscription.

  • phone: string

    The phone number tied to the address.

  • public_id: string

    This is the id of the address.

  • state_province_code: string

    The state, province or region of the address.

  • store_public_id: string

    The id of the physical store that is tied to this address.

  • zip_postal_code: string

    The zip or postal code of the address.

Settings

Member Visibility

Theme