GET
{micro_service_base_url}
/
stores
/
company
/
{company_id}
/
campaigns
/
{campaign_id}
{
  "id": "<string>",
  "company_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "status": "<string>",
  "image": "<string>",
  "created_by": "<string>",
  "updated_by": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "deletedAt": "<string>",
  "associated_stores": [
    {
      "store_id": "<string>",
      "store_name": "<string>",
      "status": "<string>",
      "linked_at": "<string>"
    }
  ],
  "promotions": [
    {
      "promotion_id": "<string>",
      "code": "<string>",
      "type": "<string>",
      "status": "<string>",
      "usage_count": 123
    }
  ],
  "performance_metrics": {
    "total_views": 123,
    "total_conversions": 123,
    "conversion_rate": 123,
    "revenue_generated": "<string>",
    "average_order_value": "<string>"
  }
}
This endpoint provides complete details for a specific campaign, including all configuration settings, associated store information, linked promotions, and performance analytics.
This endpoint returns the most comprehensive campaign information available, ideal for campaign editing, detailed analysis, and administrative oversight.

Path Parameters

company_id
string
required
The unique identifier of the company that owns the campaign
campaign_id
string
required
The unique identifier of the campaign to retrieve details for

Response

id
string
Unique campaign identifier
company_id
string
Company identifier this campaign belongs to
name
string
Campaign name
description
string
Detailed campaign description
start_date
string
Campaign start date (YYYY-MM-DD)
end_date
string
Campaign end date (YYYY-MM-DD)
status
string
Current campaign status
image
string
URL to campaign image asset
created_by
string
ID of the user who created the campaign
updated_by
string
ID of the user who last updated the campaign
created_at
string
Campaign creation timestamp
updated_at
string
Campaign last update timestamp
deletedAt
string
Deletion timestamp (null for active campaigns)
associated_stores
array
List of stores linked to this campaign
promotions
array
List of promotions associated with this campaign
performance_metrics
object
Campaign performance analytics

Example Response

Since no specific response was provided, here’s the expected comprehensive structure:
{
  "id": "1000010",
  "company_id": "1000058",
  "name": "Spring Fresh Campaign",
  "description": "Spring seasonal promotion featuring fresh products and outdoor essentials",
  "start_date": "2025-03-01",
  "end_date": "2025-05-31",
  "status": "active",
  "image": "https://lula-stores-service-staging.s3.amazonaws.com/company/1000058/campaigns/1000010/1744591882710.webp",
  "created_by": "1000418",
  "updated_by": "1000418",
  "created_at": "2025-04-14T00:51:22.994Z",
  "updated_at": "2025-04-14T00:51:22.994Z",
  "deletedAt": null,
  "associated_stores": [
    {
      "store_id": "store_001",
      "store_name": "Downtown Location",
      "status": "active",
      "linked_at": "2025-04-14T01:00:00.000Z"
    }
  ],
  "promotions": [
    {
      "promotion_id": "promo_001",
      "code": "SPRING25",
      "type": "percentage",
      "status": "active",
      "usage_count": 45
    }
  ],
  "performance_metrics": {
    "total_views": 1250,
    "total_conversions": 89,
    "conversion_rate": 7.12,
    "revenue_generated": "4,567.89",
    "average_order_value": "51.32"
  }
}
Complete Information: This endpoint provides the most comprehensive view of a campaign, including all related data needed for campaign management and analysis.
Performance Monitoring: Use the performance_metrics data to assess campaign effectiveness and make data-driven decisions about campaign optimization.

Use Cases

Error Responses

Sensitive Information: Campaign details may include sensitive business information. Ensure proper access controls are in place when displaying this data.