API docs by Redocly

Data Service API Specification (0.0.1)

Download OpenAPI specification:Download

E-mail: DG-WebPlatform@avalara.com

This is an API specification for the Web-Platform data service.

Navigation

Navigation bar as a service

Find out more

Get navigation bar menu items and sub-menu items. Defaults to user account. NOTE: this endpoint is intended to be consumed by the Skylab aui-supernav component. In most cases, your team shouldn't be calling this endpoint directly. Please reach out to the #web-platform Slack channel with any questions.

Authorizations:
BearerAuthBasicAuth
query Parameters
accountId
string

specify an account

cookie Parameters
landingOrg
string
Value: "oracle"

The landing org cookie will result in a filtered nav response based on the partner provided in the cookie.

object

The aui-context cookie will be referred to if the query parameters are not set.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Feature Flag

aui-feature-flag as a service

Get feature flags

Request Body schema: application/json

Get feature flags for given feature specifications

required
object
object
object

Responses

Request samples

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

Response samples

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

Entitlements Aggregation

Aggregation of AvaTax subscriptions and user role and IAM-DS entitlements and grants

Get IAM-DS entitlements, IAM-DS grants, AvaTax subscriptions, and AvaTax user role. Defaults to authenticated AvaTax userId and AvaTax accountId, AvaTax accountId can be overridden via context cookie. IAM-DS entitlements are scoped to the tenant the user is scoped to in the current auth session. IAM-DS grants are scoped to the authenticated user. The bearer auth token used to call this API must have the following scopes included: 'iam-ds', 'avatax', and 'avatax_api'. Only JWTs are supported, opaque tokens will not be able to resolve IAM-DS data. A user with no IAM-DS tenant or user id will receive 400-status errors in the errors array for the IAM-DS calls.

Authorizations:
BearerAuth
cookie Parameters
object

If activeAccountId is set and passed via aui-context cookie, that value will be preferred over the accountId determined from the bearer auth.

Responses

Response samples

Content type
application/json
{
  • "iamDsEntitlements": [
    ],
  • "iamDsGrants": [
    ],
  • "avataxSubscriptions": [
    ],
  • "avataxUserRole": "AccountAdmin",
  • "errors": [
    ]
}

Locales

Supported locales for various product experiences

Get supported locales for various product experiences. Targeted locales refers to those that need to be supported by the product experience. Released locales refers to those that have been released in the current environment.

Responses

Response samples

Content type
application/json
{
  • "elr": {
    },
  • "portal": {
    }
}

Account Menu

This endpoint is intended to be consumed by Skylab aui-header component, your app shouldn't be calling this endpoint directly.

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{}