Type.

Location

Represents a geographical location, including administrative and geographical details.

Fields

•

ID!

Required

The unique identifier for the location.

administrativeArea

•

String

The name of the administrative area (e.g., state, province, region) where the location resides.

administrativeAreaCode

•

String

The code representing the administrative area (e.g., a state or province code).

countryCode

•

CountryCode!

Required

The ISO 3166-1 alpha-2 code of the country where the location is situated.

createdAt

•

DateTime!

Required

The timestamp when the location was created.

createdBy

•

ID!

Required

The ID of the user or system that created the location record.

latitude

•

Decimal

The latitude of the location in decimal degrees.

line1

•

String

The first line of the location's address.

line2

•

String

The second line of the location's address, if applicable.

line3

•

String

The third line of the location's address, if applicable.

line4

•

String

The fourth line of the location's address, if applicable.

locality

•

String

The locality of the location (e.g., city, town, village).

longitude

•

Decimal

The longitude of the location in decimal degrees.

metadata

•

[PartyMetadata]

Additional metadata associated with the location.

mode

•

Mode!

Required

Specifies whether the Location is in live or test mode.

organization

•

ID!

Required

The unique identifier for the organization associated with the location.

plusCode

•

String

The Plus Code (Open Location Code) for the location, providing a compact representation of geographic coordinates.

postalCode

•

String

The postal or ZIP code of the location.

propertyType

•

PropertyType

Whether this location is a residential or commercial property. Carriers use it to classify the delivery; FedEx, for example, applies a residential delivery surcharge to residential recipients. When left unset on a ship-to party, the destination defaults to RESIDENTIAL so that carrier options requiring a residential address (such as FedEx indirect signature) remain available. Set COMMERCIAL for business deliveries to avoid the residential surcharge.

updatedAt

•

DateTime!

Required

The timestamp when the location record was last updated.

updatedBy

•

ID!

Required

The ID of the user or system that last updated the location record.

Fields

Was this page helpful?