{"info":{"_postman_id":"7c591c1b-f1e5-427b-ba26-3214cd5f609f","name":"Commission Manager","description":"

Introduction

Commission Manager (CM) helps Galileo GDS users to consistently collect commission for their reservations. It transfers responsibility for choosing the right commission rate from reservation handlers to a machine.

Ways of usage

There are three ways CM can help you with your commissions.

CM Online calculator - a web page for calculating the commission.
CM Smartpoint plugin - a tool for storing the commission into the booking file.
CM API - a service for inserting the commission into the reservation.

Getting started

Contact {{contactEmail}}
Get your authentication token for Online calculator and API access or a Smartpoint plugin
Define your commission rules - through our Backoffice application or through API
Start calculating and storing your commission rates

Examples of usage

Definition of the Commission rule in CM Backoffice

$\"\"$

It is also possible to create Commission rules through CM API.

CM Online calculator

The Online calculator is a simple page where you can easily test your access Token with a real reservation. You can also use it for Commission calculations.

$\"\"$

The URL is {{calculatorUrl}}.

CM Smartpoint plugin

Our helpdesk can also deliver CM Smartpoint plugin. You can install it into your Travelport Smartpoint application. It supports calculating and storing commission into open PNR by simple commands.

CM API

The CM API is rest api running on the URL https://cm.cee-systems.com/prod/ and provides endpoinds for storing and calculation Commission and for managing Commission Rules.

CM API - Mock server

This documentation servers also as a mock server. You can immediately start to send requests.

CM API Documentation

There are several resources for commission and commission rules handling. You can use them:

for storing the commission into a reservation
for calculating the commission
for management of commission rules

Authorization

Accessing any resource is possible only with http header:

Authorization: <AuthorizationToken>\n

AuthorizationToken will be provided to you by {{contactEmail}}.

Common error handling

Common error structure:

{\n  \"Error\": {\n      \"Code\": \"<ErrorCode>\",\n      \"Detail\": \"<ErrorText>\"\n    }\n}\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Type	Description
ErrorCode	Enum	Code. It starts with category (Application, Retrieve, Store or GolApi.)
ErrorValue	String	Text.

Error in CM configuration

This error usually means misconfiguration on CM side. Contact {{contactEmail}}.

{\n    \"Error\": {\n        \"Code\": \"GolApi.1001\",\n        \"Detail\": \"Datasource for the application was deactivated.\"\n    }\n}\n

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting started","slug":"getting-started"},{"content":"Examples of usage","slug":"examples-of-usage"},{"content":"CM API - Mock server","slug":"cm-api-mock-server"},{"content":"CM API Documentation","slug":"cm-api-documentation"}],"owner":"7824806","collectionId":"7c591c1b-f1e5-427b-ba26-3214cd5f609f","publishedId":"SVYrtysR","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-08-08T07:10:28.000Z"},"item":[{"name":"Commission","item":[{"name":"Storing Commission","id":"53d89609-007e-4b58-aca5-1a55fa9d4597","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"{{apiUrl}}/reservation/v1/:pcc/:locator","description":"

This method calculates the commission for a given reservation and stores it into it.

\n","auth":{"type":"apikey","apikey":{"value":"{{authorizationToken}}","key":""},"isInherited":true,"source":{"_postman_id":"eb42084d-b7a0-40e4-98fb-0a92a2834fc7","id":"eb42084d-b7a0-40e4-98fb-0a92a2834fc7","name":"Commission","type":"folder"}},"urlObject":{"path":["reservation","v1",":pcc",":locator"],"host":["{{apiUrl}}"],"query":[],"variable":[{"id":"1b903432-2689-4093-b4e0-4955a78029a4","description":{"content":"

Agency's PCC.

\n","type":"text/plain"},"type":"string","value":"{{pcc}}","key":"pcc"},{"id":"88e0aacd-2beb-4e35-ae66-4f742e6f19fb","description":{"content":"

Locator of a reservation.

\n","type":"text/plain"},"type":"string","value":"{{locator}}","key":"locator"}]}},"response":[{"id":"a810f840-5cc6-4b1b-9b9f-d1fc34959264","name":"Storing Commission","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"{{apiUrl}}/reservation/v1/:pcc/:locator","host":["{{apiUrl}}"],"path":["reservation","v1",":pcc",":locator"],"variable":[{"key":"pcc","value":"{{pcc}}","description":"Agency's PCC."},{"key":"locator","value":"{{locator}}","description":"Locator of a reservation."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"257"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 25 Jul 2019 10:01:23 GMT"},{"key":"x-amzn-RequestId","value":"27a1c66e-aec3-11e9-8232-ad6e8fd468a8"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"dYCdyE8pliAFkHA="},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"Sat, 26 Jul 1997 05:00:00 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5d397df1-760796680c704e6a95242c63;Sampled=0"},{"key":"Pragma","value":"no-cache"},{"key":"Via","value":"1.1 d8328954e51c0912a8419c1a67cea1dc.cloudfront.net (CloudFront), 1.1 2b2e2811e641703aebf776da39317b9c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"FRA2-C1"},{"key":"X-Amz-Cf-Pop","value":"FRA2-C2"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"X-Amz-Cf-Id","value":"p0HAO1nvbBbo678TbMshnXyTLj4ZPds9TmI9SZcWh0cHT3QnmxOzXg=="}],"cookie":[],"responseTime":null,"body":"{\n \"Reservation\": {\n \"AirPricingInfo\": [\n {\n \"Group\": \"1\",\n \"Origin\": \"PRG\",\n \"Destination\": \"AMS\",\n \"PlatingCarrier\": \"KL\",\n \"BasePrice\": \"CZK2111\",\n \"Passenger\": [\n {\n \"Name\": \"pavel martinez\",\n \"Type\": \"ADT\"\n }\n ],\n \"Result\": {\n \"Commission\": {\n \"Type\": \"None\",\n \"Value\": \"No commission available.\"\n }\n }\n }\n ]\n }\n}"}],"_postman_id":"53d89609-007e-4b58-aca5-1a55fa9d4597"},{"name":"Calculating Commission","id":"d35f3832-f084-4c43-aac3-bffb8996c1a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{apiUrl}}/calculation/v1/:pcc/:locator","description":"

This method calculates the commission for a given reservation and returns it.

Request params response and error format are the same as with POST /reservation/v1/:pcc/:locator.

\n","auth":{"type":"apikey","apikey":{"value":"{{authorizationToken}}","key":""},"isInherited":true,"source":{"_postman_id":"eb42084d-b7a0-40e4-98fb-0a92a2834fc7","id":"eb42084d-b7a0-40e4-98fb-0a92a2834fc7","name":"Commission","type":"folder"}},"urlObject":{"path":["calculation","v1",":pcc",":locator"],"host":["{{apiUrl}}"],"query":[],"variable":[{"id":"7c9f5aa3-3b84-467e-8438-61ba272229dd","description":{"content":"

Agency's PCC.

\n","type":"text/plain"},"type":"string","value":"{{pcc}}","key":"pcc"},{"id":"0240a583-3c27-4730-8410-ebd056d66446","description":{"content":"

Locator of a reservation.

\n","type":"text/plain"},"type":"string","value":"{{locator}}","key":"locator"}]}},"response":[{"id":"b6df10dd-2760-4919-9b29-489d825f8b14","name":"Calculating Commission","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{apiUrl}}/calculation/v1/:pcc/:locator","host":["{{apiUrl}}"],"path":["calculation","v1",":pcc",":locator"],"variable":[{"key":"pcc","value":"{{pcc}}","description":"Agency's PCC."},{"key":"locator","value":"{{locator}}","description":"Locator of a reservation."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"257"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 25 Jul 2019 08:48:54 GMT"},{"key":"x-amzn-RequestId","value":"068f7b44-aeb9-11e9-a2ad-6d623354e8d0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"dX32BE-FFiAFddA="},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"Sat, 26 Jul 1997 05:00:00 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5d396cf3-3d2f3e426757dbbee49b53c0;Sampled=0"},{"key":"Pragma","value":"no-cache"},{"key":"Via","value":"1.1 69f13f852a135432abb1b7bfc5a8b421.cloudfront.net (CloudFront), 1.1 eb1a8c1b1275e33a016e623478052111.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"FRA2-C1"},{"key":"X-Amz-Cf-Pop","value":"FRA2-C2"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"X-Amz-Cf-Id","value":"CNE8m4h2sgTxd00IrzWyH81KY4r8RUQiE5-d7uBwZ6pdF_AUK1M50Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"Reservation\": {\n \"AirPricingInfo\": [\n {\n \"Group\": \"1\",\n \"Origin\": \"PRG\",\n \"Destination\": \"AMS\",\n \"PlatingCarrier\": \"KL\",\n \"BasePrice\": \"CZK2111\",\n \"Passenger\": [\n {\n \"Name\": \"pavel martinez\",\n \"Type\": \"ADT\"\n }\n ],\n \"Result\": {\n \"Commission\": {\n \"Type\": \"None\",\n \"Value\": \"No commission available.\"\n }\n }\n }\n ]\n }\n}"}],"_postman_id":"d35f3832-f084-4c43-aac3-bffb8996c1a5"}],"id":"eb42084d-b7a0-40e4-98fb-0a92a2834fc7","description":"

Commission endpoints provide API for storing or calculating Commission. Both methods use the same structure for returning calculated commission.

Successful response structure

{\n    \"Reservation\": {\n        \"AirPricingInfo\": [{\n            \"Group\": \"<group>\",\n            \"Origin\": \"<origin>\",\n            \"Destination\": \"<destination>\",\n            \"PlatingCarrier\": \"<platingCarrier>\",\n            \"BasePrice\": \"<currency><amount>\",\n            \"Passenger\": [{\n                \"Name\": \"<fullName>\",\n                \"Type\": \"<type>\"\n            }, ...],\n            \"Result\": {\n                \"Commission\": {\n                    \"Type\": \"<CommissionType>\",\n                    \"Value\": \"<CommissionValue>\"\n                }\n            }\n        }, ... ]\n    },\n    // if commission was stored but remark into PNR wasn't written\n    \"Warning\": {\n        \"Code\": \"Remark.<WarningCode>\",\n        \"Detail\": \"<WarningText>\"\n    }\n}\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Type	Description
CommissionType	Enum	One of: Flat, PercentBase, None
CommissionValue	String	Integer or float as a string or \"No commission available.\" constant.

No Commission Rule

If no Commission Rule for given reservation was found, empty Commission is returned:

\"Commission\": {\n     \"Type\": \"None\",\n     \"Value\": \"No commission available.\"\n}\n

Commission calculation error handling

Error on pricing level

Pricings from a reservation are processed separately, so error on pricing level is more structured:

{\n  \"Reservation\":\n  {\n    \"AirPricingInfo\":\n    [\n      {\n        \"Group\": \"1\",\n        \"Origin\": \"PRG\",\n        \"Destination\": \"LGW\",\n        \"PlatingCarrier\": \"FI\",\n        \"BasePrice\": \"CZK800\",\n        \"Passenger\":\n        [\n          {\n            \"Name\": \"VITMR SLANINKA\",\n            \"Type\": \"ADT\"\n          }\n        ],\n        \"Result\":\n        {\n          \"Error\":\n          {\n            \"Code\": \"Store.Failed\",\n            \"Detail\": \"Store commission failed.\"\n          }\n        }\n      }\n    ]\n  }\n}\n

Errors of calculating or storing

CM can calculate Commission only if reservation contains all necessary information.

Reservation without stored pricing

{\n    \"Error\": {\n        \"Code\": \"Retrieve.Invalid\",\n        \"Detail\": \"Reservation is missing required informations.\"\n    }\n}\n

Reservation with outdated pricing

{\n  \"Error\":\n  {\n    \"Code\": \"Retrieve.NoPrice\",\n    \"Detail\" : \"No price in reservation is viable for commission.\"\n  }\n}\n

Example of warning response

Sometimes only Warning can presented in successful response.

Missing remark

Failed attempt to add an remark with information about calculation of Commission into the reservation.

{\n  \"Reservation\":\n  {\n    \"AirPricingInfo\":\n    [\n      {\n        \"Group\": \"1\",\n        \"Origin\": \"PRG\",\n        \"Destination\": \"LGW\",\n        \"PlatingCarrier\": \"FI\",\n        \"BasePrice\": \"CZK1000\",\n        \"Passenger\":\n        [\n          {\n            \"Name\": \"VITMR SLANINKA\",\n            \"Type\": \"ADT\"\n          }\n        ],\n        \"Result\":\n        {\n          \"Commission\":\n          {\n            \"Type\": \"PercentBase\",\n            \"Value\": \"5\"\n          }\n        }\n      }\n    ]\n  },\n  \"Warning\":\n  {\n    \"Code\": \"Remark.Failed\",\n    \"Detail\": \"Failed to add remark to reservation.\"\n  }\n}\n

\n","auth":{"type":"apikey","apikey":{"value":"{{authorizationToken}}","key":""},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"39e3e3cf-5b59-4b38-a878-526861d8f482","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"03d30d4a-0e10-4f62-b4bf-66cda86af315","type":"text/javascript","exec":[""]}}],"_postman_id":"eb42084d-b7a0-40e4-98fb-0a92a2834fc7"},{"name":"Commission Rules","item":[{"name":"Creating Commission rule","id":"49bb2622-bb14-4cba-974f-26aab40afd56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UseAsCommission\": \"Y\",\n \"UseAsDiscount\": \"N\",\n \"ValidatingAirline\": \"KL\",\n \"Priority\": \"13\",\n \"ApplicableForJourneys\": {\n \"OneWay\": \"true\",\n \"Return\": \"true\"\n },\n \"MarketingAirlineCombination\": {\n \"Type\": \"AnyCombination\"\n },\n \"OperatingAirlineCombination\": {\n \"OperatingAirline\": [],\n \"Type\": \"AnyCombination\"\n },\n \"SelectedOrigin\": {\n \"Type\": \"Iata\",\n \"Value\": \"PRG\"\n },\n \"SelectedDestination\": {\n \"Type\": \"Iata\",\n \"Value\": \"CDG\"\n },\n \"CanBeOriginDestinationReversed\": {\n \"Value\": \"true\"\n },\n \"BookingClasses\": {\n \"BookingClass\": []\n },\n \"CommissionRulePassengers\": {\n \"CommissionRulePassenger\": []\n },\n \"Commission\": {\n \"Type\": \"PercentBase\",\n \"Value\": \"1\"\n },\n \"SalesDateRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n },\n \"OriginTravelRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n },\n \"DestinationTravelRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n }\n}"},"url":"{{apiUrl}}/rules/v1/:pcc","description":"

This method creates a new Commission rule for the Commission calculation.

\n","auth":{"type":"apikey","apikey":{"value":"{{authorizationToken}}","key":""},"isInherited":true,"source":{"_postman_id":"4df7caec-d9e3-4a8f-b806-0e10946b6dee","id":"4df7caec-d9e3-4a8f-b806-0e10946b6dee","name":"Commission Rules","type":"folder"}},"urlObject":{"path":["rules","v1",":pcc"],"host":["{{apiUrl}}"],"query":[],"variable":[{"id":"5bc8bf3d-9e93-4fe0-9672-8e4e181da0d0","description":{"content":"

Agency's PCC.

\n","type":"text/plain"},"type":"string","value":"{{pcc}}","key":"pcc"}]}},"response":[{"id":"ba099dcf-551d-4479-ac8e-13685dee7c76","name":"Creating Commission rule","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UseAsCommission\": \"Y\",\n \"UseAsDiscount\": \"N\",\n \"ValidatingAirline\": \"KL\",\n \"Priority\": \"13\",\n \"ApplicableForJourneys\": {\n \"OneWay\": \"true\",\n \"Return\": \"true\"\n },\n \"MarketingAirlineCombination\": {\n \"Type\": \"AnyCombination\"\n },\n \"OperatingAirlineCombination\": {\n \"OperatingAirline\": [],\n \"Type\": \"AnyCombination\"\n },\n \"SelectedOrigin\": {\n \"Type\": \"Iata\",\n \"Value\": \"PRG\"\n },\n \"SelectedDestination\": {\n \"Type\": \"Iata\",\n \"Value\": \"CDG\"\n },\n \"CanBeOriginDestinationReversed\": {\n \"Value\": \"true\"\n },\n \"BookingClasses\": {\n \"BookingClass\": []\n },\n \"CommissionRulePassengers\": {\n \"CommissionRulePassenger\": []\n },\n \"Commission\": {\n \"Type\": \"PercentBase\",\n \"Value\": \"1\"\n },\n \"SalesDateRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n },\n \"OriginTravelRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n },\n \"DestinationTravelRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n }\n}"},"url":{"raw":"{{apiUrl}}/rules/v1/:pcc","host":["{{apiUrl}}"],"path":["rules","v1",":pcc"],"variable":[{"key":"pcc","value":"{{pcc}}","description":"Agency's PCC."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"759"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 25 Jul 2019 12:07:29 GMT"},{"key":"x-amzn-RequestId","value":"c56ff875-aed4-11e9-be24-3363fa411e9c"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"dYU8AE9OFiAFeGQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5d399b80-ce66d3310e761312affa98f7;Sampled=0"},{"key":"Via","value":"1.1 d6b9c7bad28b271f1e800a50d49ab8a4.cloudfront.net (CloudFront), 1.1 ac0e9b19969df989a920e6d1b834d009.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"FRA2-C2"},{"key":"X-Amz-Cf-Pop","value":"FRA2-C2"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"X-Amz-Cf-Id","value":"4pcOGXaaXi_bmFpyyTSUD1I-2_wwj-GTB3OgxROFfbb8iyd0NSB8Ig=="}],"cookie":[],"responseTime":null,"body":"{\n \"CommissionRuleId\": \"2713\",\n \"CommissionRule\": {\n \"UseAsCommission\": \"Y\",\n \"UseAsDiscount\": \"N\",\n \"ValidatingAirline\": \"KL\",\n \"Priority\": \"13\",\n \"ApplicableForJourneys\": {\n \"OneWay\": \"true\",\n \"Return\": \"true\"\n },\n \"MarketingAirlineCombination\": {\n \"Type\": \"AnyCombination\"\n },\n \"OperatingAirlineCombination\": {\n \"OperatingAirline\": [],\n \"Type\": \"AnyCombination\"\n },\n \"SelectedOrigin\": {\n \"Type\": \"Iata\",\n \"Value\": \"PRG\"\n },\n \"SelectedDestination\": {\n \"Type\": \"Iata\",\n \"Value\": \"CDG\"\n },\n \"CanBeOriginDestinationReversed\": {\n \"Value\": \"true\"\n },\n \"BookingClasses\": {\n \"BookingClass\": []\n },\n \"CommissionRulePassengers\": {\n \"CommissionRulePassenger\": []\n },\n \"Commission\": {\n \"Type\": \"PercentBase\",\n \"Value\": \"1\"\n },\n \"SalesDateRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n },\n \"OriginTravelRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n },\n \"DestinationTravelRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n }\n }\n}"}],"_postman_id":"49bb2622-bb14-4cba-974f-26aab40afd56"},{"name":"Updating Commission rule","id":"e86aeae1-02ca-42f3-8b06-6d039674d494","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UseAsCommission\": \"Y\",\n \"UseAsDiscount\": \"N\",\n \"ValidatingAirline\": \"KL\",\n \"Priority\": \"13\",\n \"ApplicableForJourneys\": {\n \"OneWay\": \"true\",\n \"Return\": \"true\"\n },\n \"MarketingAirlineCombination\": {\n \"Type\": \"AnyCombination\"\n },\n \"OperatingAirlineCombination\": {\n \"OperatingAirline\": [],\n \"Type\": \"AnyCombination\"\n },\n \"SelectedOrigin\": {\n \"Type\": \"Iata\",\n \"Value\": \"PRG\"\n },\n \"SelectedDestination\": {\n \"Type\": \"Iata\",\n \"Value\": \"CDG\"\n },\n \"CanBeOriginDestinationReversed\": {\n \"Value\": \"true\"\n },\n \"BookingClasses\": {\n \"BookingClass\": []\n },\n \"CommissionRulePassengers\": {\n \"CommissionRulePassenger\": []\n },\n \"Commission\": {\n \"Type\": \"PercentBase\",\n \"Value\": \"2\"\n },\n \"SalesDateRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n },\n \"OriginTravelRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n },\n \"DestinationTravelRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n }\n}"},"url":"{{apiUrl}}/rules/v1/:pcc/:commissionRuleId","description":"

This method modifies the specified Commission rule.

\n","auth":{"type":"apikey","apikey":{"value":"{{authorizationToken}}","key":""},"isInherited":true,"source":{"_postman_id":"4df7caec-d9e3-4a8f-b806-0e10946b6dee","id":"4df7caec-d9e3-4a8f-b806-0e10946b6dee","name":"Commission Rules","type":"folder"}},"urlObject":{"path":["rules","v1",":pcc",":commissionRuleId"],"host":["{{apiUrl}}"],"query":[],"variable":[{"id":"b932dbed-15a6-43f3-85d2-f9137c973092","description":{"content":"

Agency's PCC.

\n","type":"text/plain"},"type":"string","value":"{{pcc}}","key":"pcc"},{"id":"3572fb3f-0ee5-40b5-9b55-22f7009593b3","description":{"content":"

Commission rule id.

\n","type":"text/plain"},"type":"string","value":"{{commissionRuleId}}","key":"commissionRuleId"}]}},"response":[{"id":"159e0420-8857-4993-b452-1adc51b01cbb","name":"Updating Commission rule","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UseAsCommission\": \"Y\",\n \"UseAsDiscount\": \"N\",\n \"ValidatingAirline\": \"KL\",\n \"Priority\": \"13\",\n \"ApplicableForJourneys\": {\n \"OneWay\": \"true\",\n \"Return\": \"true\"\n },\n \"MarketingAirlineCombination\": {\n \"Type\": \"AnyCombination\"\n },\n \"OperatingAirlineCombination\": {\n \"OperatingAirline\": [],\n \"Type\": \"AnyCombination\"\n },\n \"SelectedOrigin\": {\n \"Type\": \"Iata\",\n \"Value\": \"PRG\"\n },\n \"SelectedDestination\": {\n \"Type\": \"Iata\",\n \"Value\": \"CDG\"\n },\n \"CanBeOriginDestinationReversed\": {\n \"Value\": \"true\"\n },\n \"BookingClasses\": {\n \"BookingClass\": []\n },\n \"CommissionRulePassengers\": {\n \"CommissionRulePassenger\": []\n },\n \"Commission\": {\n \"Type\": \"PercentBase\",\n \"Value\": \"2\"\n },\n \"SalesDateRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n },\n \"OriginTravelRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n },\n \"DestinationTravelRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n }\n}"},"url":{"raw":"{{apiUrl}}/rules/v1/:pcc/:commissionRuleId","host":["{{apiUrl}}"],"path":["rules","v1",":pcc",":commissionRuleId"],"variable":[{"key":"pcc","value":"{{pcc}}","description":"Agency's PCC."},{"key":"commissionRuleId","value":"{{commissionRuleId}}","description":"Commission rule id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"759"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 25 Jul 2019 12:09:40 GMT"},{"key":"x-amzn-RequestId","value":"1404d9db-aed5-11e9-9c73-eb52896ae0c9"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"dYVQmG7lliAFTPg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5d399c03-cf51734dc64c1fe6d31116b2;Sampled=0"},{"key":"Via","value":"1.1 91ba7c34719cd9c69e0357c149b94b90.cloudfront.net (CloudFront), 1.1 ac0e9b19969df989a920e6d1b834d009.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"FRA2-C2"},{"key":"X-Amz-Cf-Pop","value":"FRA2-C2"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"X-Amz-Cf-Id","value":"FINhMJcDvUVN5D19SshwnhPSkr1-qiNTXk8S04McmoQr9LvhyrYx5g=="}],"cookie":[],"responseTime":null,"body":"{\n \"CommissionRuleId\": \"2713\",\n \"CommissionRule\": {\n \"UseAsCommission\": \"Y\",\n \"UseAsDiscount\": \"N\",\n \"ValidatingAirline\": \"KL\",\n \"Priority\": \"13\",\n \"ApplicableForJourneys\": {\n \"OneWay\": \"true\",\n \"Return\": \"true\"\n },\n \"MarketingAirlineCombination\": {\n \"Type\": \"AnyCombination\"\n },\n \"OperatingAirlineCombination\": {\n \"OperatingAirline\": [],\n \"Type\": \"AnyCombination\"\n },\n \"SelectedOrigin\": {\n \"Type\": \"Iata\",\n \"Value\": \"PRG\"\n },\n \"SelectedDestination\": {\n \"Type\": \"Iata\",\n \"Value\": \"CDG\"\n },\n \"CanBeOriginDestinationReversed\": {\n \"Value\": \"true\"\n },\n \"BookingClasses\": {\n \"BookingClass\": []\n },\n \"CommissionRulePassengers\": {\n \"CommissionRulePassenger\": []\n },\n \"Commission\": {\n \"Type\": \"PercentBase\",\n \"Value\": \"2\"\n },\n \"SalesDateRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n },\n \"OriginTravelRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n },\n \"DestinationTravelRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n }\n }\n}"}],"_postman_id":"e86aeae1-02ca-42f3-8b06-6d039674d494"},{"name":"Getting Commission rule","id":"85bc1f0b-393e-416b-930e-8d458a44a73c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{apiUrl}}/rules/v1/:pcc/:commissionRuleId","description":"

This method returns details the specified commission rule.

\n","auth":{"type":"apikey","apikey":{"value":"{{authorizationToken}}","key":""},"isInherited":true,"source":{"_postman_id":"4df7caec-d9e3-4a8f-b806-0e10946b6dee","id":"4df7caec-d9e3-4a8f-b806-0e10946b6dee","name":"Commission Rules","type":"folder"}},"urlObject":{"path":["rules","v1",":pcc",":commissionRuleId"],"host":["{{apiUrl}}"],"query":[],"variable":[{"id":"096d50cf-eac9-451c-86a0-f1dde43f87d6","description":{"content":"

Agency's PCC.

\n","type":"text/plain"},"type":"string","value":"{{pcc}}","key":"pcc"},{"id":"d7d9e7ce-b019-48c9-9260-935d8bc78c0b","description":{"content":"

Commission rule Id.

\n","type":"text/plain"},"type":"string","value":"{{commissionRuleId}}","key":"commissionRuleId"}]}},"response":[{"id":"06c1946f-2751-4d39-9aae-07c5211f7e5d","name":"Getting Commission rule","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{apiUrl}}/rules/v1/:pcc/:commissionRuleId","host":["{{apiUrl}}"],"path":["rules","v1",":pcc",":commissionRuleId"],"variable":[{"key":"pcc","value":"{{pcc}}","description":"Agency's PCC."},{"key":"commissionRuleId","value":"{{commissionRuleId}}","description":"Commission rule Id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"714"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 25 Jul 2019 12:09:24 GMT"},{"key":"x-amzn-RequestId","value":"0a951445-aed5-11e9-8bee-55ce76a06ae0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"dYVOIHZKliAFdiw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5d399bf4-c471f7ffa1d3825d6ff150bb;Sampled=0"},{"key":"Via","value":"1.1 c0486ca54d4ad5a3da496bc2b5f49cd2.cloudfront.net (CloudFront), 1.1 ac0e9b19969df989a920e6d1b834d009.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"FRA53"},{"key":"X-Amz-Cf-Pop","value":"FRA2-C2"},{"key":"Age","value":"61"},{"key":"X-Cache","value":"Hit from cloudfront"},{"key":"X-Amz-Cf-Id","value":"a-H0Q9YsNIQLpsPS5xFtEi-0g_MzvmdN1r8MzIkB0di3RZs5dhvZhg=="}],"cookie":[],"responseTime":null,"body":"{\n \"UseAsCommission\": \"Y\",\n \"UseAsDiscount\": \"N\",\n \"ValidatingAirline\": \"KL\",\n \"Priority\": \"13\",\n \"ApplicableForJourneys\": {\n \"OneWay\": \"true\",\n \"Return\": \"true\"\n },\n \"MarketingAirlineCombination\": {\n \"Type\": \"AnyCombination\"\n },\n \"OperatingAirlineCombination\": {\n \"OperatingAirline\": [],\n \"Type\": \"AnyCombination\"\n },\n \"SelectedOrigin\": {\n \"Type\": \"Iata\",\n \"Value\": \"PRG\"\n },\n \"SelectedDestination\": {\n \"Type\": \"Iata\",\n \"Value\": \"CDG\"\n },\n \"CanBeOriginDestinationReversed\": {\n \"Value\": \"true\"\n },\n \"BookingClasses\": {\n \"BookingClass\": []\n },\n \"CommissionRulePassengers\": {\n \"CommissionRulePassenger\": []\n },\n \"Commission\": {\n \"Type\": \"PercentBase\",\n \"Value\": \"2\"\n },\n \"SalesDateRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n },\n \"OriginTravelRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n },\n \"DestinationTravelRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n }\n}"}],"_postman_id":"85bc1f0b-393e-416b-930e-8d458a44a73c"},{"name":"Cancelling Commission rule","id":"81b4d9d0-658d-441d-8f3d-0026caa4a786","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{apiUrl}}/rules/v1/:pcc/:commissionRuleId","description":"

This method cancels the specified Commission rule.

\n","auth":{"type":"apikey","apikey":{"value":"{{authorizationToken}}","key":""},"isInherited":true,"source":{"_postman_id":"4df7caec-d9e3-4a8f-b806-0e10946b6dee","id":"4df7caec-d9e3-4a8f-b806-0e10946b6dee","name":"Commission Rules","type":"folder"}},"urlObject":{"path":["rules","v1",":pcc",":commissionRuleId"],"host":["{{apiUrl}}"],"query":[],"variable":[{"id":"4fe1a714-099a-46e8-ab9e-76659342879e","description":{"content":"

Agency's PCC.

\n","type":"text/plain"},"type":"string","value":"{{pcc}}","key":"pcc"},{"id":"383d7103-c43d-466f-9a28-d2846ea332d5","description":{"content":"

Commission rule id.

\n","type":"text/plain"},"type":"string","value":"{{commissionRuleId}}","key":"commissionRuleId"}]}},"response":[{"id":"ee2bb01f-7dfe-4cdd-9111-d4c1cf16766e","name":"Cancelling Commission rule","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{apiUrl}}/rules/v1/:pcc/:commissionRuleId","host":["{{apiUrl}}"],"path":["rules","v1",":pcc",":commissionRuleId"],"variable":[{"key":"pcc","value":"{{pcc}}","description":"Agency's PCC."},{"key":"commissionRuleId","value":"{{commissionRuleId}}","description":"Commission rule id."}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"CanceledCommissionRule\": {\n \"CommissionRuleId\": \"{{commissionRuleId}}\"\n }\n}"}],"_postman_id":"81b4d9d0-658d-441d-8f3d-0026caa4a786"},{"name":"Listing Commission rules","id":"14a05317-979b-40d8-9157-b8f6fc29a7c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{apiUrl}}/rules/v1/:pcc","description":"

