Get location

https://api.kustom.co/ipp/v1/locations/{id}

Returns a single location by ID, scoped to the authenticated merchant.

Parameters

200

400

401

404

Example

Parameters1 field

• idstring · uuidrequiredin path

200

Response10 fields

Location found.

• idstring · uuidoptional

  Unique location identifier.

• merchant_idstringoptional

  Merchant identifier.

• namestringoptional

  Display name of the location.

• street_addressstringoptional

  Primary street address.

• street_address2stringoptional

  Secondary address line (suite, apartment, etc.).

• postal_codestringoptional

  Postal or ZIP code.

• citystringoptional

  City name.

• countrystringoptional

  Country code (ISO 3166-1 alpha-2).

• created_atstring · date-timeoptional

  Timestamp when the location was created.

• updated_atstring · date-timeoptional

  Timestamp when the location was last updated.

400

Response0 fields

Missing or invalid merchant ID header.

No response body — this status returns headers only.

401

Response0 fields

Missing or invalid credentials.

No response body — this status returns headers only.

404

Response0 fields

Location not found.

No response body — this status returns headers only.

GET https://api.kustom.co/ipp/v1/locations/{id}

Response200400401404

Response 200· Location found.

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "merchant_id": "merchant_12345",
  "name": "Downtown Store",
  "street_address": 123,
  "street_address2": "Suite 100",
  "postal_code": 12345,
  "city": "Stockholm",
  "country": "SE",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z"
}

12 linesCopy

Response 400· Missing or invalid merchant ID header.

No response body.

This status returns headers only — there is nothing to parse.

—

Response 401· Missing or invalid credentials.

No response body.

This status returns headers only — there is nothing to parse.

—

Response 404· Location not found.

No response body.

This status returns headers only — there is nothing to parse.

—