Read Campaign

About

• Reads campaign data
• Filter and list campaign's products
• Filter and list all other available products
• Attention! A maximum of 10 products per products category are returned

Class

celmarket\Campaigns\CampaignsInfo

Method

readCampaign

API

• method: campaign
• action: readCampaign

Parameters

• numecampanie = campaign's name
• products = campaign's products -> array
  • start = start position
  • limit = maximum number of returned products
  • search = search field -> array
    • byName = search by name
• avialableProducts = available products -> array
  • start = start position
  • limit = maximum number of returned products
  • search = search field -> array
    • byName = search by name

Response

An object with the following attributes

• campaign = campaign data -> array
  • found = 1 -> found, 0 -> not found
  • data = campaign's data -> array
    • numecampanie = campaign's name
    • reducere = valoarea reducerii
    • data creare = campaing's creation date
    • datastart = start date
    • dataend = end date
    • id_campanie = campaign's ID
• products = campaign's products
  • limit = maximum number of returned products
  • start = returned list's start position
  • moreavailable = 1 -> there are more products that haven't been returned, 0 -> there are no more products to be returned
  • data = products' data -> array
    • (array element) = product's data -> object
      • id_furnizor = supplier's / affiliate's id (the API user)
      • pretf = supplier's price
      • moneda = currency's name
        • USD = USA Dollar
        • EUR = Euro
        • RON = Romanian Leu
        • lei = Romanian Leu
      • pretlei = Lei (RON | ROL) price including VAT
      • adaos = added value
      • products_model = product's model
      • principal = 1 -> is principal, 0 -> is not principal
      • bonus = bonus products -> array
        • (array element) = bonus product -> object
          • products_name = product's name
          • products_model = product's model
      • stoc = stock value
      • cand = add date
      • pret_vechi = former price
      • id_campanie = the id of the product's campaign
      • pret_promo = promotional price computed using the Lei price and discount
      • start = start
      • end = end
      • procesare_in = processing
      • comType = type
      • status = status
      • pret_promo = product's promotional price
      • products_name = product's name
      • products_status = product's status
      • manufacturers_name = manufacturer's name
      • stoc = limited stock
        • null = infinity
  • count = the number of total products that correspond to the filter rules
• availableProducts = available products (other than those listed in the campaign)
  • limit = maximum number of returned products
  • start = returned list's start position
  • moreavailable = 1 -> there are more products that haven't been returned, 0 -> there are no more products to be returned
  • data = products' data -> array
    • (array element) = product's data -> object
      • id_furnizor = supplier's / affiliate's id (the API user)
      • pretf = supplier's price
      • moneda = currency's name
        • USD = USA Dollar
        • EUR = Euro
        • RON = Romanian Leu
        • lei = Romanian Leu
      • pretlei = Lei (RON | ROL) price including VAT
      • adaos = added value
      • products_model = product's model
      • principal = 1 -> is principal, 0 -> is not principal
      • bonus = bonus value
      • stoc = stock value
      • cand = add date
      • pret_vechi = former price
      • id_campanie = the id of the product's campaign
      • pret_promo = promotional price computed using the Lei price and discount
      • start = start
      • end = end
      • procesare_in = processing
      • comType = type
      • status = status
      • pret_promo = product's promotional price
      • products_name = product's name
      • products_status = product's status
      • manufacturers_name = manufacturer's name
  • count = the number of total products that correspond to the filter rules

Example - PHP

https://github.com/celdotro/marketplace_examples/blob/master/Campaigns/3.readCampaign.php

Example - JSON

{
  "request": {
    "numecampanie": "X",
    "products":{
      "start": 0,
      "limit": 1,
      "search":{
      "byName": "X"
      }
    },
    "availableProducts": {
      "start": 0,
      "limit": 1,
      "search":{
        "byName": "X"
      }
    }
  },
  
  "response": {
    "campaign": {
      "found": 0,
      "data": {
        "numecampanie": "X",
        "reducere": "X",
        "datacreare": "01-01-2018",
        "datastart": "01-01-2018",
        "dataend": "01-01-2018"    
      }
    },
    "products": {
      "limit": 1,
      "start": 0,
      "moreavailable": 0,
      "data": [
        {
          "id_furnizor": 1,
          "pretf": 1,
          "moneda": "X",
          "pretlei": 1,
          "adaos": 1,
          "products_model": "X",
          "principal": 0,
          "bonus":[
            {
              "products_name": "X",
              "products_model": "X"
            }
          ],
          "stoc": 0,
          "cand": "01-01-2018",
          "pret_vechi": 1,
          "id_campanie": 1,
          "pret_promo": 1,
          "start": "01-01-2018",
          "end": "01-01-2018",
          "procesare_in": "X",
          "comType": "X",
          "status": 0,
          "pret_promo": 1,
          "products_name": "X",
          "manufacturers_name": "X"
        }
      ],
      "count": 1
    },
    "availableProducts":{
      "limit": 1,
            "start": 0,
            "moreavailable": 0,
            "data": [
              {
                "id_furnizor": 1,
                "pretf": 1,
                "moneda": "X",
                "pretlei": 1,
                "adaos": 1,
                "products_model": "X",
                "principal": 0,
                "bonus":[
                  {
                    "products_name": "X",
                    "products_model": "X"
                  }
                ],
                "stoc": 0,
                "cand": "01-01-2018",
                "pret_vechi": 1,
                "id_campanie": 1,
                "pret_promo": 1,
                "start": "01-01-2018",
                "end": "01-01-2018",
                "procesare_in": "X",
                "comType": "X",
                "status": 0,
                "pret_promo": 1,
                "products_name": "X",
                "manufacturers_name": "X"
              }
            ],
            "count": 1
    }
  }
}