Blueprint API

API to retrieve and update Blueprints and conditions for host carrier for a specific condition ID.

Version: 1.1.13

Contact information:
Architect API Support
cto-api-support@atpco.net

Available authorizations

atpcoOAuth (OAuth2, clientCredentials)

OAuth 2.0 authorization code flow. Supports JWT per RFC8725.

Token URL: https://login.atpco.net/apim/oauth2/v2.0/token
Refresh URL: https://login.atpco.net/apim/oauth2/v2.0/refresh
Scopes:

pi.architect.blueprint.api.read: Grants read access
pi.architect.blueprint.api.write: Grants write access
pi.architect.blueprint.api.execute: Grants execute access
https://login.atpco.net/architect-api/.default: Scope for authentication

atpcoOAuthGold (OAuth2, clientCredentials)

OAuth 2.0 authorization code flow for testing environments (informative). Supports JWT per RFC8725.

Token URL: https://goldlogin.atpco.net/apim/oauth2/v2.0/token
Refresh URL: https://goldlogin.atpco.net/apim/oauth2/v2.0/refresh
Scopes:

pi.architect.blueprint.api.read: Grants read access
pi.architect.blueprint.api.write: Grants write access
pi.architect.blueprint.api.execute: Grants execute access
https://goldlogin.atpco.net/architect-api/.default: Scope for authentication

atpcoApiKey (API Key Authentication)

API key required for access control.
Name: X-Api-Key
In: header

Availability

Availability APIs (health, status, etc.)

[GET] /health

Health check endpoint for Service

Returns HTTP 200 response if the service is healthy, or an error structure on failure.

Responses

Code	Description	Schema
200	OK Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	text/plain: string, Available values: "OK"
400	Bad Request (HTTP 400) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
401	Unauthorized (HTTP 401) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
404	Not Found (HTTP 404) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
429	Too Many Requests (HTTP 429) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
500	Internal Server Error (HTTP 500) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
503	Service Unavailable (HTTP 503) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails

Security

Security Schema	Scopes
atpcoOAuth
atpcoOAuthGold

Blueprints

Blueprints APIs

[GET] /blueprints

Get all Blueprints ids and names for host carrier

Retrieve a list of all Blueprints ids and names for host carrier

Responses

Code	Description	Schema
200	Success Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/json: BlueprintsListResponse
401	Unauthorized (HTTP 401) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
429	Too Many Requests (HTTP 429) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
500	Internal Server Error (HTTP 500) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
503	Service Unavailable (HTTP 503) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails

Security

Security Schema	Scopes
atpcoOAuth	pi.architect.blueprint.api.read
atpcoOAuthGold	pi.architect.blueprint.api.read

[GET] /blueprints/{id}

Get a specific Blueprint by ID

Retrieve Blueprint details for the given Blueprint ID.

Parameters

Name	Located in	Description	Required	Schema
id	path	Unique identifier of the Blueprint	Yes	integer

Responses

Code	Description	Schema
200	Success Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/json: BlueprintDetailResponse
400	Bad Request (HTTP 400) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
401	Unauthorized (HTTP 401) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
404	Not Found (HTTP 404) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
422	Validation error (bad data) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ValidationError
429	Too Many Requests (HTTP 429) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
500	Internal Server Error (HTTP 500) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
503	Service Unavailable (HTTP 503) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails

Security

Security Schema	Scopes
atpcoOAuth	pi.architect.blueprint.api.read
atpcoOAuthGold	pi.architect.blueprint.api.read

[POST] /blueprints/executions

Triggers a Blueprint execution for 'General' Blueprints.

Triggers execution for the given Blueprint ID.

Parameters

Name	Located in	Description	Required	Schema
id	query	Unique identifier of the Blueprint	Yes	integer

Request Body

Required	Schema
No	application/json: BlueprintExecutionRequest

Responses

Code	Description	Schema
200	Success Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/json: BlueprintExecutionResponse
400	Bad Request (HTTP 400) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
401	Unauthorized (HTTP 401) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
404	Not Found (HTTP 404) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
422	Validation error (bad data) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ValidationError
429	Too Many Requests (HTTP 429) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
500	Internal Server Error (HTTP 500) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
503	Service Unavailable (HTTP 503) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails

Security

Security Schema	Scopes
atpcoOAuth	pi.architect.blueprint.api.execute
atpcoOAuthGold	pi.architect.blueprint.api.execute

[GET] /blueprints/executions/{executionId}

Retrieves the current state of an execution

Returns the current status of the given execution for the given Blueprint ID.

Parameters

Name	Located in	Description	Required	Schema
executionId	path	Unique identifier of the execution, as returned from the trigger operation	Yes	string

Responses

Code	Description	Schema
200	Success Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/json: BlueprintExecutionResponse
400	Bad Request (HTTP 400) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
401	Unauthorized (HTTP 401) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
404	Not Found (HTTP 404) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
429	Too Many Requests (HTTP 429) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
500	Internal Server Error (HTTP 500) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
503	Service Unavailable (HTTP 503) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails

Security

Security Schema	Scopes
atpcoOAuth	pi.architect.blueprint.api.execute
atpcoOAuthGold	pi.architect.blueprint.api.execute

[DELETE] /blueprints/executions/{executionId}

Cancels an execution

Cancels the given execution for the given Blueprint ID.

Parameters

Name	Located in	Description	Required	Schema
executionId	path	Unique identifier of the execution, as returned from the trigger operation	Yes	string

Responses

Code	Description	Schema
200	Success Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/json: BlueprintExecutionResponse
400	Bad Request (HTTP 400) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
401	Unauthorized (HTTP 401) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
404	Not Found (HTTP 404) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
429	Too Many Requests (HTTP 429) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
500	Internal Server Error (HTTP 500) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
503	Service Unavailable (HTTP 503) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails

Security

Security Schema	Scopes
atpcoOAuth	pi.architect.blueprint.api.execute
atpcoOAuthGold	pi.architect.blueprint.api.execute

Fares

Blueprint fare save APIs

[POST] /blueprints/executions/{executionId}/groups

Save blueprint execution fares to a working fare group

Saves blueprint execution recommendation fares to a working fare group.
If no groupId is supplied in request, a new group is auto-created.
If a groupId is supplied, fares are appended to the existing group.

Parameters

Name	Located in	Description	Required	Schema
executionId	path	Unique identifier of the execution, as returned from the trigger operation	Yes	string

Request Body

Required	Schema
Yes	application/json: BlueprintFareSaveRequest

Responses

