POST
/
locations

Authorizations

Authorization
string
headerrequired

Authenticate with bearer_token you obtained from /login endpoint.

Body

application/json

This object represents a supply address.

reference_id
string

A reference that is meaningful to you, for example, an ID from your system.

customer_id
string

FlatPeak customer ID.

postal_address
object

Information on the postal address.

Response

201 - application/json

This object represents a supply address.

id
string
required

FlatPeak unique location Id

object
string
required

Represents the object’s type. I.e. location.

live_mode
boolean
required

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

time_created
string
required

Time when the object was created, in UTC.

account_id
string
required

FlatPeak account ID.

reference_id
string

A reference that is meaningful to you, for example, an ID from your system.

customer_id
string

FlatPeak customer ID.

timezone
string

The timezone at the location, in 'tz database format'. I.e. 'Europe/Berlin'.

currency_code
string

Currency at the location in ISO 4217.

postal_address
object

Information on the postal address.

geo_location
object

Latitude and longitude of the location. FlatPeak resolves this automatically using the postal_adddess that you provide. This information is used to determine market price and carbon regions.

tariff_status
object

Health status of tariff elements.

tariff_elements
string[]

An array of tariff IDs that apply to this location. To manage tariffs for a location, use /tariffs/elements endpoint. NOTE: This field is in beta and is not currently generally supported. Check back in early September 2024.