# Evaly Core Campaign module v2 Admin and Public API documentation
```
CoreBaseURL = https://api-beta.evaly.com.bd/core
```
## API endpoints
### Public v2 Campaign List
**Headers**: application/json; Bearer <Token>
**Requested URL**: {CoreBaseURL}/v2/campaigns
**Request Method**: GET
**Request Body**: N/A
**Response Body**:
```jsonld=1
{
"success": true,
"message": "campaigns fetched successfully",
"data": [
{
"name": "Heaven of Flower",
"slug": "heaven-of-flower-670fd9",
"image": "https://s3-ap-southeast-1.amazonaws.com/media.evaly.com.bd/media/images/119fb01a0ff2-newfile.jpeg",
"category_name": "cyclone",
"category_slug": "cyclone-2cf92f3a",
"start_date": "2021-07-26T18:00:00Z",
"end_date": "2021-08-31T18:00:00Z",
"promotion_start_date": "2021-07-25T18:00:00Z",
"promotion_end_date": "2021-07-26T18:00:00Z",
"cashback_date": null,
"cashback_type": "instant",
"cashback_percentage": "10.00",
"cashback_destination": "balance",
"modified_at": "2021-07-26T12:04:52.942739Z",
"modified_by": "Rafiya Tabassum",
"campaign_status": "live"
},
... .... .....
]
}
```
### Public v2 Campaign Product Category List
**Headers**: application/json; Bearer <Token>
**Requested URL**: {CoreBaseURL}v2/campaigns/products/categories
**Request Method**: GET
**Request Body**: N/A
**Response Body**:
```jsonld=1
{
"success": true,
"message": "categories fetched successfully",
"data": [
[
{
"name": "variant 2 - not root",
"slug": "variant-2-not-root-ffcf2863d"
},
{
"name": "variant 2 - not root",
"slug": "variant-2-not-root-ffcf2863d"
},
{
"name": "variant 2 - not root",
"slug": "variant-2-not-root-ffcf2863d"
}
],
143
]
}
```
### Public v2 Campaign DETAILS
**Headers**: application/json; Bearer <Token>
**Requested URL**: {CoreBaseURL}/v2/campaigns/heaven-of-flower-670fd9
**Request Method**: GET
**Request Body**: N/A
**Response Body**:
```jsonld=1
{
"success": true,
"message": "campaign details fetched successfully",
"data": {
"id": 238,
"name": "Heaven of Flower",
"slug": "heaven-of-flower-670fd9",
"image": "https://s3-ap-southeast-1.amazonaws.com/media.evaly.com.bd/media/images/119fb01a0ff2-newfile.jpeg",
"banner_image": "https://s3-ap-southeast-1.amazonaws.com/media.evaly.com.bd/media/images/6e3ecbd4d0f3-download-3.jpg",
"description": null,
"start_date": "2021-07-26T18:00:00Z",
"end_date": "2021-08-31T18:00:00Z",
"promotion_start_date": "2021-07-25T18:00:00Z",
"promotion_end_date": "2021-07-26T18:00:00Z",
"created_at": "2021-07-26T12:04:52.942704Z",
"created_by": {
"first_name": "Rafiya",
"last_name": "Tabassum",
"username": "rafia"
},
"modified_at": "2021-07-26T12:04:52.942739Z",
"modified_by": {
"first_name": "Rafiya",
"last_name": "Tabassum",
"username": "rafia"
},
"cashback_destination": "balance",
"cashback_percentage": "10.00",
"cashback_on_payment_by": "bkash",
"cashback_type": "instant",
"cashback_date": null,
"cashback_backoff_period": null,
"allowed_payment_methods": "bkash",
"category": {
"name": "cyclone",
"slug": "cyclone-2cf92f3a",
"banner_image": "https://s3-ap-southeast-1.amazonaws.com/media.evaly.com.bd/media/images/91aea95a218b-2021-05-20-14-40-dev-ehealth-merchant-webevalycombd.png",
"image": "https://s3-ap-southeast-1.amazonaws.com/media.evaly.com.bd/media/images/252fa4dd7683-newfile.jpeg",
"description": null,
"banner_primary_bg_color": "#GGGGF",
"banner_secondary_bg_color": "#GGGGF",
"banner_header_text": "header",
"banner_header_text_color": "#d00000",
"banner_sub_text": "dfkjgd",
"banner_sub_text_color": "#12130f",
"status": "active",
"modified_at": "2021-06-09T08:26:48.446248Z",
"modified_by": {
"first_name": "Ishak",
"last_name": "Ahammed",
"username": "ishak"
},
"created_at": "2021-06-09T08:26:48.446209Z",
"created_by": {
"first_name": "Ishak",
"last_name": "Ahammed",
"username": "ishak"
},
"score": 4536
},
"score": 200,
"purchase_score_enabled": true,
"purchase_score_type": "range",
"purchase_score_terms": "{\"ranges\":[{\"start\":\"500\",\"end\":\"1000\",\"value\":\"100\"},{\"start\":\"1001\",\"end\":\"1500\",\"value\":\"200\"}]}",
"min_order_quantity": 10,
"min_order_amount": "100.00",
"max_order_quantity": 500,
"max_order_amount": "10000.00",
"edit_before": "10:00:00",
"campaign_status": "live"
}
}
```
### Public v2 Campaign Shop List
**Headers**: application/json; Bearer <Token>
**Requested URL**: {CoreBaseURL}/v2/campaigns/heaven-of-flower-670fd9/shops?page=1&limit=5
**Request Method**: GET
**Request Body**: N/A
**Response Body**:
```jsonld=1
{
"success": true,
"message": "shop items fetched successfully",
"count": 0,
"data": [],
"meta": {
"campaign_banner": "https://s3-ap-southeast-1.amazonaws.com/media.evaly.com.bd/media/images/6e3ecbd4d0f3-download-3.jpg",
"campaign_title": "Heaven of Flower",
"campaign_start_date": "2021-07-26T18:00:00Z",
"campaign_end_date": "2021-08-31T18:00:00Z"
}
}
```
### Public v2 Campaign Shop wise Category List
**Headers**: application/json; Bearer <Token>
**Requested URL**: {CoreBaseURL}/v2/campaigns/heaven-of-flower-670fd9/shops/test-shop/categories?page=1&limit=10
**Request Method**: GET
**Request Body**: N/A
**Response Body**:
```jsonld=1
{
"success": true,
"message": "shop categories fetched successfully",
"count": 0,
"data": []
}
```
### Public v2 Campaign Shop Item List
**Headers**: application/json; Bearer <Token>
**Requested URL**: {CoreBaseURL}/v2/campaigns/<campaign-slug>/shops/<shop-slug>/items?page=1&limit=3
**Request Method**: GET
**Request Body**: N/A
**Response Body**:
```jsonld=1
{
"success": true,
"message": "shops items fetched successfully",
"count": 3,
"data": {
"shop": {
"id": 1106,
"name": "Mango shop for Mango Campaign",
"owner_name": "01906618273",
"slug": "mango-shop-for-mango-campaign-1aca6a0b",
"approved": true,
"shop_delivery_options": [],
"longitude": "90.39696752625562226",
"latitude": "23.77596873013334289",
"contact_number": "01923863534",
"status": "active",
"image": "https://df17fp68uwcso.cloudfront.net/eyJidWNrZXQiOiAibWVkaWEuZXZhbHkuY29tLmJkIiwgImtleSI6ICJtZWRpYS9pbWFnZXMvN2MzMDgxOGE5MTQyLW1hbmdvLWRlc3NlcnRfNjI1eDM1MF80MTQyNjI0NTc0NS53ZWJwIiwgImVkaXRzIjogeyJyZXNpemUiOiB7IndpZHRoIjogOTAwLCAiaGVpZ2h0IjogMzUwLCAiZml0IjogImZpbGwifSwgImpwZWciOiB7InF1YWxpdHkiOiA3NX19fQ==",
"logo_image": "https://s3-ap-southeast-1.amazonaws.com/media.evaly.com.bd/media/images/2caf8689d1a1-newfile.jpeg",
"address": "88 Arjotpara Rd, Dhaka 1215, Bangladesh",
"description": null,
"shop_score": 0,
"subscriber_count": 0,
"is_express_shop": false,
"is_cod_allowed": false,
"is_delivery_hero_allowed": false,
"campaign": {
"name": "Mango Campaign",
"slug": "mango-campaign-48e769",
"image": "https://s3-ap-southeast-1.amazonaws.com/media.evaly.com.bd/media/images/2ead09c91a30-newfile.jpeg",
"category_name": "All about Mango",
"category_slug": "all-about-mango-2cc2037c",
"start_date": "2021-07-26T18:00:00Z",
"end_date": "2021-08-30T18:00:00Z",
"promotion_start_date": "2021-07-23T18:00:00Z",
"promotion_end_date": "2021-07-26T18:00:00Z",
"cashback_date": "2021-10-30T18:00:00Z",
"cashback_type": "scheduled",
"cashback_percentage": "75.00",
"cashback_destination": "balance",
"modified_at": "2021-07-28T08:07:20.745520Z",
"modified_by": "Ishak Ahammed",
"campaign_status": "live"
}
},
"groups": [],
"subscribed": false,
"subscriber_count": 0,
"items": [
{
"shop_item_slug": "mango-pudding-f4641c316",
"item_name": "mango pudding",
"shop_slug": "mango-shop-for-mango-campaign-1aca6a0b",
"in_stock": 1,
"item_price": 2000,
"discounted_price": 1600,
"item_images": [
"https://df17fp68uwcso.cloudfront.net/eyJidWNrZXQiOiAibWVkaWEuZXZhbHkuY29tLmJkIiwgImtleSI6ICJtZWRpYS9pbWFnZXMvZmEzY2RmNWJiODRmLW1hbmdvLXB1ZGRpbmctcmVjaXBlLTEuanBnIiwgImVkaXRzIjogeyJyZXNpemUiOiB7IndpZHRoIjogMzUwLCAiaGVpZ2h0IjogMzUwLCAiZml0IjogImNvbnRhaW4ifSwgImJhY2tncm91bmQiOiB7InIiOiAyNTUsICJnIjogMjU1LCAiYiI6IDI1NSwgImFscGhhIjogMX0sICJmbGF0dGVuIjogdHJ1ZSwgImpwZWciOiB7InF1YWxpdHkiOiA3NX19fQ=="
]
},
{
"shop_item_slug": "mango-curd-eb454172e",
"item_name": "Mango Curd",
"shop_slug": "mango-shop-for-mango-campaign-1aca6a0b",
"in_stock": 1,
"item_price": 700,
"discounted_price": 560,
"item_images": [
"https://df17fp68uwcso.cloudfront.net/eyJidWNrZXQiOiAibWVkaWEuZXZhbHkuY29tLmJkIiwgImtleSI6ICJtZWRpYS9pbWFnZXMvYTcwYTNmMzRiYmU1LWRvd25sb2FkLTE4LmpwZyIsICJlZGl0cyI6IHsicmVzaXplIjogeyJ3aWR0aCI6IDM1MCwgImhlaWdodCI6IDM1MCwgImZpdCI6ICJjb250YWluIn0sICJiYWNrZ3JvdW5kIjogeyJyIjogMjU1LCAiZyI6IDI1NSwgImIiOiAyNTUsICJhbHBoYSI6IDF9LCAiZmxhdHRlbiI6IHRydWUsICJqcGVnIjogeyJxdWFsaXR5IjogNzV9fX0="
]
},
{
"shop_item_slug": "mango-faluda-86bc2fa66",
"item_name": "Mango Faluda",
"shop_slug": "mango-shop-for-mango-campaign-1aca6a0b",
"in_stock": 1,
"item_price": 3000,
"discounted_price": 2400,
"item_images": [
"https://df17fp68uwcso.cloudfront.net/eyJidWNrZXQiOiAibWVkaWEuZXZhbHkuY29tLmJkIiwgImtleSI6ICJtZWRpYS9pbWFnZXMvZWQ2MDZiZTNjMDFhLWRvd25sb2FkLTE5LmpwZyIsICJlZGl0cyI6IHsicmVzaXplIjogeyJ3aWR0aCI6IDM1MCwgImhlaWdodCI6IDM1MCwgImZpdCI6ICJjb250YWluIn0sICJiYWNrZ3JvdW5kIjogeyJyIjogMjU1LCAiZyI6IDI1NSwgImIiOiAyNTUsICJhbHBoYSI6IDF9LCAiZmxhdHRlbiI6IHRydWUsICJqcGVnIjogeyJxdWFsaXR5IjogNzV9fX0="
]
}
],
"meta": {
"campaign_banner": "https://s3-ap-southeast-1.amazonaws.com/media.evaly.com.bd/media/images/a6fa12d62177-images-16.jpg",
"campaign_title": "Mango Campaign",
"cashback_rate": 75
}
}
}
Response heade
```
### Admin v2 Campaign Eligible Shop List
**Headers**: application/json; Bearer <Token>
**Requested URL**: {CoreBaseURL}/v2/admin/campaigns/<campaign-slug>/eligible-shops
**Request Method**: GET
**Request Body**: N/A
**Response Body**:
```jsonld=1
{
"success": true,
"message": "shops fetched successfully",
"count": 944,
"data": [
{
"slug": "test-shop-joker",
"contact_number": "01521200070",
"shop_name": "Test Shop Joker",
"shop_image": "https://s3-ap-southeast-1.amazonaws.com/media.evaly.com.bd/media/images/5d5a935f343f-joker-trailer.jpg",
"approval": 1,
"owner_name": "The Zinda",
"is_member": 0,
"member_id": null
},
{
"slug": "faka-shop",
"contact_number": "01997938460",
"shop_name": "faka shop",
"shop_image": "https://s3-ap-southeast-1.amazonaws.com/media.evaly.com.bd/media/images/b2f8e1bd490a-download.jpg",
"approval": 1,
"owner_name": "Rozella Spencer",
"is_member": 0,
"member_id": null
},
{
"slug": "refund-shop",
"contact_number": "01326300967",
"shop_name": "Refund shop",
"shop_image": "https://s3-ap-southeast-1.amazonaws.com/media.evaly.com.bd/media/images/f6dc50912f3f-shopping-cart-with-money.png",
"approval": 1,
"owner_name": "Ishak Ahammed",
"is_member": 0,
"member_id": null
}
... .... ......
]
}
```
### Admin v2 Campaign Eligible Shop Item List
**Headers**: application/json; Bearer <Token>
**Requested URL**: {CoreBaseURL}/v2/admin/campaigns/<campaign-slug>/eligible-shop-items/<shop-slug>?page=1&limit=3
**Request Method**: GET
**Request Body**: N/A
**Response Body**:
```jsonld=1
{
"success": true,
"message": "shop items fetched successfully",
"count": 213,
"data": [
{
"item_name": "product variant",
"item_attributes": "color:black,other size:C3",
"item_id": 9314,
"in_stock": 1,
"item_price": 0,
"discounted_price": 0,
"item_images": "https://s3-ap-southeast-1.amazonaws.com/media.evaly.com.bd/media/images/b777c04651e9-dw_recipe_roast_beef_hero.jpg",
"is_member": 0,
"member_id": null
},
{
"item_name": "product variant",
"item_attributes": "color:black,other size:B2",
"item_id": 9313,
"in_stock": 1,
"item_price": 0,
"discounted_price": 0,
"item_images": "https://s3-ap-southeast-1.amazonaws.com/media.evaly.com.bd/media/images/b777c04651e9-dw_recipe_roast_beef_hero.jpg",
"is_member": 0,
"member_id": null
},
{
"item_name": "product variant",
"item_attributes": "color:black,other size:A1",
"item_id": 9312,
"in_stock": 1,
"item_price": 0,
"discounted_price": 0,
"item_images": "https://s3-ap-southeast-1.amazonaws.com/media.evaly.com.bd/media/images/b777c04651e9-dw_recipe_roast_beef_hero.jpg",
"is_member": 0,
"member_id": null
}
]
}
```
### Admin v2 Campaign Shop Approval
**Headers**: application/json; Bearer <Token>
**Requested URL**: {CoreBaseURL}/v2/admin/campaign-shop-approval/<campaign-slug>
**Request Method**: POST
**Request Body**:
```jsonld=1
{
"approved": true
}
```
**Response Body**:
```jsonld=1
{
"success": true,
"message": "Shop approval successful."
}
```
### Public v2 Campaign shop item's variant List
**Headers**: application/json; Bearer <Token>
**Requested URL**: {CoreBaseURL}/v2/campaigns/<campaign-slug>/shops/<shop-slug>/items/<shop-item-slug>/variants?page=1&limit=3
**Request Method**: GET
**Request Body**: N/A
**Response Body**:
```jsonld=1
{
"success": true,
"message": "shop item variants fetched successfully",
"data": [
{
"shop_slug": "mango-shop-for-mango-campaign-1aca6a0b",
"shop_name": "Mango shop for Mango Campaign",
"shop_image": "https://s3-ap-southeast-1.amazonaws.com/media.evaly.com.bd/media/images/2caf8689d1a1-newfile.jpeg",
"shop_item_name": "mango pudding",
"shop_item_id": 9322,
"shop_item_price": 2000,
"shop_item_discounted_price": 1600,
"shop_item_image": "https://df17fp68uwcso.cloudfront.net/eyJidWNrZXQiOiAibWVkaWEuZXZhbHkuY29tLmJkIiwgImtleSI6ICJtZWRpYS9pbWFnZXMvZmEzY2RmNWJiODRmLW1hbmdvLXB1ZGRpbmctcmVjaXBlLTEuanBnIiwgImVkaXRzIjogeyJyZXNpemUiOiB7IndpZHRoIjogMjUwLCAiaGVpZ2h0IjogMjUwLCAiZml0IjogImNvbnRhaW4ifSwgImJhY2tncm91bmQiOiB7InIiOiAyNTUsICJnIjogMjU1LCAiYiI6IDI1NSwgImFscGhhIjogMX0sICJmbGF0dGVuIjogdHJ1ZSwgImpwZWciOiB7InF1YWxpdHkiOiA3NX19fQ==",
"attributes": []
}
]
}
```
Sign in with Wallet
Connect another wallet