Code	Description	Schema
200	Save request processed. A 200 is returned even when only some fares were saved (partial success), so consumers must always inspect the response body: `data.numOfFaresAffected` is the count of fares saved, and `data.errors` (`duplicateCount`, `invalidCount`) reports fares that were rejected. Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/json: BlueprintFareSaveResponse
400	Bad Request (HTTP 400) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
401	Unauthorized (HTTP 401) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
422	Validation error (bad data) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ValidationError
429	Too Many Requests (HTTP 429) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
500	Internal Server Error (HTTP 500) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
503	Service Unavailable (HTTP 503) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails

Security

Security Schema	Scopes
atpcoOAuth	pi.architect.blueprint.api.execute
atpcoOAuthGold	pi.architect.blueprint.api.execute

Conditions

Blueprints Conditions APIs

[GET] /conditions

Get all conditions for host carrier

Retrieve a list of all conditions for host carrier

Responses

Code	Description	Schema
200	Success Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/json: ConditionsListResponse
401	Unauthorized (HTTP 401) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
429	Too Many Requests (HTTP 429) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
500	Internal Server Error (HTTP 500) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
503	Service Unavailable (HTTP 503) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails

Security

Security Schema	Scopes
atpcoOAuth	pi.architect.blueprint.api.read
atpcoOAuthGold	pi.architect.blueprint.api.read

[GET] /conditions/{id}

Get a specific condition by ID

Retrieve condition details for the given condition ID.

Parameters

Name	Located in	Description	Required	Schema
id	path	Unique identifier of the condition	Yes	integer

Responses

Code	Description	Schema
200	Success Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/json: ConditionDetailResponse
400	Bad Request (HTTP 400) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
401	Unauthorized (HTTP 401) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
404	Not Found (HTTP 404) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
422	Validation error (bad data) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ValidationError
429	Too Many Requests (HTTP 429) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
500	Internal Server Error (HTTP 500) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
503	Service Unavailable (HTTP 503) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails

Security

Security Schema	Scopes
atpcoOAuth	pi.architect.blueprint.api.read
atpcoOAuthGold	pi.architect.blueprint.api.read

[PUT] /conditions/{id}

Update condition content by ID

Update the content of a specific condition by ID.

Parameters

Name	Located in	Description	Required	Schema
id	path	Unique identifier of the condition to update	Yes	integer

Request Body

Required	Schema
Yes	application/json: ConditionDetailRequest

Responses

Code	Description	Schema
200	Condition content updated successfully Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/json: ConditionDetailResponse
400	Bad Request (HTTP 400) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
401	Unauthorized (HTTP 401) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
404	Not Found (HTTP 404) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets	application/problem+json: ProblemDetails
429	Too Many Requests (HTTP 429) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
500	Internal Server Error (HTTP 500) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails
503	Service Unavailable (HTTP 503) Headers: Access-Control-Allow-Origin: CORS header — which origins are allowed X-Rate-Limit-Limit: The number of requests allowed in the current period X-Rate-Limit-Remaining: The number of requests remaining in the current period X-Rate-Limit-Reset: The time (in seconds) until the rate limit resets Retry-After: Time (in seconds) after which the client can retry	application/problem+json: ProblemDetails

Security

Security Schema	Scopes
atpcoOAuth	pi.architect.blueprint.api.write
atpcoOAuthGold	pi.architect.blueprint.api.write

Schemas

BlueprintsListResponse

Name	Type	Description	Required
blueprints	[ BlueprintSummary ]	Array of Blueprint summary objects	Yes

BlueprintDetailResponse

Name	Type	Description	Required
data	BlueprintDetail		Yes

BlueprintExecutionResponse

Name	Type	Description	Required
data	BlueprintExecution		Yes

BlueprintExecutionRequest

Name	Type	Description	Required
effectiveDate	dateTime	Effective date as a ISO 8601 UTC timestamp; interpret as a date only. The effective date must fall within the last 7 calendar days and cannot be later than today, based on the America/New_York time zone. Example: `"2026-01-26T05:00:00.000Z"`	No

BlueprintFareSaveRequest

Name	Type	Description	Required
groupId	integer	ID of an existing working fare group to append fares to. Example: `448`	No

BlueprintFareSaveResponse

Name	Type	Description	Required
data	BlueprintFareSaveResult		Yes

ConditionsListResponse

Name	Type	Description	Required
conditions	[ ConditionSummary ]	Array of condition summary objects	Yes

ConditionDetailRequest

Name	Type	Description	Required
content	ConditionContent		Yes

ConditionDetailResponse

Name	Type	Description	Required
data	ConditionDetail		Yes

ProblemDetails

Adopt standard error format (RFC 7807 “Problem Details”)

Name	Type	Description	Required
type	string (uri)	A URI reference that identifies the problem type	Yes
title	string	Short, human-readable summary of the problem	Yes
status	integer	HTTP status code	Yes
detail	string	Human-readable explanation specific to this occurrence	No
instance	string (uri)	A URI reference that identifies the specific occurrence	Yes
timestamp	dateTime	The time at which the error occurred	Yes
retryable	boolean	Indicates if the operation can be retried	No
internalErrorCode	string	System error code for investigation and diagnostic	No

AuditCreatedBy

Opaque identifier of the user or system that created the resource.

Name	Type	Description	Required
AuditCreatedBy	string	Opaque identifier of the user or system that created the resource.

Example

X91#ABC

AuditCreatedAt

RFC 3339 UTC timestamp (milliseconds) of when the resource was created.

Name	Type	Description	Required
AuditCreatedAt	string	RFC 3339 UTC timestamp (milliseconds) of when the resource was created.

Example

2024-09-02T10:30:00.000Z

BlueprintSummary

Summary information about a blueprint

Name	Type	Description	Required
id	integer	Unique identifier of the blueprint Example: `261`	Yes
name	string	Name of the blueprint Example: `"TEST MATCH"`	Yes
type	string, Available values: "General", "Historic", "Web"	Type of the blueprint Enum: `"General"`, `"Historic"`, `"Web"` Example: `"General"`	Yes
createdBy	AuditCreatedBy		Yes
createdAt	AuditCreatedAt		Yes

AuditUpdatedBy

Opaque identifier of the user or system that most recently modified the resource.

Name	Type	Description	Required
AuditUpdatedBy	string	Opaque identifier of the user or system that most recently modified the resource.

Example

X91-ABC

AuditUpdatedAt

RFC 3339 UTC timestamp (milliseconds) of the most recent modification.

Name	Type	Description	Required
AuditUpdatedAt	string	RFC 3339 UTC timestamp (milliseconds) of the most recent modification.

Example

2025-05-02T16:15:00.000Z

BlueprintScopeSearchAdditionalParameters

Additional search parameters used in blueprint scope.

