Starfish API Documentation

Location

Location

  • addressLine1: String!

    The first line of the street address

  • addressLine2: String

    The second line of the street address

  • city: String!

    The city

  • countryCode: CountryCode!

    The Alpha-2 ISO 3166-1 country code

  • emailAddress: String

    Location email address

  • id: ID!

  • name: String!

    Location name

  • number: String

    Optional location number

  • phoneNumber: String!

    Phone number

  • postalCode: String!

    The postal code, zip code, postcode

  • region: String

    The ISO 3166-2 region code (excluding the country code)

LocationConnection

The connection type for Location.

LocationEdge

An edge in a connection.

  • cursor: String!

    A cursor for use in pagination.

  • node: Location

    The item at the end of the edge.