This method returns defined Commission rules.

\n","auth":{"type":"apikey","apikey":{"value":"{{authorizationToken}}","key":""},"isInherited":true,"source":{"_postman_id":"4df7caec-d9e3-4a8f-b806-0e10946b6dee","id":"4df7caec-d9e3-4a8f-b806-0e10946b6dee","name":"Commission Rules","type":"folder"}},"urlObject":{"path":["rules","v1",":pcc"],"host":["{{apiUrl}}"],"query":[],"variable":[{"id":"dd9f534d-9cec-43ec-ad4d-f539b0b89781","description":{"content":"

Agency's PCC

\n","type":"text/plain"},"type":"string","value":"{{pcc}}","key":"pcc"}]}},"response":[{"id":"a6c1066a-8591-4830-8080-40e2fd7176a2","name":"Listing Commission rules","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorizationToken}}","type":"text","disabled":true}],"url":{"raw":"{{apiUrl}}/rules/v1/:pcc","host":["{{apiUrl}}"],"path":["rules","v1",":pcc"],"variable":[{"key":"pcc","value":"{{pcc}}","description":"Agency's PCC"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"CommissionRuleId\": \"1003\",\n \"CommissionRule\": {\n \"UseAsCommission\": \"Y\",\n \"UseAsDiscount\": \"N\",\n \"ValidatingAirline\": \"OK\",\n \"Priority\": \"3\",\n \"ApplicableForJourneys\": {\n \"OneWay\": \"true\",\n \"Return\": \"true\"\n },\n \"MarketingAirlineCombination\": {\n \"Type\": \"AnyCombination\"\n },\n \"OperatingAirlineCombination\": {\n \"OperatingAirline\": [],\n \"Type\": \"AnyCombination\"\n },\n \"SelectedOrigin\": {\n \"Type\": \"Iata\",\n \"Value\": \"PRG\"\n },\n \"SelectedDestination\": {\n \"Type\": \"Iata\",\n \"Value\": \"CDG\"\n },\n \"CanBeOriginDestinationReversed\": {\n \"Value\": \"true\"\n },\n \"BookingClasses\": {\n \"BookingClass\": []\n },\n \"CommissionRulePassengers\": {\n \"CommissionRulePassenger\": []\n },\n \"Commission\": {\n \"Type\": \"PercentBase\",\n \"Value\": \"1\"\n },\n \"SalesDateRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n },\n \"OriginTravelRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n },\n \"DestinationTravelRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n }\n }\n },\n {\n \"CommissionRuleId\": \"1016\",\n \"CommissionRule\": {\n \"UseAsCommission\": \"Y\",\n \"UseAsDiscount\": \"N\",\n \"ValidatingAirline\": \"BA\",\n \"Priority\": \"1\",\n \"ApplicableForJourneys\": {\n \"OneWay\": \"true\",\n \"Return\": \"true\"\n },\n \"MarketingAirlineCombination\": {\n \"Type\": \"AnyCombination\"\n },\n \"OperatingAirlineCombination\": {\n \"OperatingAirline\": [],\n \"Type\": \"AnyCombination\"\n },\n \"SelectedOrigin\": {\n \"Type\": \"Iata\",\n \"Value\": \"PRG\"\n },\n \"SelectedDestination\": {\n \"Type\": \"Iata\",\n \"Value\": \"EDI\"\n },\n \"CanBeOriginDestinationReversed\": {\n \"Value\": \"false\"\n },\n \"BookingClasses\": {\n \"BookingClass\": []\n },\n \"CommissionRulePassengers\": {\n \"CommissionRulePassenger\": []\n },\n \"Commission\": {\n \"Type\": \"Flat\",\n \"Value\": \"10\"\n },\n \"SalesDateRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n },\n \"OriginTravelRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n },\n \"DestinationTravelRange\": {\n \"DateFrom\": \"\",\n \"DateTo\": \"\"\n }\n }\n }\n]"}],"_postman_id":"14a05317-979b-40d8-9157-b8f6fc29a7c5"}],"id":"4df7caec-d9e3-4a8f-b806-0e10946b6dee","description":"