Name	Type	Description	Required
fareState	[ string, Available values: "D", "U", "T" ]	Fare state (D: distributed, U: updated, T: transmitted). Example: `["D","T"]`	No
groupId	[ integer ]	Identifiers of saved groups to be used as search scope. Example: `[1234,5678]`	No
oneWayRoundtripIndicator	[ integer, Available values: 1, 2, 3 ]	One-way or round-trip indicator. Example: `[1,2]`	No
fareClass	[ string ]	Fare class(es). Wildcards ^,%,_ can be used. Example: `["Y","B%"]`	No
fareTypeCode	[ string ]	Fare Type Code (FTC) that is associated with the fare record. Example: `["EOU","AA"]`	No
tariffNumber	integer	Fare tariff number that is associated with the fare record (deprecated: use tariffNumbers). Example: `123`	No
tariffNumbers	[ integer ]	Fare tariff numbers that are associated with the fare record. Example: `[123,456]`	No
passengerType	[ string ]	Passenger type code(s) that is associated with the fare record. Example: `["ADT","CHD"]`	No
advancedPurchase	[ string ]	Advance purchase (in number of days) for the fare record. Wildcards ^,# can be used. Example: `["30","60","#"]`	No
footnote	[ string ]	Footnote codes that are held by the fare. Wildcards ^,# can be used. Example: `["1A","^BC"]`	No
footnoteRange	{ "from": string, "to": string }		No
rbd	[ string ]	Prime reservation booking code(s) designator (RBD) code that are associated with the fare record. Wildcard ^ can be used. Example: `["A","^B"]`	No
ruleNumber	[ string ]	Fare rule number(s) that are associated with the fare record. Wildcard ^ can be used. Example: `["NAC1","^BCDE"]`	No
currency	[ string ]	Currency code(s) that are associated with the fare. Wildcard ^ can be used. Example: `["CAD","^USD"]`	No
routingNumber	[ string ]	Routing number that is associated with the fare. Wildcard ^ can be used. Example: `["3160","500"]`	No
dateOverrides	{ "travelDate": dateTime, "travelDuration": integer, "exactMatch": boolean }	Overrides for travel date and duration.	No
locationOverrides	{ "via1": string, "via2": string }	Overrides for locations.	No
validationOverrides	[ string, Available values: "transfers", "flightApplication", "routing" ]	Ignore specific itinerary validations. Example: `["transfers","routing"]`	No
salesDateOverride	dateTime	Future sales date for the itinerary. Returned as an ISO 8601 UTC timestamp; interpret as a date only. Example: `"2026-01-05T06:00:00.000Z"`	No
seasonalityType	[ string ]	Season that is associated with the fare record . Codes: H - High L - Low/off peak J - Basic O - Shoulder P - Peak of peak Q - Holiday Z - Second winter # - Blank Example: `["H","#"]`	No
cabin	[ string, Available values: "Economy", "Business", "First", "Premium Economy" ]	Cabin type(s) of the fare record. Example: `["Economy","Business"]`	No
dayType	[ string ]	Day of week that is associated with the fare record. Codes: W - weekend X - midweek N - night O - off-peak time Y - weekend night Z - midweek night # - Blank Example: `["W","#"]`	No
firstTravelDate	string	Constraint on information derived from the Commence On/After field of Travel Restrictions (Category 14) in FareManager Footnotes and Rules. Returned as an ISO 8601 UTC timestamp; interpret as a date only. Example: `">=2025-07-11T05:00:00.000Z"`	No
lastTravelDate	string	Constraint on information derived from the Commence On/Before field of Travel Restrictions (Category 14) in FareManager Footnotes and Rules. Returned as an ISO 8601 UTC timestamp; interpret as a date only. Example: `"=2025-07-11T05:00:00.000Z"`	No
returnTravelDate	string	Constraint on information derived from the Return By Date field of Travel Restrictions (Category 14) in FareManager Footnotes and Rules. Returned as an ISO 8601 UTC timestamp; interpret as a date only. Example: `"<=2025-07-11T05:00:00.000Z"`	No
firstSaleDate	string	Constraint on information derived from the Tickets Must Be Issued On/After field of Sales Restrictions (Category 15) in FareManager Footnotes and Rules. Returned as an ISO 8601 UTC timestamp; interpret as a date only. Example: `"<2025-07-11T05:00:00.000Z"`	No
lastSaleDate	string	Constraint on information derived from the Tickets Must Be Issued On/Before field of Sales Restrictions (Category 15) in FareManager Footnotes and Rules. Returned as an ISO 8601 UTC timestamp; interpret as a date only. Example: `">2025-07-11T05:00:00.000Z"`	No

BlueprintScopeSearchMarketParameters

Market parameters as key-value pairs. Only applicable to blueprint of type General.

Name	Type	Description	Required
BlueprintScopeSearchMarketParameters	object	Market parameters as key-value pairs. Only applicable to blueprint of type General.

BlueprintScopeSearchBrandsParameters

Brand parameters as key-value pairs.

Name	Type	Description	Required
BlueprintScopeSearchBrandsParameters	object	Brand parameters as key-value pairs.

BlueprintScopeSearchParameters

Search parameters used in blueprint scope. Only applicable to blueprint of type General and Historic.

Name	Type	Required
additionalParameters	BlueprintScopeSearchAdditionalParameters	No
marketParameters	BlueprintScopeSearchMarketParameters	No
brands	BlueprintScopeSearchBrandsParameters	No

BlueprintScopeCriterion

Criterium used to define the blueprint scope.

Name	Type	Description	Required
productType	[ string, Available values: "PUB", "PVT", "CNP", "CNV", "WEB" ]	Product type. 'WEB' is only applicable for Web blueprints. Example: `["PUB","CNV"]`	No
origin	[ string ]	Fare record's origin cities or airports or origin User Defined Group (UDG). Example: `["WAS","NYC"]`	No
destination	[ string ]	Fare record's destination cities or airports or destination User Defined Group (UDG). Example: `["LON","CDG"]`	No
carrier	[ string ]	Fare record carriers or carrier User Defined Groups (UDG). Example: `["LA","A1"]`	No
market	[ string ]	Fare record market or market User Defined Group (UDG). Example: `["WASLON","NYCLAX"]`	No
marketParameterCarriers	boolean	When true, use the market parameter 'carriers' as filter criterion. Only applicable to blueprint of type General.	No
lowestBaseFare	boolean	When true, select only the fare with the lowest base fare amount per itinerary.	No
searchParameters	BlueprintScopeSearchParameters		No

BlueprintScopeContent

Content defining the criteria and parameters for the blueprint scope

