API : Product List

This request will return the list of products.

The platform works with 3 levels of products:

• Master products - These are ADMIN defined base products that defines all the details of a product. A master product cannot be assigned to a customer but must be inherited by a reseller product. A master product can be inherited multiple times.
• Reseller products - A product that is inherited from a master product and on which the reseller can control the name, product code, price and if the product may only be applied by the reseller or also the customer.
• Customer products - A product that is inherited from a reseller product and on which the reseller can control the price. The customer product allows resellers to customize prices for individual customers.

Depending on access level, the user will have access to different product sets:

• MANAGER & OWNER - will always see the products of their parent reseller that can be used, but not those that can only be applied by the reseller
• RESELLER - will by default see her own products that can be used, but can use the master flag to instead see master product that she can use to create new products from
• ADMIN - Can see all, but default to own products similar to the reseller

Products have a common set of properties, and in addition some have their own specific properties according to the type of product:

https://api.telecomx.dk/product
https://api.telecomx.dk/product?type=SIP_RATEPLAN
https://api.telecomx.dk/product?type=SIP_RATEPLAN&filter=Premium
https://api.telecomx.dk/product?type=DSL&filter=100M&all=true&offset=10&limit=25&full=true

Note that properties holding no value may be omitted from the object.

{
  offset: 100,
  limit: 50,
  total: 999,
  products:
  [
    {
      _id: '123457890ABCDEF12345678',
      type: 'SIP_RATEPLAN',
      productCode: 'SR0123A',
      name: 'SIP account, flatrate DK',
      wholesale: 180.00,
      price: 250.00
    },
    {
      ...
    }
  ]
}

{
  offset: 0,
  limit: 100,
  total: 10000,
  products:
  [
    {
      _id: '1234567890ABCDEF12345678',
      start: '2014-01-01T00:00:00.000Z',
      end: null,
      type: 'SIP_RATEPLAN',
      productCode: 'SR0123A',
      name: 'SIP account, flatrate DK',
      unitType: 'MONTHS',
      recurrence: 'MONTHLY'
      recurrenceFullMonth: true,
      cost: 150.00,
      wholesale: 180.00,
      price: 250.00,
      reseller: '1234567890ABCDEF12345678',
      inheritFrom: '1234567890ABCDEF1234578',
      inheritBy: null,
      applyByResellerOnly: false,
      subscription: {
        minutes: {
          homeland: 1800,
          euNordic: 0,
          restOfEurope: 0,
          world1: 0,
          world2: 0,
          world3: 0
        },
        free: {
          ownSip: true,
          ownMvno: false,
          onNetSip: false,
          onNetMvno: false
        }
      },
      ratePercentDiscount: null,
      override: {
        connectionFee: 0.00,
        override.connectionFeeOnCallAttempt: true
      },
      destinations: {
        DK: {
          fixed: {
            wholesaleFee: 0.10,
            customerFee: 0.20,
            wholesaleRate: 0.07,
            customerRate: 0.10
          },
          mobile: {
            customerRate: 0.79
          }
        }
      },
      numberRent: {
        wholesaleFirst: 25.00,
        wholesaleExtra: 5.00,
        wholesale100: 300.00,
        customerFirst: 25.00,
        customerExtra: 5.00,
        customer100: 300.00
      }
    },
    {
      ...
    }
  ]
}

