Next Commerce
API ReferenceCampaigns

Campaigns Packages List

List every packages on the campaign.

GET
/campaigns/{id}/packages/

Authorization

oauth2 campaigns:read
AuthorizationBearer <token>

Generate an Access Token through Settings > API Access for single store access or use the Authorization Code flow with your partner App Client ID. Use required permission scopes for API endpoint access. Example Authorization: Bearer 123

In: header

Scope: campaigns:read

Path Parameters

id*integer

Campaign ID.

Query Parameters

name?string

Package name contains this text, case-insensitive.

product_name?string

Product name contains this text, case-insensitive.

product_sku?string

Product sku contains this text, case-insensitive.

Header Parameters

X-29next-API-Version*"2024-04-01"
Default"2024-04-01"

Value in

  • "2024-04-01"

Response Body

application/json

curl -X GET "https://example.com/campaigns/0/packages/" \  -H "X-29next-API-Version: 2024-04-01"
[  {    "created_at": "2019-08-24T14:15:22Z",    "id": 0,    "image": "http://example.com",    "interval": "day",    "interval_count": 0,    "is_recurring": true,    "name": "string",    "prices": [      {        "currency": "str",        "price": "string",        "price_recurring": "string"      }    ],    "product_id": 0,    "product_inventory_availability": "in_stock",    "product_name": "string",    "product_purchase_availability": "available",    "product_sku": "string",    "product_variant_id": 0,    "product_variant_name": "string",    "updated_at": "2019-08-24T14:15:22Z"  }]