Get Promos

  • GET /v1/publishers/me/promos

  • Publisher API Authentication required

  • Request: query parameter

    • siteId: current selected site id (required)
    • campaignId: choosen campaign id (optional)
    • type: type for search (optional)
      • ALL : All promos
      • CODES: Promos with code exists and is not empty
      • OTHERS: Promos with code does not exists or is empty
    • promoCategory: Category of promos (optional)
    • size: number of promos for each call API. (required)
    • startIndex: start index for each call API (required)

  • Response:

    • 200 OK on success

  • example individual account response:

[
    {
        "campaignId": 1,
        "imageUrl": "https://s3.images.url",
        "campaignName": "Agoda",
        "affiliateLink": "https://click.accesstrade.in.id?rk=0000010000a1",
        "categoryIds": [
            "CAT-0001",
            "CAT-0002"
        ],
        "title": "Agoda Promo Code - Book Up To 80% OFF",
        "description": "Far away, behind the word mountains, far from...",
        "code": "AI45IUY",
        "remainDays": 1,
        "periodDays": 2,
        "startDate": "2021-09-22T01:00:00.000Z",
        "endDate": "2021-09-22T05:00:00.000Z"
    },
    {
        "campaignId": 2,
        "imageUrl": "https://s3.images.url1",
        "campaignName": "Lazada",
        "affiliateLink": "https://click.accesstrade.in.id?rk=0000020000a1",
        "categoryIds": [
            "CAT-0002",
            "CAT-0004"
        ],
        "title": "Agoda Promo Code - Book Up To 30% OFF",
        "description": "Far away, behind the word mountains, far from...",
        "code": "",
        "remainDays": 1,
        "periodDays": 2,
        "startDate": "2021-09-22T01:00:00.000Z",
        "endDate": "2021-09-22T05:00:00.000Z"
    }
]

Get Promo Categories

  • GET /v1/publishers/me/promo-categories

  • V1 Request Signature needed

  • Request: query parameter

    • siteId: current selected site id (required)
    • campaignId: choosen campaign id (optional)
    • type: type for search (optional)
      • ALL : All promos
      • CODES: Promos with code exists and is not empty
      • OTHERS: Promos with code does not exists or is empty

  • Response:

    • 200 OK on success

  • example individual account response:

[
    {
        "categoryId": "All",
        "numberOfPromos": 20
    },
    {
        "categoryId": "CAT-0001",
        "numberOfPromos": 20
    },
    {
        "categoryId": "CAT-0002",
        "numberOfPromos": 30
    },
    {
        "categoryId": "CAT-0003",
        "numberOfPromos": 40
    },
    {
        "categoryId": "CAT-0004",
        "numberOfPromos": 50
    },
    {
        "categoryId": "CAT-0005",
        "numberOfPromos": 60
    },
    {
        "categoryId": "CAT-0006",
        "numberOfPromos": 70
    }
]