Name	Type	Description	Required
startHistoricalDate	dateTime	Starting date for historical search. Only applicable to Historical blueprints. Returned as an ISO 8601 UTC timestamp; interpret as a date only. Example: `"2026-01-26T05:00:00.000Z"`	No
endHistoricalDate	dateTime	Ending date for historical search. Only applicable to Historical blueprints. Returned as an ISO 8601 UTC timestamp; interpret as a date only. Example: `"2026-01-26T06:00:00.000Z"`	No
scopeOptions	[ string, Available values: "fareAmountOnly", "taxData", "unsellableFares", "doubleOneWay", "itineraryInfluencers", "oagSchedule" ]	Only applicable to blueprint of type General and Historic. List of boolean scope options. Available flags per blueprint type: General: fareAmountOnly, taxData, oagSchedule, itineraryInfluencers, unsellableFares, doubleOneWay Historic: fareAmountOnly, taxData, itineraryInfluencers, unsellableFares Example: `["fareAmountOnly","doubleOneWay"]`	No
criteria	[ BlueprintScopeCriterion ]	List of criteria used to define the blueprint scope.	No

BlueprintScope

Defines the scope of fares affected by the blueprint

Name	Type	Description	Required
id	integer	Unique ID of the scope Example: `2892`	Yes
name	string	Name of the scope Example: `"CANCEL FARES in WASLON for FARECLASS = %Y"`	Yes
description	string	Description of the scope Example: `"Test"`	Yes
createdBy	AuditCreatedBy		Yes
createdAt	AuditCreatedAt		Yes
updatedBy	AuditUpdatedBy		No
updatedAt	AuditUpdatedAt		No
content	BlueprintScopeContent		Yes

BlueprintOperation

An operation performed during the blueprint execution.

Name	Type	Description	Required
type	string, Available values: "Condition", "FareClassMapping", "FootnoteAutomation", "ReverseTotalPrice", "FareCleanup", "ActionResolve"	Type of operation performed. Condition - conditionally applies transformations to fares FareClassMapping - performs fare class mapping transformations FootnoteAutomation - applies automatically footnotes to fares ReverseTotalPrice - computes base fare amount from intended total price FareCleanup - removes duplicate fares ActionResolve - computes final recommendations for fare modifications Enum: `"Condition"`, `"FareClassMapping"`, `"FootnoteAutomation"`, `"ReverseTotalPrice"`, `"FareCleanup"`, `"ActionResolve"` Example: `"Condition"`	Yes
id	integer	Unique ID of the operation. Example: `2892`	Yes
name	string	Name of the operation. Example: `"CANCEL FARES for FARECLASS = %Y"`	Yes
description	string	Description of the operation. Example: `"Test"`	Yes
createdBy	AuditCreatedBy		Yes
createdAt	AuditCreatedAt		Yes
updatedBy	AuditUpdatedBy		No
updatedAt	AuditUpdatedAt		No

BlueprintContent

Content of the blueprint processing logic including scope, operations, and action resolve.

Name	Type	Description	Required
scope	BlueprintScope		No
operations	[ BlueprintOperation ]	Ordered list of operations performed during the blueprint execution.	No

BlueprintDetail

Detailed information about a blueprint

Name	Type	Description	Required
id	integer	Unique ID of the blueprint. Example: `2892`	Yes
name	string	Name of the blueprint. Example: `"FARECLASS Management in WASLON"`	Yes
description	string	Description of the blueprint. Example: `"Test"`	Yes
type	string, Available values: "General", "Historic", "Web"	Type of the blueprint. Enum: `"General"`, `"Historic"`, `"Web"` Example: `"General"`	Yes
createdBy	AuditCreatedBy		Yes
createdAt	AuditCreatedAt		Yes
updatedBy	AuditUpdatedBy		Yes
updatedAt	AuditUpdatedAt		Yes
lastExecutedBy	AuditUpdatedBy		No
lastExecutedAt	AuditUpdatedAt		No
lastSavedGroupId	integer	Identifier of the last saved group for this blueprint executions. Example: `3456`	No
lastSavedFareCount	integer	Count of fares in the last saved group for this blueprint executions. Example: `1500`	No
content	BlueprintContent		Yes

ValidationError

Standard validation error format (RFC 9457 “Problem Details”)

Name	Type	Description	Required
type	string (uri)	A URI reference that identifies the problem type. Ideally a public HTTP URI pointing to a problem description.	Yes
title	string	Short, human-readable summary of the problem in general.	Yes
status	integer	HTTP status code.	Yes
detail	string	Human-readable explanation specific to this occurrence.	No
instance	string (uri)	A URI reference that identifies the specific occurrence. Possibly opaque to the client.	Yes
timestamp	dateTime	Date and time (in UTC) when the error occurred.	Yes
retryable	boolean	Indicates whether the client can retry the same request.	No
errors	[ { "path": string, "message": string, "value": string } ]	List of validation errors	No

BlueprintExecution

Blueprint execution state

Name	Type	Description	Required
executionId	string	Unique ID of the execution. Example: `"973d2250-2d24-4216-9808-0544c097f95d-0"`	Yes
blueprintId	integer	Unique ID of the Blueprint. Example: `2892`	Yes
blueprintName	string	Name of the blueprint. Example: `"FARECLASS Management in WASLON"`	Yes
state	string, Available values: "PROCESSING", "COMPLETED", "FAILED", "CANCELLED"	State of the Blueprint execution. Enum: `"PROCESSING"`, `"COMPLETED"`, `"FAILED"`, `"CANCELLED"` Example: `"PROCESSING"`	Yes
createdBy	AuditCreatedBy		Yes
createdAt	AuditCreatedAt		Yes
updatedBy	AuditUpdatedBy		No
updatedAt	AuditUpdatedAt		No

BlueprintFareSaveResult

Outcome of the fare save operation.

Name	Type	Description	Required
groupId	integer	ID of the group fares were saved to. Example: `448`	Yes
numOfFaresAffected	integer	Count of fare records successfully saved. Example: `209`	Yes
errors	{ "duplicateCount": integer, "invalidCount": integer }	Counts of duplicate and invalid fares rejected during the save. Example: `{"duplicateCount":3,"invalidCount":0}`	Yes

Example

{
  "groupId": 448,
  "numOfFaresAffected": 209,
  "errors": {
    "duplicateCount": 3,
    "invalidCount": 0
  }
}

ConditionSummary

Name	Type	Description	Required
id	integer	Unique identifier of the condition Example: `123`	Yes
name	string	Name of the condition Example: `"CANCEL FARES for FARECLASS = %Y"`	Yes
createdBy	AuditCreatedBy		Yes
createdAt	AuditCreatedAt		Yes

ConditionRowMatchScopeData

Scope refers to fares that were returned in the Blueprint search. These may be fares that you are changing. They also may be fares that are to be used as the basis for changes and cancellations of other fares or the creation of other fares.

