Customer Portal Rates API

1. Introduction

The HORISEN Customer Portal Rates API Endpoint is to be used by SMS Platform Owners customers to get their price lists. The SMS Platform owner must set up an OAuth2 client type user to give access to the customer. Please contact HORISEN Support for further information.

This API belongs to the Bulk PriceList domain. Subject Domain in the endpoint url is:

https://api.horisen.pro/bulk/pricelists

The API uses the HORISEN implementation of the OAuth 2.0 protocol. For more information refer to the Oauth2 Authentication Guidelines

2. Method's Overview

Customers Portal endpoints.

GET/sms/portal/selling/pricelists
Returns a list of PriceLists belonging to the customer.Read More
GET/sms/portal/selling/{id}/rates-for-date
Returns a PriceList Range prices for specified date.Read More

3. Methods Details

GET/sms/portal/selling/pricelists
Returns a list of PriceLists belonging to the customer.Up

Method Overview

Returns a list of PriceLists belonging to the customer. This endpoint is used for API-to-API communication. Authorization privilege needed for this endpoint: bulk-cust-pricelist-own.view

URL Parameters

Name Type Description
page_size integer (query) Page size. Default value is 10
page_number integer (query) Page number. The default value is 1
paging string (query) Paging options. The format is: &paging=page_num,page_size e.g. paging=1,10

Success Response 200: List of Owner PriceLists

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "currencyId": 0,
      "currencyCode": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
      }
    }
  }
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string",
      "object": {}
    }
  ]
}
GET/sms/portal/selling/{id}/rates-for-date
Returns a PriceList Range prices for specified date.Up

Method Overview

Returns a PriceList Range prices for specified date. Authorization privilege needed for this endpoint: bulk-cust-pricelist-own.view

URL Parameters

Name Type Description
id (required) string (path) PriceList id to get range from
date string (query) Date to get price for, should be in format 2006-01-02T15:04:05Z
page_size integer (query) Page size. Default value is 10
page_number integer (query) Page number. The default value is 1
paging string (query) Paging options. The format is: &paging=page_num,page_size e.g. paging=1,10

Success Response 200: PriceListRates data

{
  "data": [
    {
      "countryName": "string",
      "operator": "string",
      "continent": "string",
      "mcc": "string",
      "mnc": "string",
      "operatorID": "string",
      "price": {
        "value": 0,
        "currency": 0,
        "currencyIso": "string"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
      }
    }
  }
}

Error Response Unexpected Error: Default

{
  "code": "string",
  "message": "string",
  "description": "string",
  "items": [
    {
      "name": "string",
      "message": "string",
      "description": "string",
      "object": {}
    }
  ]
}