{
  offset: 0,
  limit: 100,
  total: 10000,
  products:
  [
    {
      _id: '1234567890ABCDEF12345678',
      start: '2014-01-01T00:00:00.000Z',
      end: null,
      type: 'MVNO_RATEPLAN',
      productCode: 'MRFREE25G',
      name: 'Free voice, SMS, MMS, 25GB data & 5 hours EU',
      unitType: 'MONTHS',
      recurrence: 'MONTHLY'
      recurrenceFullMonth: true,
      cost: 150.00,
      wholesale: 180.00,
      price: 250.00,
      reseller: '1234567890ABCDEF12345678',
      inheritFrom: '1234567890ABCDEF1234578',
      inheritBy: null,
      applyByResellerOnly: false,
      pbxProduct: false,
      dataSharingSimsIncluded: 0,
      smartWatchIncluded: false,
      socFeatures: {
        tdc: {
          broadband: false,
          international: true,
          data: true,
          fiveG: true,
          publicIP: true,
          chargedServices: false,
          secretNumber: true,
          roaming: true,
          roamingData: true,
          satellite: false,
          restOfWorldRoamingSoc: '1234BDF',
          restOfWorldRoamingSocType: 'AUTOSTART',
        },
        telenor: {
          broadband: false,
          international: true,
          data: true,
          fiveG: true,
          publicIP: true,
          chargedServices: false,
          secretNumber: true,
          roaming: true,
          roamingData: true,
          satellite: false
        }
      },
      network: 'TELENOR',
      subscription: {
        minutes: {
          homeland: 44640,
          euNordic: 0,
          restOfEurope: 0,
          world1: 0,
          world2: 0,
          world3: 0
        },
        free: {
          ownSip: true,
          ownMvno: true,
          onNetSip: false,
          onNetMvno: false,
          smsMms: true
        },
        roaming: [
         {
          _id: '1234567890ABCD1234567890',
          minutes: 3000
         },
         ...
        ],
        data: 25600,
        dataEu: 8192
      },
      sms: {
        nationalCost: 0.10,
        nationalWholesale: 0.15,
        nationalPrice: 0.20,
        internationalCost: 0.50,
        internationalWholesale: 1.00,
        internationalPrice: 1.50
      },
      mms: {
        nationalCost: 0.50,
        nationalWholesale: 0.75,
        nationalPrice: 1.00,
        internationalCost: 2.50,
        internationalWholesale: 4.00,
        internationalPrice: 5.00
      },
      data: {
        nationalCost: 0.50,
        nationalWholesale: 1.00,
        nationalPrice: 1.50
      },
      destinations: {
        DK: {
          fixed: {
            wholesaleFee: 0.10,
            customerFee: 0.20,
            wholesaleRate: 0.07,
            customerRate: 0.10
          },
          mobile: {
            customerRate: 0.79
          }
        }
      }
    },
    {
      ...
    }
  ]
}

{
  offset: 0,
  limit: 100,
  total: 10000,
  products:
  [
    {
      _id: '1234567890ABCDEF12345678',
      start: '2014-01-01T00:00:00.000Z',
      end: null,
      type: 'DSL',
      productCode: 'DSL5/5F',
      name: 'ADSL 5/5Mbit flex',
      unitType: 'MONTHS',
      recurrence: 'MONTHLY'
      recurrenceFullMonth: true,
      cost: 150.00,
      wholesale: 180.00,
      price: 250.00,
      reseller: '1234567890ABCDEF12345678',
      inheritFrom: '1234567890ABCDEF1234578',
      inheritBy: null,
      applyByResellerOnly: false,
      dslSpeed: '5120/5120FL'
    },
    {
      ...
    }
  ]
}

{
  offset: 0,
  limit: 100,
  total: 10000,
  products:
  [
    {
      _id: '1234567890ABCDEF12345678',
      start: '2014-01-01T00:00:00.000Z',
      end: null,
      type: 'FIBER',
      productCode: 'F2432',
      name: 'Redundant cityring fiber',
      unitType: 'MONTHS',
      recurrence: 'MONTHLY'
      recurrenceFullMonth: true,
      cost: 1500.00,
      wholesale: 1800.00,
      price: 2500.00,
      reseller: '1234567890ABCDEF12345678',
      inheritFrom: '1234567890ABCDEF1234578',
      inheritBy: null,
      applyByResellerOnly: false
    },
    {
      ...
    }
  ]
}

