Blueprint API


Blueprint API

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

Version: 1.0.34

Contact information:
Architect API Support
[email protected]

License: Apache-2.0

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
  • 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
  • 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

CodeDescriptionSchema
200OK
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"
400Bad Request
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
401Unauthorized
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
403Forbidden
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
404Not Found
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
429Too Many Requests
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
500Internal Server Errorapplication/problem+json: ProblemDetails
503Service Unavailable
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 SchemaScopes
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

CodeDescriptionSchema
200Success
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
400Bad Request
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
401Unauthorized
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
403Forbidden
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
404Not Found
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
429Too Many Requests
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
500Internal Server Errorapplication/problem+json: ProblemDetails
503Service Unavailable
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 SchemaScopes
atpcoOAuthpi.architect.blueprint.api.read
atpcoOAuthGoldpi.architect.blueprint.api.read

Conditions

Blueprints Conditions APIs

[GET] /conditions

Get all conditions for host carrier

Retrieve a list of all conditions for host carrier

Responses

CodeDescriptionSchema
200Success
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
400Bad Request
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
401Unauthorized
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
403Forbidden
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
404Not Found
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
429Too Many Requests
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
500Internal Server Errorapplication/problem+json: ProblemDetails
503Service Unavailable
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 SchemaScopes
atpcoOAuthpi.architect.blueprint.api.read
atpcoOAuthGoldpi.architect.blueprint.api.read

[GET] /conditions/{id}

Get a specific condition by ID

Retrieve condition details for the given condition ID.

Parameters

NameLocated inDescriptionRequiredSchema
idpathUnique identifier of the conditionYesinteger,
Default: 2892

Responses

CodeDescriptionSchema
200Success
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
400Bad Request
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
401Unauthorized
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
403Forbidden
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
404Not Found
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
429Too Many Requests
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
500Internal Server Errorapplication/problem+json: ProblemDetails
503Service Unavailable
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 SchemaScopes
atpcoOAuthpi.architect.blueprint.api.read
atpcoOAuthGoldpi.architect.blueprint.api.read

[PUT] /conditions/{id}

Update condition content by ID

Update the content of a specific condition by ID.

Parameters

NameLocated inDescriptionRequiredSchema
idpathUnique identifier of the condition to updateYesinteger

Request Body

RequiredSchema
Yesapplication/json: ConditionDetailRequest

Responses

CodeDescriptionSchema
200Condition 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
400Bad Request
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
401Unauthorized
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
403Forbidden
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
404Not Found
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
429Too Many Requests
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
500Internal Server Errorapplication/problem+json: ProblemDetails
503Service Unavailable
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 SchemaScopes
atpcoOAuthpi.architect.blueprint.api.write
atpcoOAuthGoldpi.architect.blueprint.api.write

Example Request


Schemas

BlueprintsListResponse

NameTypeDescriptionRequired
blueprints[ BlueprintSummary ]Array of blueprint summary objectsYes

BlueprintSummary

NameTypeDescriptionRequired
idintegerUnique identifier of the blueprint
Example: 261
Yes
namestringName of the blueprint
Example: "TEST MATCH"
Yes
typestring,
Available values: "General", "Historic", "Web"
Type of the blueprint
Enum: "General", "Historic", "Web"
Example: "General"
Yes
createdBystringID of the user who created this blueprint
Example: "X91XXXX"
Yes
createdAtdateTimeCondition created date and time (ISO 8601)
Example: "2022-01-04T19:16:26.211Z"
Yes

ConditionsListResponse

NameTypeDescriptionRequired
conditions[ ConditionSummary ]Array of condition summary objectsYes

ConditionSummary

NameTypeDescriptionRequired
idintegerUnique identifier of the condition
Example: 123
Yes
namestringName of the condition
Example: "CANCEL FARES for FARECLASS = %Y"
Yes
createdBystringID of the user who created this condition
Example: "X91XXXX"
Yes
createdAtdateTimeCondition created date and time (ISO 8601)
Example: "2022-01-04T19:16:26.211Z"
Yes

ConditionDetailRequest

NameTypeDescriptionRequired
contentConditionContentYes

