Once a service has been set up, it can be published to a particular market in order to be available to brokers. Services can be published to:
- All brokers
- To specific regions
- To specific countries
- To the sellers brokers
- To specific brokers
If publishing a service to a specific region or country an additional API call will have to be done to get a list of regions or countries.
API Details
| SellerServicePublish | |||
| Operation | Swagger Description | Method | API |
| Publish a service | Publishes service | PUT | /api/sellers/{sellerId}/services/{id}/publish |
| Other | |||
| Get Market Regions | Retrieve market regions | GET | /api/services/marketRegions |
| Get Market Countries | Retrieve market countries | GET | /api/services/marketCountries |
API Calls
Get Market Regions
| Get back a list of market regions | |
|---|---|
| End Point | /api/services/marketRegions |
| HTTP Method | GET |
| Request Body | N/A |
| Successful Example Response | 200[ { "marketRegionId": 3, "name": "Africa" }, { "marketRegionId": 2, "name": "Asia" }, { "marketRegionId": 8, "name": "CentralAmerica" }, { "marketRegionId": 9, "name": "EasternEurope" }, { "marketRegionId": 1, "name": "Europe" }, { "marketRegionId": 10, "name": "MiddleEast" }, { "marketRegionId": 5, "name": "NorthAmerica" }, { "marketRegionId": 4, "name": "Oceania" }, { "marketRegionId": 6, "name": "SouthAmerica" }, { "marketRegionId": 7, "name": "TheCaribbean" } ] |
Get Market Countries
| Get back a list of market countries | |
|---|---|
| End Point | /api/services/marketCountries |
| HTTP Method | GET |
| Request Body | N/A |
| Successful Example Response | 200[ { "countryId": 16, "name": "Afghanistan" }, { "countryId": 17, "name": "Albania" }, { "countryId": 18, "name": "Algeria" }, { "countryId": 19, "name": "Andorra" }, { "countryId": 20, "name": "Angola" } ] |
Publish a Service
| Publishes a service in the broker marketplace. | |
|---|---|
| End Point | /api/sellers/{sellerId}/services/{id}/publish |
| HTTP Method | PUT |
| Request Body | { "market": "SpecificBrokers", "specificBrokers": [ "9230183c-6aeb-412f-9c7b-5a94d3cf82dc", "600348ae-6fd2-4c0e-8c85-9e88b30fe321" ], "customPropertiesData": [ { "id": "account_id", "value": "123456" }, { "id": "adminFirstName", "value": "John" }, { "id": "adminLastName", "value": "Doe" }, { "id": "domain", "value": "testdomain123.com" } ] } |
| Successful Example Response | 201 |
| Error Example Response | 400{ "errorCode": 10, "errorName": "BusinessRule", "errorMessage": "Not allowed. Service has active approval request." } |
Field Definitions
| Field | Descriptions |
| market | Draft – The service is not yet published and not visible in the Marketplace Once the service is published to Global/Region/Country/My Brokers, this option becomes Disabled Global – Service is published and allowed for all brokers Region – Service is published only to brokers from specific regions (restriction not applied to broker’s organizations) Country – Service is published only to brokers from specific countries (restriction not applied to broker’s organizations) Specific Brokers – Service is published only to selected brokers (from the seller’s list of brokers) The difference between Specific limited brokers and My Brokers: My Brokers is a group of all the limited brokers. This includes new limited brokers who are added after publishing the service. Specific brokers are only the specific selected brokers. Even if “All” Specific brokers is selected, the service won’t be available to limited brokers who are added after publishing the service. My Brokers – Service is published only to brokers under the seller. When new brokers are added, they’d automatically see this service as well |
| marketRegions | Valid inputs can be retrieved from /api/services/marketRegions |
| marketCountries | Valid inputs can be retrieved from /api/services/marketCountries |
| specificBrokers | A selection of brokers to publish the service to |
| customPropertiesData | Custom Properties |