Name	Type	Description	Required
productType	[ string ]	Product (PUB\|PVT\|CNP\|CNV\|WEB). Wildcards ^,%,_,# can be used. WEB product is not supported for update operations Example: `["PUB","P%","P__"]`	No
origin	[ string ]	Fare record's origin city or airport. Wildcards ^,%,_ can be used. Example: `["_ON","%S","^AT%","^WAS","LON","ATL","+My city group","+GB cities","ATL","^+My city group"]`	No
destination	[ string ]	Fare record's destination city or airport. Wildcards ^,%,_ can be used. Example: `["_ON","%S","^AT%","^WAS","LON","ATL","+My city group","+GB cities","ATL","^+My city group"]`	No
originCountry	[ string ]	Country of fare origin. Wildcards ^,%,_ can be used. Example: `["_S","U%","^CA","US","+My country group","+91 countries","^+My country group"]`	No
destinationCountry	[ string ]	Country of fare destination. Wildcards ^,%,_ can be used. Example: `["_S","U%","^CA","US","+My country group","+91 countries","^+My country group"]`	No
carrier	[ string ]	Carrier that is associated with the fare record. Wildcards ^,%,_ can be used. Example: `["_A","A%","^AA","^DL","LA","AS","UX","AA","+My carrier group","+US carriers","^+My carrier group"]`	No
sellableStatus	[ string, Available values: "Active", "Limited", "Cancelled", "Expired" ]	Status of the fare - Active, Cancelled, Expired, or Limited Example: `["Active","Limited","Cancelled","Expired"]`	No
market	[ string ]	Fare record's market. Wildcards ^,%,_ can be used. Example: `["WASLON","NYCSYD","ATLBOS","WAS%","SYD%","^ATLBOS","%LON","WASLON","+My Market group","WASLON","^+My Market group"]`	No
fareClass	[ string ]	Fare class code of the fare record. Wildcards ^,%,_ can be used. Example: `["C__AD_S_","CNH%","^CNH_D_S_","CQH_E_S_"]`	No
fareAmount	[ string ]	Filed base fare amount of the fare record. For US domestic fares, this will also include US Federal Excise tax. Wildcards ^ can be used. Example: `["244.70","199.70",">=244.70","<=244.70","^244.70","^199.70"]`	No
farePlusCif	[ string ]	Sum of the base fare amount and carrier-imposed fees. For US domestic fares, this will also include US Federal Excise tax. Wildcards ^,# can be used. Example: `["244.70","199.70",">=244.70","<=244.70","^244.70","^199.70"]`	No
totalCifAmount	[ string ]	Carrier-imposed fees for the itinerary. Wildcards ^,# can be used. Example: `["244.70","199.70",">=244.70","<=244.70","^244.70","^199.70"]`	No
totalYqAmount	[ string ]	Carrier-imposed (YQ) fees for the itinerary. Wildcards ^,# can be used. Example: `["244.70","199.70",">=244.70","<=244.70","^244.70","^199.70"]`	No
totalYrAmount	[ string ]	Carrier-imposed (YR) fees for the itinerary. Wildcards ^,# can be used. Example: `["244.70","199.70",">=244.70","<=244.70","^244.70","^199.70"]`	No
total6hAmount	[ string ]	Carrier-imposed (6H) fees for the itinerary. Wildcards ^,# can be used. Example: `["244.70","199.70",">=244.70","<=244.70","^244.70","^199.70"]`	No
total6iAmount	[ string ]	Carrier-imposed (6I) fees for the itinerary. Wildcards ^,# can be used. Example: `["244.70","199.70",">=244.70","<=244.70","^244.70","^199.70"]`	No
total6jAmount	[ string ]	Carrier-imposed (6J) fees for the itinerary. Wildcards ^,# can be used. Example: `["244.70","199.70",">=244.70","<=244.70","^244.70","^199.70"]`	No
total6kAmount	[ string ]	Carrier-imposed (6K) fees for the itinerary. Wildcards ^,# can be used. Example: `["244.70","199.70",">=244.70","<=244.70","^244.70","^199.70"]`	No
currency	[ string ]	Currency code that is associated with the fare. Wildcards ^,%,_ can be used. Example: `["AUD","USD","INR","CAD","_UD","%D","^AUD","^USD"]`	No
itinSource	[ string ]	Source of the itinerary used in the calculation of CIF amount, surcharge, and tax amount. Wildcards ^,%,_,# can be used. Example: `["HUBMOCK","HUBOAG","MOCK","OAG","HUB%","%%%MOCK","^HUBMOCK","MOCK"]`	No
routingOutbound	[ string ]	Outbound routing that were used to calculate the carrier-imposed fees. Wildcards ^,%,_,# can be used. Example: `["WAS-LON","NYC-PAR","NO ITIN FOUND - SCHEDULE","NO ITIN FOUND - FLIGHT APPLICATION","NO ITIN FOUND - TRANSFERS","NO ITIN FOUND - ROUTING","NO ITIN FOUND","NO ITIN FOUND - SYSTEM ERROR","SEA-LAX-NYC-PPT","SEA-LAX[PDX]-NYC[IAD]-PPT","NO ITIN FOUND - SCHEDULE","NO ITIN FOUND - TRANSFERS","SEA-LAX-NYC-___","NO ITIN FOUND%","^No ITIN FOUND%"]`	No
oneWayRoundtripIndicator	[ string ]	One way roundtrip indicator. Wildcards ^,%,_ can be used. Example: `["1","2","3","^1","^2","^3","_","%"]`	No
fareTypeCode	[ string ]	Fare Type Code (FTC) that is associated with the fare record. Wildcards ^,%,_,# can be used. Example: `["ER","XAB","EOU","EU","XEF","XEL","X_F","X_L","^BU","%U"]`	No
dayType	[ string ]	Day of week that is associated with the fare record. Wildcards ^,%_,# can be used. Codes: W - weekend X - midweek N - night O - off-peak time Y - weekend night Z - midweek night Example: `["W","X","N","O","Y","Z","^W","^N","_","%","#"]`	No
advancePurchase	[ string ]	Advance purchase (in number of days) for the fare record. Wildcards ^,%,_,# can be used. Example: `["3","7","50","120","^60","_","%1","^_","^#"]`	No
minimumStay	[ string ]	Minimum stay for the fare record. Wildcards ^,%,_,# can be used. Example: `["~1","#","~2/~SAT&1~SUN&1","~3/SUN","~2/~SAT","~1","~10","~3/SUN","~5/SUN","~7","^~SUN","^#","^~2/SUN","~2/~SAT%"]`	No
maximumStay	[ string ]	Maximum stay for the fare record. Wildcards ^,%,_,# can be used. Example: `["100N","30H","60D","12M","01MON","03TUES","12M	3M","#","%M","_2H","^#","^12M"]`
dowOutbound	[ string ]	Day of week for the outbound trip. Wildcards ^,%,_,# can be used. Example: `["1234567","123----","----67","----56-","1----67","%67","%_6%","^123----","^1---567","^#"]`	No
dowInbound	[ string ]	Day of week for the inbound trip. Wildcards ^,%,_,# can be used. Example: `["1234567","123----","----67","----56-","1----67","%67","%_6%","^123----","^1---567","^#"]`	No
footnote	[ string ]	Footnote codes that are held by the fare. Wildcards ^,%,_,# can be used. Example: `["1A","C1","AA","50","5","5V","#","A_","%A","^5","^AA","^#"]`	No
routingNumber	[ string ]	Routing number that is associated with the fare. Wildcards ^ can be used. Example: `["0","21","21","316","1000","^1000","^316"]`	No
travelRestrictions	[ string ]	Fare records exact text that is held in the Travel Restrictions field of the scope data. Wildcards ^,# can be used. Example: `["01OCT24-30SEP25","-31DEC25","10NOV21-15DEC25","11DEC25","#"]`	No
salesRestrictions	[ string ]	Fare records exact text that is held in the Sales Restrictions field of the scope data. Wildcards ^,# can be used. Example: `["01OCT24-30SEP25","-31DEC25","10NOV21-15DEC25","11DEC25","#"]`	No
firstTravelDate	[ string ]	Information derived from the Commence On/After field of Travel Restrictions (Category 14) in FareManager Footnotes and Rules. Wildcards ^,# can be used. Example: `["11JUL25",">=11JUL25","<=11JUL25","#","^11JUL25","^#"]`	No
lastCommenceDate	[ string ]	Information derived from the Commence On/Before field of Travel Restrictions (Category 14) in FareManager Footnotes and Rules. Wildcards ^,# can be used. Example: `["11JUL25",">=11JUL25","<=11JUL25","#","^11JUL25","^#"]`	No
returnTravelDate	[ string ]	Information derived from the Return By Date field of Travel Restrictions (Category 14) in FareManager Footnotes and Rules. Wildcards ^,# can be used. Example: `["11JUL25",">=11JUL25","<=11JUL25","#","^11JUL25","^#"]`	No
firstSaleDate	[ string ]	Information derived from the Tickets Must Be Issued On/After field of Sales Restrictions (Category 15) in FareManager Footnotes and Rules. Wildcards ^,# can be used. Example: `["11JUL25",">=11JUL25","<=11JUL25","#","^11JUL25","^#"]`	No
lastSaleDate	[ string ]	Information derived from the Tickets Must Be Issued On/Before field of Sales Restrictions (Category 15) in FareManager Footnotes and Rules. Wildcards ^,# can be used. Example: `["11JUL25",">=11JUL25","<=11JUL25","#","^11JUL25","^#"]`	No
firstReservationDate	[ string ]	Information derived from the Reservations Must be Made On/After field in Sales Restrictions (Category 15) in FareManager Footnotes and Rules. Wildcards ^,# can be used. Example: `["11JUL25",">=11JUL25","<=11JUL25","#","^11JUL25","^#"]`	No
lastReservationDate	[ string ]	Information derived from the Reservations Must be Made On/Before field in Sales Restrictions (Category 15) in FareManager Footnotes and Rules. Wildcards ^,# can be used. Example: `["11JUL25",">=11JUL25","<=11JUL25","#","^11JUL25","^#"]`	No
nonRefundable	[ string ]	Refundability provision of the fare. Wildcards ^,%,_,# can be used. Example: `["NR","RF","#","_NR","N%","^#"]`	No
volRefundsFee	[ string ]	Voluntary Refunds Fee provision of the fare. Wildcards ^,#,_ can be used. Example: `["NR","RF","100.00 USD","200.00 EUR","#","^#","N_","100.00 __D"]`	No
volchangePermitted	[ string ]	Voluntary Changes Permitted provision of the fare. Wildcards ^,%,_,# can be used. Example: `["NO","YES","#","_ES","N%","^#"]`	No
volChangesFee	[ string ]	Voluntary Changes Fee provision of the fare. Wildcards ^,#,_ can be used. Example: `["NR","RF","100.00 USD","200.00 EUR","#","^#","N_","100.00 __D"]`	No
passengerType	[ string ]	Passenger type code that is associated with the fare record. Wildcards ^,_,%,# can be used. Example: `["ADT","STU","STA","GIT+","S%","ST_","^ADT","^MIS"]`	No
ruleNumber	[ string ]	Fare rule number that is associated with the fare record. Wildcards ^,_,%,# can be used. Example: `["NAC1","R3GB","5436","GM06","GM%","GM_6","^NAC1","^GM06","^5436"]`	No
globalIndicator	[ string ]	Global indicator code that is associated with the fare record. Wildcards ^,_,%,# can be used. Example: `["AT","WH","EH","US","TB","%H","_H","^AT","^WH"]`	No
tariffNumber	[ string ]	Fare tariff number that is associated with the fare record. Wildcards ^,% can be used. Example: `["4","8","88","20","0","^30","8%"]`	No
oneWayAmount	[ string ]	One-way fare amount. Wildcards ^ can be used. Example: `["244.70","199.70",">=244.70","<=244.70","^244.70","^199.70"]`	No
roundTripAmount	[ string ]	Round-trip fare amount. Wildcards ^,# can be used. Example: `["244.70","199.70",">=244.70","<=244.70","^244.70","^199.70"]`	No
rbd	[ string ]	Prime reservation booking code designator (RBD) code that is associated with the fare record. Wildcards ^,_,%,# can be used. Example: `["A","B","C","^B","^C","%","_"]`	No
effectiveDate	[ string ]	Fare record's effective date. Wildcards ^,# can be used Example: `["11JUL25",">=11JUL25","<=11JUL25","#","^#","^11JUL25"]`	No
discontinueDate	[ string ]	Fare record's discontinue date. Wildcards ^,# can be used. Example: `["11JUL25",">=11JUL25","<=11JUL25","#","^#","^11JUL25"]`	No
gfsFan	[ string ]	ATPCO Government Filing System (GFS) filing advice number (FAN) that is associated with the fare record. Wildcards ^,_,%,# can be used. Example: `["AFR","CCI","B80","AF_","%R","^AFR","^CCI","^B80"]`	No
gfsDate	[ string ]	ATPCO Government Filing System (GFS) filing advice date (FAN) that is associated with the fare record. Wildcards ^,# can be used. Example: `["11JUL25",">=11JUL25","<=11JUL25","#","^#","^11JUL25"]`	No
subsDate	[ string ]	Date at which subscriptions (subs) published the fare record. Wildcards ^,# can be used. Example: `["11JUL25",">=11JUL25","<=11JUL25","#","^#","^11JUL25"]`	No
subsTime	[ string ]	Time at which subscriptions (subs) published the fare record. Wildcards ^,_,%,# can be used. Example: `["01:00","08:00","23:00","23%","23:_","^08:00"]`	No
actionCode	[ string ]	Last action that was taken on the fare. Wildcards ^,# can be used. Example: `["I","R","O","X","N","W","^R"]`	No
surchargeAmount	[ string ]	Resolved Category 12 charges coded for the fare. Wildcards ^,# can be used. Example: `["244.70","199.70",">=244.70","<=244.70","^244.70","^199.70"]`	No
cabin	[ string, Available values: "Economy", "Business", "First", "Premium Economy" ]	Cabin that is identified with the fare record Example: `["Economy","Business","First","Premium Economy"]`	No
seasonalityOutbound	[ string ]	Seasonality ranges for outbound travel. Wildcards ^,_,%,# can be used. Example: `["08MAY27-05JUL27","05SEP27-10OCT27","14___-13DEC","01JAN-23JUN","^21DEC25-28DEC25","^#"]`	No
seasonalityInbound	[ string ]	Seasonality ranges for inbound travel. Wildcards ^,_,%,# can be used. Example: `["08MAY27-05JUL27","05SEP27-10OCT27","14___-13DEC","01JAN-23JUN","^21DEC25-28DEC25","^#"]`	No
blackoutOutbound	[ string ]	Blackout outbound dates that are associated with the fare record . Wildcards ^,_,%,# can be used. Example: `["08MAY27-05JUL27","05SEP27-10OCT27","14___-13DEC","01JAN-23JUN","^21DEC25-28DEC25","^#"]`	No
blackoutInbound	[ string ]	Blackout inbound dates that are associated with the fare record. Wildcards ^,_,%,# can be used. Example: `["08MAY27-05JUL27","05SEP27-10OCT27","14___-13DEC","01JAN-23JUN","^21DEC25-28DEC25","^#"]`	No
seasonality	[ string ]	Season that is associated with the fare record . Wildcards ^,_,%,# can be used. Codes: H - High L - Low/off peak J - Basic O - Shoulder P - Peak of peak Q - Holiday Z - Second winter Example: `["H","L","J","O","P","Q","Z","%","_","^#"]`	No
totalPriceAmount	[ string ]	Total price amount of the fare. Wildcards ^,# can be used. Example: `["244.70","199.70",">=244.70","<=244.70","^244.70","^199.70"]`	No
totalTaxAmount	[ string ]	Tax amount of the fare. Wildcards ^,# can be used. Example: `["244.70","199.70",">=244.70","<=244.70","^244.70","^199.70"]`	No
nonstop	[ string ]	Non stop flag. Wildcards ^,_,%,# can be used. Example: `["YES","NO","#","_ES","N%","^#"]`	No
direct	[ string ]	Direct flag. Wildcards ^,_,%,# can be used. Example: `["YES","NO","#","_ES","N%","^#"]`	No
originAirport	[ string ]	From/To/Via origin airport code. Wildcards ^,%,_,# can be used. Example: `["IAD","WAS","%S","^IAD","IA_"]`	No
destinationAirport	[ string ]	From/To/Via destination airport code. Wildcards ^,%,_,# can be used. Example: `["IAD","WAS","%S","^IAD","IA_"]`	No
outboundFareClass	[ string ]	Fare class codes that are associated with outbound travel. Wildcards ^,%,_,# can be used. This WEB attribute is not supported for update operations. Example: `["CADADS","CNH","CNHDS","CQHES"]`	No
inboundFareClass	[ string ]	Fare class codes that are associated with inbound travel. Wildcards ^,%,_,# can be used. This WEB attribute is not supported for update operations. Example: `["CADADS","CNH","CNHDS","CQHES","^#"]`	No
outboundFareFamily	[ string ]	Fare family relationships, received from the Web source, which are associated with outbound travel. Wildcards ^,# can be used. This WEB attribute is not supported for update operations. Example: `["light","basic"]`	No
inboundFareFamily	[ string ]	Fare family relationships, received from the Web source, which are associated with inbound travel. Wildcards ^,# can be used. This WEB attribute is not supported for update operations. Example: `["CADADS","CNH","CNHDS","CQHES"]`	No
observationDate	[ string ]	The date on which the data was retrieved from web sources. Wildcards ^,# can be used. This WEB attribute is not supported for update operations. Example: `["22SEP25","23SEP25"]`	No
observationTime	[ string ]	Time when the data was retrieved from web sources. The format is HH:MM (hours and minutes). Wildcards ^,_,%,# can be used. This WEB attribute is not supported for update operations. Example: `["18:00","09:30","#"]`	No

