Merchant

Get Merchant Store

GET /v1/merchant/stores/{broker_channel_id}

URL Parameters
ParameterDescription
broker_channel_idThe ID of broker channel to retrieve the store from
Response

The above request returns JSON structured like this:

ParameterDescription
broker_channel_idThe ID of the broker channel
logo_urlThe public logo url for the broker channel
broker_productsThe list of broker products available
broker_products.nameThe broker product exclusive name
broker_products.productThe insurer product information itself
broker_products.product.typeThe insurer product type
broker_products.product.insurerThe insurer information itself
The insurer product type can be:
TypeName
1Auto
2Business
3Educational
4Home
5Life
6Funeral
7Moneylender
8Electronic
9Global
10Warranty
11PersonalAccident
12Travel
{
  "broker_channel_id": "string",
  "logo_url": "string",
  "broker_products": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "product_id": "string",
      "product": {
        "id": "string",
        "name": "string",
        "currency": "string",
        "description": "string",
        "susep": "string",
        "type": 0,
        "insurer_id": "string",
        "insurer": {
          "cnpj": "string",
          "id": "string",
          "name": "string"
        }
      }
    }
  ]
}

Get Merchant Vendor

GET /v1/merchant/vendor/{product_id}

URL Parameters
ParameterDescription
product_idThe ID of product to retrieve the vendor from
Response

The above request returns JSON structured like this:

ParameterDescription
idThe ID of the vendor itself
product_idThe ID of the product
activeThe flag that marks if the current vendor/product is available
agency_percentThe agency percent for this product
commission_percentThe commission percent for this product
pro_labor_percentThe pro labor percent for this product
last_updateThe last update of the vendor
dateThe date when the vendor was created
{
  "id": "string",
  "product_id": "string",
  "active": true,
  "agency_percent": 0.0,
  "commission_percent": 0.0,
  "pro_labor_percent": 0.0,
  "last_update": "string",
  "date": "string"
}