Update a location

curl --request PATCH \
  --url https://api.flatpeak.com/locations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reference_id": "LOC1234567890",
  "customer_id": "cus_65e421d1daa4a24082b4f590",
  "postal_address": {
    "address_line1": "1-3",
    "address_line2": "Strand",
    "city": "London",
    "state": "Greater London",
    "post_code": "WC2N 5EH",
    "country_code": "GB"
  }
}
'

{
  "id": "loc_641b90b758fb8e6293716e40",
  "object": "location",
  "live_mode": true,
  "time_created": "2023-11-07T05:31:56Z",
  "account_id": "acc_661677911f2197045e6cf1b1",
  "reference_id": "LOC1234567890",
  "customer_id": "cus_65e421d1daa4a24082b4f590",
  "timezone": "Europe/London",
  "currency_code": "EUR",
  "postal_address": {
    "address_line1": "1-3",
    "address_line2": "Strand",
    "city": "London",
    "state": "Greater London",
    "post_code": "WC2N 5EH",
    "country_code": "GB"
  },
  "geo_location": {
    "lat": 50.12345,
    "lng": -1.23456
  },
  "market_sources": {
    "import": "mrs_65792b4ef61b16685ebd2ec1",
    "export": ""
  },
  "tariff_status": {
    "commodity_import": "CONNECTED",
    "commodity_export": "ERROR",
    "non_commodity_import": "NOT_CONNECTED",
    "non_commodity_export": "NOT_SUPPORTED",
    "local": "NOT_SUPPORTED"
  },
  "tariff_elements": [
    "trf_66ba584eb6923d7c3b942ef6"
  ]
}

PATCH

locations

{id}

Update a location

curl --request PATCH \
  --url https://api.flatpeak.com/locations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reference_id": "LOC1234567890",
  "customer_id": "cus_65e421d1daa4a24082b4f590",
  "postal_address": {
    "address_line1": "1-3",
    "address_line2": "Strand",
    "city": "London",
    "state": "Greater London",
    "post_code": "WC2N 5EH",
    "country_code": "GB"
  }
}
'

{
  "id": "loc_641b90b758fb8e6293716e40",
  "object": "location",
  "live_mode": true,
  "time_created": "2023-11-07T05:31:56Z",
  "account_id": "acc_661677911f2197045e6cf1b1",
  "reference_id": "LOC1234567890",
  "customer_id": "cus_65e421d1daa4a24082b4f590",
  "timezone": "Europe/London",
  "currency_code": "EUR",
  "postal_address": {
    "address_line1": "1-3",
    "address_line2": "Strand",
    "city": "London",
    "state": "Greater London",
    "post_code": "WC2N 5EH",
    "country_code": "GB"
  },
  "geo_location": {
    "lat": 50.12345,
    "lng": -1.23456
  },
  "market_sources": {
    "import": "mrs_65792b4ef61b16685ebd2ec1",
    "export": ""
  },
  "tariff_status": {
    "commodity_import": "CONNECTED",
    "commodity_export": "ERROR",
    "non_commodity_import": "NOT_CONNECTED",
    "non_commodity_export": "NOT_SUPPORTED",
    "local": "NOT_SUPPORTED"
  },
  "tariff_elements": [
    "trf_66ba584eb6923d7c3b942ef6"
  ]
}

Authorizations

Authorization

string

header

required

Authenticate with bearer you obtained from authentication endpoint.

Path Parameters

string

required

Flatpeak location_id

Example:

"loc_d47751032d2748d2bce8ec55b2006def"

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.

Example:

"LOC1234567890"

customer_id

string

Flatpeak customer ID.

Example:

"cus_65e421d1daa4a24082b4f590"

postal_address

PostalAddress · object

Information on the postal address.

Show child attributes

postal_address.address_line1

string

Address line 1 (e.g., street, PO Box, or company name).

Example:

"1-3"

postal_address.address_line2

string

Address line 2 (e.g., apartment, suite, unit, or building).

Example:

"Strand"

postal_address.city

string

City, district, suburb, town, or village.

Example:

"London"

postal_address.state

string

State, county, province, or region.

Example:

"Greater London"

postal_address.post_code

string

ZIP or postal code.

Example:

"WC2N 5EH"

postal_address.country_code

string

Two-letter country code in ISO 3166-1 alpha-2.

Example:

"GB"

Response

Response example

This object represents a supply address.

string

required

Flatpeak unique location ID

Example:

"loc_641b90b758fb8e6293716e40"

object

string

required

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

Example:

"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<date-time>

required

Time when the object was created, in UTC.

account_id

string

required

Flatpeak account ID.

Example:

"acc_661677911f2197045e6cf1b1"

reference_id

string

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

Example:

"LOC1234567890"

customer_id

string

Flatpeak customer ID.

Example:

"cus_65e421d1daa4a24082b4f590"

timezone

string

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

Example:

"Europe/London"

currency_code

string

Currency at the location in ISO 4217.

Example:

"EUR"

postal_address

PostalAddress · object

Information on the postal address.

Show child attributes

postal_address.address_line1

string

Address line 1 (e.g., street, PO Box, or company name).

Example:

"1-3"

postal_address.address_line2

string

Address line 2 (e.g., apartment, suite, unit, or building).

Example:

"Strand"

postal_address.city

string

City, district, suburb, town, or village.

Example:

"London"

postal_address.state

string

State, county, province, or region.

Example:

"Greater London"

postal_address.post_code

string

ZIP or postal code.

Example:

"WC2N 5EH"

postal_address.country_code

string

Two-letter country code in ISO 3166-1 alpha-2.

Example:

"GB"

geo_location

GeoLocation · object

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

Show child attributes

geo_location.lat

number

Example:

50.12345

geo_location.lng

number

Example:

-1.23456

market_sources

object

Flatpeak IDs for market rates geographical regions. Flatpeak sets this automatically using the postal_address. For more information and to resolve IDs to region names, see the market rates reference in docs.ference in docs.

Show child attributes

market_sources.import

string

Flatpeak ID for market rates geographical region for import direction.

Example:

"mrs_65792b4ef61b16685ebd2ec1"

market_sources.export

string

Flatpeak ID for market rates geographical region for export direction if an export tariff has been created.

Example:

""

tariff_status

object

Health status of tariff elements.

Show child attributes

tariff_status.commodity_import

string

Status of all COMMODITY/IMPORT tariff elements.

Example:

"CONNECTED"

tariff_status.commodity_export

string

Status of all COMMODITY/EXPORT tariff elements.

Example:

"ERROR"

tariff_status.non_commodity_import

string

Status of all NON_COMMODITY/IMPORT tariff elements.

Example:

"NOT_CONNECTED"

tariff_status.non_commodity_export

string

Status of all NON_COMMODITY/EXPORT tariff elements.

Example:

"NOT_SUPPORTED"

tariff_status.local

string

Status of LOCAL tariff element.

Example:

"NOT_SUPPORTED"

tariff_elements

string[]

An array of tariffs that apply to this location. To manage, use the tariffs endpoints.

Create a location Delete a location

Connect tariff

Schedule energy

Calculate cost

Update a location

Authorizations

Path Parameters

Body

Response