ConditionRowMatchNewData

New Data refers to fares that are not included in the scope but that are being created as new fares within the same Blueprint

Name	Type	Description	Required
carrier	[ string ]	Carrier that is associated with the fare record. Wildcards ^,%,_ can be used. Example: `["_A","A%","^AA","^DL","LA","AS","UX","AA","+My carrier group","+US carriers","^+My carrier group"]`	No
tariffNumber	[ string ]	Fare tariff number that is associated with the fare record. Wildcards ^,% can be used. Example: `["4","8","88","20","0","^30","8%"]`	No
footnote	[ string ]	Footnote codes that are held by the fare. Wildcards ^,%,_,# can be used. Example: `["1A","C1","AA","50","5","5V","#","A_","%A","^5","^AA","^#","&"]`	No
routingNumber	[ string ]	Routing number that is associated with the fare. Wildcards ^ can be used. Example: `["0","21","21","316","1000","^1000","^316"]`	No
fareClass	[ string ]	Fare class code of the fare record. Wildcards ^,%,_ can be used. Example: `["C__AD_S_","CNH%","^CNH_D_S_","CQH_E_S_","#CQH_E_S","^#CQH_E_S"]`	No
origin	[ string ]	Fare record's origin city or airport. Wildcards ^,%,_ can be used. Example: `["_ON","%S","^AT%","^WAS","LON","ATL","+My city group","+GB cities","ATL","^+My city group"]`	No
destination	[ string ]	Fare record's destination city or airport. Wildcards ^,%,_ can be used. Example: `["_ON","%S","^AT%","^WAS","LON","ATL","+My city group","+GB cities","ATL","^+My city group"]`	No
market	[ string ]	Fare record's market. Wildcards ^,%,_ can be used. Example: `["WASLON","NYCSYD","ATLBOS","WAS%","SYD%","^ATLBOS","%LON","WASLON","+My Market group","WASLON","^+My Market group"]`	No
originCountry	[ string ]	Country of fare origin. Wildcards ^,%,_ can be used. Example: `["_S","U%","^CA","US","+My country group","+91 countries","^+My country group"]`	No
destinationCountry	[ string ]	Country of fare destination. Wildcards ^,%,_ can be used. Example: `["_S","U%","^CA","US","+My country group","+91 countries","^+My country group"]`	No
oneWayAmount	[ string ]	One way fare amount match. Wildcards ^ can be used. Example: `["244.70","199.70",">=244.70","<=244.70","^244.70","^199.70"]`	No
fareAmount	[ string ]	Fare amount match. Wildcards ^ can be used. Example: `["244.70","199.70",">=244.70","<=244.70","^244.70","^199.70"]`	No
oneWayRoundtripIndicator	[ string ]	One way roundtrip indicator. Wildcards ^,%,_ can be used. Example: `["1","2","3","^1","^2","^3","_","%"]`	No
cabin	[ string, Available values: "Economy", "Business", "First", "Premium Economy" ]	Cabin that is identified with the fare record Example: `["Economy","Business","First","Premium Economy"]`	No
currency	[ string ]	Currency code that is associated with the fare. Wildcards ^,%,_ can be used. Example: `["AUD","USD","INR","CAD","_UD","%D","^AUD","^USD"]`	No