Commission Rules define what Commission should be used for given locator.

Commission Rule structure

{\n    \"ApplicableForJourneys\": {\n        \"OneWay\": \"false\",\n        \"Return\": \"true\"\n    },\n    \"ValidatingAirline\": \"<ValidatingAirlineCode>\",\n    \"Priority\": \"<Priority>\",\n    \"UseAsCommission\": \"Y\",\n    \"UseAsDiscount\": \"N\",\n    \"MarketingAirlineCombination\": {\n        \"Type\": \"<MarketingAirlineCombinationType>\"\n    },\n    \"OperatingAirlineCombination\": {\n        \"Type\": \"<OperatingAirlineCombinationType>\",\n        \"OperatingAirline\": [\n          {\n              \"Code\": \"<OperatingAirlineCode>\"\n          }\n        ]\n    },\n    \"SelectedOrigin\": {\n        \"Type\": \"Iata\",\n        \"Value\": \"NYC\"\n    },\n    \"SelectedDestination\": {\n        \"Type\": \"Country\",\n        \"Value\": \"AL\"\n    },\n    \"CanBeOriginDestinationReversed\": {\n        \"Value\": \"true\"\n    },\n    \"BookingClasses\": {\n        \"Mode\": \"<BookingClassMode>\",\n        \"BookingClass\": [\n            {\n                \"Code\": \"Y\"\n            },\n            {\n                \"Code\": \"S\"\n            },\n            {\n                \"Code\": \"R\"\n            }\n        ]\n    },  \n    \"CommissionRulePassengers\": {\n        \"Mode\": \"<BookingClassMode>\",\n        \"CommissionRulePassenger\": [\n            {\n                \"PassengerType\": \"ADT\"\n            },\n            {\n                \"PassengerType\": \"CNN\"\n            }\n        ]\n    },\n    \"Commission\": {\n        \"Type\": \"<CommissionType>\",\n        \"Value\": \"<CommissionValue>\"\n    },\n    \"SalesDateRange\": {\n        \"DateFrom\": \"2018-05-01\",\n        \"DateTo\": \"2018-05-31\"\n    },\n    \"OriginTravelRange\": {\n        \"DateFrom\": \"2018-07-01\",\n        \"DateTo\": \"2018-08-31\"\n    },\n    \"DestinationTravelRange\": {\n        \"DateFrom\": \"\",\n        \"DateFrom\": \"2018-12-31\"\n    }\n}\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Type	Description
ValidatingAirlineCode	String	Code of validating airline
Priority	Integer	Priority of a rule.
MarketingAirlineCombinationType	Enum	One of: AnyCombination, VariousAirlines, ValidatingAirlineOnly, ValidatingAirlineMissing
OperatingAirlineCombinationType	Enum	One of: AnyCombination, OperatedOnlyBySomeOfListed, OperatedByAllListed, NotOperatedByListed
OperatingAirlineCode	String	Code of operating airline
CommissionType	String	One of: Flat, PercentBase
CommissionValue	String	Integer or float as a string.

","auth":{"type":"apikey","apikey":{"value":"{{authorizationToken}}","key":""},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"4b0e760b-45f8-4a01-85bd-07dd3f631923","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"45034326-e394-45f0-ab48-92f6364189ae","type":"text/javascript","exec":[""]}}],"_postman_id":"4df7caec-d9e3-4a8f-b806-0e10946b6dee"}],"event":[{"listen":"prerequest","script":{"id":"b23dd4a1-ccb6-4380-b10e-18f54cfdc821","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fc49aa77-7f5f-4c5e-8607-da4ca803e512","type":"text/javascript","exec":[""]}}]}