ConditionDetailResponse

NameTypeDescriptionRequired
dataConditionDetailYes

ConditionDetail

NameTypeDescriptionRequired
idintegerUnique ID of the condition
Example: 2892
Yes
namestringName of the condition
Example: "CANCEL FARES for FARECLASS = %Y"
Yes
descriptionstringDescription of the condition
Example: "Test"
Yes
createdBystringUser ID who created the Condition
Example: "X91XXXX"
Yes
createdAtdateTimeCondition created date and time (ISO 8601)
Example: "2022-01-04T19:16:26.211Z"
Yes
updatedBystringUser ID who updated the Condition
Example: "X91XXXX"
Yes
updatedAtdateTimeCondition updated date and time (ISO 8601)
Example: "2022-01-04T19:16:26.211Z"
Yes
contentConditionContentYes

ConditionContent

NameTypeDescriptionRequired
rows[ ConditionRow ]Array of blueprint condition rows objectsYes

ConditionRow

NameTypeDescriptionRequired
matchConditionRow_matchYes
applyConditionRow_applyYes

ProblemDetails

Standard error format (RFC 9457 “Problem Details”)

NameTypeDescriptionRequired
typestring (uri)A URI reference that identifies the problem type. Ideally a public HTTP URI pointing to a problem description.Yes
titlestringShort, human-readable summary of the problem in general.Yes
statusintegerHTTP status code.Yes
detailstringHuman-readable explanation specific to this occurrence.No
instancestring (uri)A URI reference that identifies the specific occurrence. Possibly opaque to the client.Yes
timestampdateTimeDate and time (in UTC) when the error occurred.Yes
retryablebooleanIndicates whether the client can retry the same request.No

ConditionRow_match_scopeData

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.

NameTypeDescriptionRequired
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

ConditionRow_match_newData

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

NameTypeDescriptionRequired
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

ConditionRow_match

Match conditions (IF part)

NameTypeDescriptionRequired
scopeDataConditionRow_match_scopeDataNo
newDataConditionRow_match_newDataNo
marketParametersobjectDynamic market parameters with flexible property names as string arrays
Example: {"MarketType":["$scopeData.carrier",">=$newData.fareAmount"],"firstSellup":["202","203"]}
No
brandsobjectDynamic brand parameters with flexible property names as string arrays
Example: {"CarryOn":["2","1"],"tariff":["8","9"]}
No
webFareParametersobjectDynamic web fare parameters with flexible property names as string arrays
Example: {"WebRBD":["A","Y"],"discount":["15","20"]}
No

ConditionRow_apply

Apply actions (THEN part) - explicitly defined properties

NameTypeDescriptionRequired
actionCodestring,
Available values: "New", "Cancel", "Exclude", "Modify"
Condition action code.
Enum: "New", "Cancel", "Exclude", "Modify"
Example: "New"
No
carrierstringCarrier that is associated with the fare record.
Example: "AA"
No
tariffNumberstringFare tariff number that is associated with the fare record.
Example: "127"
No
footnotestringFootnote codes that are held by the fare.
Example: "1A"
No
routingNumberstringRouting number that is associated with the fare.
Example: "3160"
No
fareClassstringFare class code of the fare record
Example: "CNH1D4S5"
No
originstringFare record's origin city or airport.
Example: "WAS"
No
destinationstringFare record's destination city or airport.
Example: "LON"
No
fareAmountstringAmount of the fare that is affected by the condition.
Example: "$fareAmount+100"
No
oneWayRoundtripIndicatorstringOne way roundtrip indicator.
Example: "1"
No
currencystringCurrency of the fare that is affected by the condition.
Example: "USD"
No
cabinstring,
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
oneWayAmountstringOne way amount of the fare that is affected by the condition.
Example: "$fareAmount+$totalYqAmount"
No
totalPriceAmountstringTotal price amount of the fare that is affected by the condition.
Example: "$marketParameters.MY PARAM+100"
No
roundingstring,
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
unitstring,
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
offsetstringApply rounding offset to the base fare amount
Example: "=+99.9"
No

Example Request