ConditionRowMatchMarketParameters

Dynamic market parameters with flexible property names as string arrays

Name	Type	Description	Required
ConditionRowMatchMarketParameters	object	Dynamic market parameters with flexible property names as string arrays

Example

{
  "MarketType": [
    "$scopeData.carrier",
    ">=$newData.fareAmount"
  ],
  "firstSellup": [
    "202",
    "203"
  ]
}

ConditionRowMatchBrands

Dynamic brand parameters with flexible property names as string arrays

Name	Type	Description	Required
ConditionRowMatchBrands	object	Dynamic brand parameters with flexible property names as string arrays

Example

{
  "CarryOn": [
    "2",
    "1"
  ],
  "tariff": [
    "8",
    "9"
  ]
}

ConditionRowMatchWebFareParameters

Dynamic web fare parameters with flexible property names as string arrays

Name	Type	Description	Required
ConditionRowMatchWebFareParameters	object	Dynamic web fare parameters with flexible property names as string arrays

Example

{
  "WebRBD": [
    "A",
    "Y"
  ],
  "discount": [
    "15",
    "20"
  ]
}

ConditionRowMatch

Match conditions (IF part)

Name	Type	Required
scopeData	ConditionRowMatchScopeData	No
newData	ConditionRowMatchNewData	No
marketParameters	ConditionRowMatchMarketParameters	No
brands	ConditionRowMatchBrands	No
webFareParameters	ConditionRowMatchWebFareParameters	No

