API docs by Redocly

Enterprise FE API (1.0)

Download OpenAPI specification:

The Enterprise Front End API.

Health

Health check.

Health check.

Authorizations:
OAuth2
header Parameters
Correlation-Id
string

Correlation Id.

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "entries": { }
}

Customers

Update Customer

Apply a partial update to an existing customer in Core. Only the fields present in the request body are forwarded; absent fields are preserved.

Authorizations:
OAuth2
path Parameters
externalId
required
string

Customer identifier.

header Parameters
Correlation-Id
string

Correlation Id.

Request Body schema: application/json
title
string
firstName
string
lastName
string
dateOfBirth
string
object (updateFeCustomerAddressRequest)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "dateOfBirth": "string",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get Customer By External Id

Retrieve the canonical customer view from Core by its external identifier.

Authorizations:
OAuth2
path Parameters
externalId
required
string

Customer external identifier.

header Parameters
Correlation-Id
string

Correlation Id.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Organisations

Create Organisation

Register a new organisation in the downstream Core system.

Authorizations:
OAuth2
header Parameters
Correlation-Id
string

Correlation Id.

User-Scopes
required
string

Authorized scopes.

Request Body schema: application/json
name
string
email
string
phone
string
object (createFeOrganisationAddressRequest)
object (createFeOrganisationDirectorRequest)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "address": {
    },
  • "director": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Locations

Create Location

Register a new location for an organisation in the downstream Core system.

Authorizations:
OAuth2
header Parameters
Correlation-Id
string

Correlation Id.

User-Scopes
required
string

Authorized scopes.

Request Body schema: application/json
name
string
organisationExternalId
string
addressLine1
string
addressLine2
string
addressLine3
string
city
string
county
string
postalCode
string
country
string
locationCategory
string
latitude
number or null <double>
longitude
number or null <double>
emailAddress
string
phoneNumber
string
notes
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "organisationExternalId": "string",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "addressLine3": "string",
  • "city": "string",
  • "county": "string",
  • "postalCode": "string",
  • "country": "string",
  • "locationCategory": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "emailAddress": "string",
  • "phoneNumber": "string",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

ReferenceData

Get Choice List

Returns the choices (code and label pairs) for the named choice list.

Authorizations:
OAuth2
path Parameters
listName
required
string

camelCase identifier of the choice list.

header Parameters
Correlation-Id
string

Correlation Id.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

List Choice Lists

Returns a manifest of every choice list available in the catalogue.

Authorizations:
OAuth2
header Parameters
Correlation-Id
string

Correlation Id.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Products

Get Product By External Id

Retrieve the canonical product view from PAS by its external identifier.

Authorizations:
OAuth2
path Parameters
externalId
required
string

Product external identifier.

header Parameters
Correlation-Id
string

Correlation Id.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}