Offer & Promotions - os-salahuddin/php8-cluster GitHub Wiki

Promotions

Get promotional offer

This API provides TOP 5 latest active promotional offer

URL

[GET] http://127.0.0.1:8282/api/v1/private/promotional-offers/top-5

Sample Response

{
    "code": 200,
    "messages": [],
    "data": {
        "offers": [
            {
                "promotion_id": 58,
                "promotion_title": "Samsung Mobile",
                "link": "https://sharetrip.net/",
                "promotional_banner": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/marketing/promotional_offer/edjkDe6h7pT1btLcAqW852lQi1660018061.jpg",
                "promotion_details": "Buy Samsung mobile and pay using Deshi to get 20% discount"
            },
            {
                "promotion_id": 54,
                "promotion_title": "Bata Eid Offer",
                "link": "https://dev-marketing.deshipay.com/create-promotion",
                "promotional_banner": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/marketing/promotional_offer/IZtQq19gKtnrsX266I0VCsQgP1660017956.jpg",
                "promotion_details": "Get 60% off on Bata Shoes"
            },
            {
                "promotion_id": 49,
                "promotion_title": "Airtel",
                "link": "http://localhost:3000/create-promotion",
                "promotional_banner": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/marketing/promotional_offer/kKjzrpkMTDthoMeCMVA5wweS81660017990.jpg",
                "promotion_details": "Top up using Deshi get 20% extra"
            },
            {
                "promotion_id": 28,
                "promotion_title": "ShareTrip",
                "link": "https://www.sharetrip.net",
                "promotional_banner": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/marketing/promotional_offer/ys4IjZt48KA7ejHhAkSQj9UxM1638134356.png",
                "promotion_details": "ShareTrip"
            }
        ]
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages (empty if no messages) Yes
data.offers Array List of promotional offers Yes
data.offers[].promotion_id Int Unique ID of the promotion Yes
data.offers[].promotion_title String Title of the promotion Yes
data.offers[].link String URL link to the promotion Yes
data.offers[].promotional_banner String URL of the promotional banner image Yes
data.offers[].promotion_details String Description of the promotion Yes

Offer

Get all offer

This API provides all offer information

URL

[GET] http://127.0.0.1:8282/api/v1/private/offers/show-all

Sample Response

{
    "code": 200,
    "messages": [],
    "data": {
        "offers": [
            {
                "offer_id": 7,
                "offer_title": "North",
                "link": "https://www.linkedin.com/company/north-end-coffee",
                "offer_banner": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/marketing/offer/NbUTA8di5tJF6cVUMzKu6RKy81659981844.png",
                "offer_details": "Ger amazing offer at NorthEnd",
                "offer_brand_name": "End",
                "offer_brand_logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/marketing/offer/q0TBwHXbdYxq6q7upfUCXOXCq1659981843.jpg"
            },
            {
                "offer_id": 4,
                "offer_title": "Unlimited Chicken @ KFC",
                "link": "https://sharetrip.net/",
                "offer_banner": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/marketing/offer/keSui01JX3dM6KmgNHDz4a8im1660016938.jpg",
                "offer_details": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum",
                "offer_brand_name": "KFC",
                "offer_brand_logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/marketing/offer/1dIn4Y71ad9y1JpijMh5j68HL1660016938.jpg"
            },
            {
                "offer_id": 3,
                "offer_title": "20% Hot offer",
                "link": "https://www.batabd.com/",
                "offer_banner": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/marketing/offer/Pwxb7P04hPVuBR6sY1aGCDmUX1660016994.jpg",
                "offer_details": "Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of \"de Finibus Bonorum et Malorum\" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, \"Lorem ipsum dolor sit amet..\", comes from a line in section 1.10.32.",
                "offer_brand_name": "Bata",
                "offer_brand_logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/marketing/offer/hPJgndevyhSzYzhhh4cVLCz3E1658134841.jpg"
            }
        ]
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages (empty if no messages) Yes
data.offers Array List of promotional offers Yes
data.offers[].offer_id Int Unique ID of the offer Yes
data.offers[].offer_title String Title of the offer Yes
data.offers[].link String URL link to the offer Yes
data.offers[].offer_banner String URL of the offer banner image Yes
data.offers[].offer_details String Description of the offer Yes
data.offers[].offer_brand_name String Name of the offer's brand Yes
data.offers[].offer_brand_logo String URL of the brand logo Yes

Get Individual offer details

This API provides detail information for specific offer by offer id

URL

[GET] http://127.0.0.1:8282/api/v1/private/offer/7

Sample Response

{
    "code": 200,
    "messages": [],
    "data": {
        "offer": [
            {
                "offer_title": "North",
                "link": "https://www.linkedin.com/company/north-end-coffee",
                "offer_banner": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/marketing/offer/NbUTA8di5tJF6cVUMzKu6RKy81659981844.png",
                "offer_details": "Ger amazing offer at NorthEnd",
                "offer_brand_name": "End",
                "offer_brand_logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/marketing/offer/q0TBwHXbdYxq6q7upfUCXOXCq1659981843.jpg"
            }
        ]
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages (empty if no messages) Yes
data.offer Array List of promotional offers Yes
data.offer[].offer_title String Title of the offer Yes
data.offer[].link String URL link to the offer Yes
data.offer[].offer_banner String URL of the offer banner image Yes
data.offer[].offer_details String Description of the offer Yes
data.offer[].offer_brand_name String Name of the offer's brand Yes
data.offer[].offer_brand_logo String URL of the brand logo Yes

Get offer on limit

This API provides the offers on limit

URL

[GET] http://127.0.0.1:8282/api/v1/private/offers/on-limit

Sample Response

{
    "code": 200,
    "messages": [],
    "data": {
        "offers": [
            {
                "offer_id": 7,
                "offer_title": "North",
                "link": "https://www.linkedin.com/company/north-end-coffee",
                "offer_banner": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/marketing/offer/NbUTA8di5tJF6cVUMzKu6RKy81659981844.png",
                "offer_details": "Ger amazing offer at NorthEnd",
                "offer_brand_name": "End",
                "offer_brand_logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/marketing/offer/q0TBwHXbdYxq6q7upfUCXOXCq1659981843.jpg"
            },
            {
                "offer_id": 4,
                "offer_title": "Unlimited Chicken @ KFC",
                "link": "https://sharetrip.net/",
                "offer_banner": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/marketing/offer/keSui01JX3dM6KmgNHDz4a8im1660016938.jpg",
                "offer_details": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum",
                "offer_brand_name": "KFC",
                "offer_brand_logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/marketing/offer/1dIn4Y71ad9y1JpijMh5j68HL1660016938.jpg"
            },
            {
                "offer_id": 3,
                "offer_title": "20% Hot offer",
                "link": "https://www.batabd.com/",
                "offer_banner": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/marketing/offer/Pwxb7P04hPVuBR6sY1aGCDmUX1660016994.jpg",
                "offer_details": "Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of \"de Finibus Bonorum et Malorum\" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, \"Lorem ipsum dolor sit amet..\", comes from a line in section 1.10.32.",
                "offer_brand_name": "Bata",
                "offer_brand_logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/marketing/offer/hPJgndevyhSzYzhhh4cVLCz3E1658134841.jpg"
            }
        ]
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages (empty if no messages) Yes
data.offers Array List of promotional offers Yes
data.offers[].offer_id Int Unique ID of the offer Yes
data.offers[].offer_title String Title of the offer Yes
data.offers[].link String URL link to the offer Yes
data.offers[].offer_banner String URL of the offer banner image Yes
data.offers[].offer_details String Description of the offer Yes
data.offers[].offer_brand_name String Name of the offer's brand Yes
data.offers[].offer_brand_logo String URL of the brand logo Yes