ConditionRowApply

Apply actions (THEN part) - explicitly defined properties

Name	Type	Description	Required
actionCode	string, Available values: "New", "Cancel", "Exclude", "Modify"	Condition action code. Enum: `"New"`, `"Cancel"`, `"Exclude"`, `"Modify"` Example: `"New"`	No
carrier	string	Carrier that is associated with the fare record. Example: `"AA"`	No
tariffNumber	string	Fare tariff number that is associated with the fare record. Example: `"127"`	No
footnote	string	Footnote codes that are held by the fare. Example: `"1A"`	No
routingNumber	string	Routing number that is associated with the fare. Example: `"3160"`	No
fareClass	string	Fare class code of the fare record Example: `"CNH1D4S5"`	No
origin	string	Fare record's origin city or airport. Example: `"WAS"`	No
destination	string	Fare record's destination city or airport. Example: `"LON"`	No
fareAmount	string	Amount of the fare that is affected by the condition. Example: `"$fareAmount+100"`	No
oneWayRoundtripIndicator	string	One way roundtrip indicator. Example: `"1"`	No
currency	string	Currency of the fare that is affected by the condition. Example: `"USD"`	No
cabin	string, Available values: "Economy", "Premium Economy", "Business", "First"	Cabin of the fare that is affected by the condition. Enum: `"Economy"`, `"Premium Economy"`, `"Business"`, `"First"` Example: `"Economy"`	No
oneWayAmount	string	One way amount of the fare that is affected by the condition. Example: `"$fareAmount+$totalYqAmount"`	No
totalPriceAmount	string	Total price amount of the fare that is affected by the condition. Example: `"$marketParameters.MY PARAM+100"`	No
rounding	string, Available values: "Up", "Down", "Nearest Decimals", "Nearest Disregard Extra Decimals", "Up on Disregard Extra Decimals", "Round Down On Disregard Extra Decimals", "Up Even", "Up To Value", "Nearest - Disregard Last Decimal", "Down On - Disregard Last Decimal", "Up On - Disregard Last Decimal"	Apply round directions to the base fare amount Enum: `"Up"`, `"Down"`, `"Nearest Decimals"`, `"Nearest Disregard Extra Decimals"`, `"Up on Disregard Extra Decimals"`, `"Round Down On Disregard Extra Decimals"`, `"Up Even"`, `"Up To Value"`, `"Nearest - Disregard Last Decimal"`, `"Down On - Disregard Last Decimal"`, `"Up On - Disregard Last Decimal"` Example: `"Up"`	No
unit	string, Available values: ".001", ".01", ".1", "1", "10", "100", "1000", "10000", "9", ".25", "25.00"	Apply rounding unit to the base fare amount. Enum: `".001"`, `".01"`, `".1"`, `"1"`, `"10"`, `"100"`, `"1000"`, `"10000"`, `"9"`, `".25"`, `"25.00"` Example: `".01"`	No
offset	string	Apply rounding offset to the base fare amount Example: `"=+99.9"`	No

ConditionRow

Name	Type	Description	Required
match	ConditionRowMatch		Yes
apply	ConditionRowApply		Yes

ConditionContent

Name	Type	Description	Required
rows	[ ConditionRow ]	Array of blueprint condition rows objects	Yes

ConditionDetail

Name	Type	Description	Required
id	integer	Unique ID of the condition Example: `2892`	Yes
name	string	Name of the condition Example: `"CANCEL FARES for FARECLASS = %Y"`	Yes
description	string	Description of the condition Example: `"Test"`	Yes
createdBy	AuditCreatedBy		Yes
createdAt	AuditCreatedAt		Yes
updatedBy	AuditUpdatedBy		Yes
updatedAt	AuditUpdatedAt		Yes
content	ConditionContent		Yes