{
  offset: 0,
  limit: 100,
  total: 10000,
  products:
  [
    {
      _id: '1234567890ABCDEF12345678',
      start: '2014-01-01T00:00:00.000Z',
      end: null,
      type: 'NUMBER_RENT',
      productCode: 'NUM01',
      name: 'Number rent',
      unitType: 'MONTH',
      recurrence: 'QUARTERLY'
      cost: 0.00,
      costExtra: 0.00,
      cost100: 0.00,
      wholesale: 20.00,
      wholesaleExtra: 2.50,
      wholesale100: 350.00,
      price: 25.00,
      priceExtra: 5.00,
      price100: 500.00,
      reseller: '1234567890ABCDEF12345678',
      inheritFrom: '1234567890ABCDEF1234578',
      inheritBy: null,
      applyByResellerOnly: false
    },
    {
      ...
    }
  ]
}

{
  offset: 0,
  limit: 100,
  total: 10000,
  products:
  [
    {
      _id: '1234567890ABCDEF12345678',
      start: '2014-01-01T00:00:00.000Z',
      end: null,
      type: 'PBX_USER',
      productCode: '18233',
      name: 'User license',
      unitType: 'UNITS',
      recurrence: 'NONE'
      cost: 100.00,
      wholesale: 120.00,
      price: 150.00,
      reseller: '1234567890ABCDEF12345678',
      inheritFrom: '1234567890ABCDEF1234578',
      inheritBy: null,
      applyByResellerOnly: false,
      includedProducts: [],
      communicatorAccess: true
    },
    {
      ...
    }
  ]
}
 
==== Full, type MVNO_DATA_TOP_UP ====
<code javascript>
{
  offset: 0,
  limit: 100,
  total: 10000,
  products:
  [
    {
      _id: '1234567890ABCDEF12345678',
      start: '2014-01-01T00:00:00.000Z',
      end: null,
      type: 'MVNO_DATA_TOP_UP',
      productCode: 'DATA_5GB',
      name: '5Gb Data Top-up',
      unitType: 'UNITS',
      recurrence: 'NONE'
      cost: 65.00,
      wholesale: 85.00,
      price: 120.00,
      reseller: '1234567890ABCDEF12345678',
      inheritFrom: '1234567890ABCDEF1234578',
      inheritBy: null,
      applyByResellerOnly: false,
      mvnoTopUp: {
        data: 504800
      }
    },
    {
      ...
    }
  ]
}
 
===== Full, type MVNO_ROW_ROAMING =====
 
<code javascript>
{
  _id: ObjectID('1234567890ABCDEF102345678'),
  start: ISODate('2014-01-01T12:34:56.123Z'),
  end: null,
  type: 'MVNO_DATA_TOP_UP',
  productCode: 'MVNO_DATA_TOP_UP_5GB',
  name: 'Data top-up pakke: 5 Gb',
  unitType: 'UNITS',
  recurrence: 'NONE',
  recurrenceFullMonth: false,
  cost: 0.00,
  wholesale: 20.00,
  price: 25.00,
  reseller: '4234567890ABCDEF102345678',
  inheritFrom: '6534567890ABCDEF102345672',
  inheritFromReseller: '1364567890ABCDEF102345672',
  applyByResellerOnly: false,
  soc: 'ABCDE18GJH'
}

{
  offset: 0,
  limit: 100,
  total: 10000,
  products:
  [
    {
      _id: '1234567890ABCDEF12345678',
      start: '2014-01-01T00:00:00.000Z',
      end: null,
      type: 'OTHER',
      productCode: 'NUMSER',
      name: 'Number series, 10 premium numbers',
      unitType: 'UNITS',
      recurrence: 'NONE'
      cost: 1000.00,
      wholesale: 1200.00,
      price: 1400.00,
      reseller: '1234567890ABCDEF12345678',
      inheritFrom: '1234567890ABCDEF1234578',
      inheritBy: null,
      applyByResellerOnly: false
    },
    {
      ...
    }
  ]
}