The Location object 

Attributes

• idstring

  Unique identifier for the object.

• addressobject

  The full address of the location.

  Hide child attributes

  • address.citynullable string

    City, district, suburb, town, or village.

  • address.countrynullable string

    Two-letter country code (ISO 3166-1 alpha-2).

  • address.line1nullable string

    Address line 1, such as the street, PO Box, or company name.

  • address.line2nullable string

    Address line 2, such as the apartment, suite, unit, or building.

  • address.postal_codenullable string

    ZIP or postal code.

  • address.statenullable string

    State, county, province, or region.

• display_namestring

  The display name of the location.

• metadataobject

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

More attributes

Collapse all

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• address_kananullable objectPreview feature

  The Kana variation of the full address of the location (Japan only).

  Hide child attributes

  • address_kana.citynullable string

    City/Ward.

  • address_kana.countrynullable string

    Two-letter country code (ISO 3166-1 alpha-2).

  • address_kana.line1nullable string

    Block/Building number.

  • address_kana.line2nullable string

    Building details.

  • address_kana.postal_codenullable string

    ZIP or postal code.

  • address_kana.statenullable string

    Prefecture.

  • address_kana.townnullable string

    Town/cho-me.

• address_kanjinullable objectPreview feature

  The Kanji variation of the full address of the location (Japan only).

  Hide child attributes

  • address_kanji.citynullable string

    City/Ward.

  • address_kanji.countrynullable string

    Two-letter country code (ISO 3166-1 alpha-2).

  • address_kanji.line1nullable string

    Block/Building number.

  • address_kanji.line2nullable string

    Building details.

  • address_kanji.postal_codenullable string

    ZIP or postal code.

  • address_kanji.statenullable string

    Prefecture.

  • address_kanji.townnullable string

    Town/cho-me.

• configuration_overridesnullable string

  The ID of a configuration that will be used to customize all readers in this location.

• display_name_kananullable stringPreview feature

  The Kana variation of the display name of the location.

• display_name_kanjinullable stringPreview feature

  The Kanji variation of the display name of the location.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• phonenullable stringPreview feature

  The phone number of the location.