Next Commerce

Campaign Retrieve

Retrieve campaign details.

GET
/api/v1/campaigns/

Authorization

API Authentication
Authorization<token>

Campaign token based authentication.

In: header

Response Body

application/json

curl -X GET "https://example.com/api/v1/campaigns/"
{  "available_currencies": [    {      "code": "string",      "label": "string"    }  ],  "available_express_payment_methods": [    {      "code": "string",      "label": "string"    }  ],  "available_payment_methods": [    {      "code": "string",      "label": "string"    }  ],  "available_shipping_countries": [    {      "code": "string",      "label": "string"    }  ],  "currency": "string",  "id": 0,  "language": "str",  "name": "string",  "offers": [    {      "benefit": {        "description": "string",        "type": "package_percentage",        "value": "string"      },      "code": "string",      "condition": {        "description": "string",        "type": "any",        "value": 0      },      "name": "string",      "packages": [        {          "package_id": 0,          "package_image": "http://example.com",          "package_name": "string",          "package_price": "string",          "package_price_before_discount": "string",          "package_unit_qty": 0,          "product_name": "string",          "product_variant_name": "string",          "unit_price": "string",          "unit_price_before_discount": "string"        }      ],      "ref_id": 0,      "shipping_methods": [        {          "code": "string",          "price": "string",          "price_before_discount": "string",          "ref_id": 0        }      ],      "type": "offer"    }  ],  "packages": [    {      "external_id": 0,      "image": "http://example.com",      "interval": "day",      "interval_count": 0,      "is_recurring": true,      "name": "string",      "price": "string",      "price_recurring": "string",      "price_recurring_total": "string",      "price_retail": "string",      "price_retail_total": "string",      "price_total": "string",      "product_id": 0,      "product_inventory_availability": "in_stock",      "product_name": "string",      "product_purchase_availability": "available",      "product_sku": "string",      "product_variant_attribute_values": null,      "product_variant_id": 0,      "product_variant_name": "string",      "qty": 0,      "ref_id": 0    }  ],  "payment_env_key": "string",  "shipping_methods": [    {      "code": "string",      "price": "string",      "ref_id": 0    }  ]}