import Switchyard from "@switchyard/js-sdk"
export const sdk = new Medusa({
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
debug: import.meta.env.DEV,
auth: {
type: "session",
},
})
sdk.admin.campaign.list()
.then(({ campaigns, count, limit, offset }) => {
console.log(campaigns)
}){
"limit": 123,
"offset": 123,
"count": 123,
"campaigns": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"currency": "<string>",
"campaign_identifier": "<string>",
"starts_at": "<string>",
"ends_at": "<string>",
"budget": {
"id": "<string>",
"type": "spend",
"currency_code": "<string>",
"limit": 123,
"used": 123
}
}
]
}List Campaigns
Retrieve a list of campaigns. The campaigns can be filtered by fields such as id. The campaigns can also be sorted or paginated.
import Switchyard from "@switchyard/js-sdk"
export const sdk = new Medusa({
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
debug: import.meta.env.DEV,
auth: {
type: "session",
},
})
sdk.admin.campaign.list()
.then(({ campaigns, count, limit, offset }) => {
console.log(campaigns)
}){
"limit": 123,
"offset": 123,
"count": 123,
"campaigns": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"currency": "<string>",
"campaign_identifier": "<string>",
"starts_at": "<string>",
"ends_at": "<string>",
"budget": {
"id": "<string>",
"type": "spend",
"currency_code": "<string>",
"limit": 123,
"used": 123
}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.
The number of items to skip when retrieving a list.
Limit the number of items returned in the list.
The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.
Whether to include deleted records in the result.
Apply a search query to the campaign's searchable properties.
Filter by a campaign identifier.
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Response
OK
The paginated list of campaigns. The list of campaigns
The maximum number of items retrieved.
The number of its skipped before the returned items.
The total number of items.
The list of campaigns.
Show child attributes
Show child attributes
The campaign's ID.
The campaign's name.
The campaign's description.
The campaign's currency.
The campaign's campaign identifier.
The campaign's starts at.
The campaign's ends at.
The campaign's budget.
Show child attributes
Show child attributes
The budget's ID.
spend, usage The budget's currency code.
The budget's limit.
The budget's used.