Facilities (2024-08-08)

Download OpenAPI specification:Download

Introduction

The Facilities API enables seamless integration with Optoro's platform to ensure that facility information is synchronized and up-to-date across all services in the Store Solution.

Create / Update Facility

This endpoint allows for creating or updating a facility. If a facility with the provided identifier already exists, it will be updated with the new information provided in the payload. Otherwise, a new facility record is created.

SecurityoAuth2
Request
header Parameters
Optiturn-Facilities-Version
required
string

The version of the API to use.

Example: 2024-08-08
Request Body schema: application/json
object (facility)

Facility attributes

group_identifier
string or null

Identifier for the facility's group.

identifier
required
string

Unique identifier for the facility.

name
string

Name of the facility.

object

Address of the facility.

name
string

Name for the address.

street
string

Street line 1 of the address.

street2
string

Street line 2 of the address.

city
string

City of the address.

state
string

State of the address.

zip
string

Zip code of the address.

country
string

Country of the address.

details
object

Any additional data for facility

latitude
number

Facility latitude.

longitude
number

Facility longitude.

facility_type
string

Type of facility (e.g., STR, COM).

Responses
200

Facility created or updated successfully.

400

Malformed request. Check structure of JSON payload.

401

Missing, expired, or invalid OAuth bearer token. Request a new token from the auth service.

422

Validation error. Fix request payload and try again.

5XX

Server error. Retry request using an exponential backoff.

post/facilities
Request samples
application/json
{
  • "facility": {
    }
}
Response samples
application/json
{
  • "facility": {
    }
}
© 2010 – 2025 Optoro, Inc. For official use only by authorized users. Use subject to terms of license agreement.