WinkPG Docs
View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such operation

This instance documents no operation under that identifier. It may have been renamed, or it may belong to a feature this installation hasn't enabled.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-01 06:30 UTC.

API reference Promotions

Counts the Promotions that match a filter.

POST /api/promotions/list/continuation/count deprecated

Requires: Promotions.Promotions, merchant scope.

Takes the same request body as the continuation list endpoint and returns how many Promotions match it, without returning the records themselves. The count is approximate and is intended to sit alongside a paged list, so treat it as a display figure rather than a reconciliation total.

Try this in the console

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a GetPromotionContinuationInput. See the Request body section below for its fields.

Code sample language

cURL
curl -X POST "{{BASE_URL}}/api/promotions/list/continuation/count" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isActive": false,
  "discountType": {},
  "filter": {
    "logic": {},
    "rules": [],
    "groups": []
  },
  "maxResultCount": 1,
  "continuationToken": "",
  "sorting": {
    "field": "",
    "descending": false
  },
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxModificationTime": "2026-01-01T00:00:00Z",
  "maxModifitionTime": "2026-01-01T00:00:00Z",
  "minModificationTime": "2026-01-01T00:00:00Z",
  "minModifitionTime": "2026-01-01T00:00:00Z",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false
}'

PowerShell
$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isActive": false,
  "discountType": {},
  "filter": {
    "logic": {},
    "rules": [],
    "groups": []
  },
  "maxResultCount": 1,
  "continuationToken": "",
  "sorting": {
    "field": "",
    "descending": false
  },
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxModificationTime": "2026-01-01T00:00:00Z",
  "maxModifitionTime": "2026-01-01T00:00:00Z",
  "minModificationTime": "2026-01-01T00:00:00Z",
  "minModifitionTime": "2026-01-01T00:00:00Z",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/promotions/list/continuation/count' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)
import { Configuration, PromotionsApi } from '@winkpg/winkpg-api';

const api = new PromotionsApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.promotionsGetApproximateTotalCount({
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isActive": false,
  "discountType": {},
  "filter": {
    "logic": {},
    "rules": [],
    "groups": []
  },
  "maxResultCount": 1,
  "continuationToken": "",
  "sorting": {
    "field": "",
    "descending": false
  },
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxModificationTime": "2026-01-01T00:00:00Z",
  "maxModifitionTime": "2026-01-01T00:00:00Z",
  "minModificationTime": "2026-01-01T00:00:00Z",
  "minModifitionTime": "2026-01-01T00:00:00Z",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false
});

TypeScript (raw HTTP)
const response = await fetch('{{BASE_URL}}/api/promotions/list/continuation/count', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "isActive": false,
    "discountType": {},
    "filter": {
      "logic": {},
      "rules": [],
      "groups": []
    },
    "maxResultCount": 1,
    "continuationToken": "",
    "sorting": {
      "field": "",
      "descending": false
    },
    "maxCreationTime": "2026-01-01T00:00:00Z",
    "minCreationTime": "2026-01-01T00:00:00Z",
    "maxModificationTime": "2026-01-01T00:00:00Z",
    "maxModifitionTime": "2026-01-01T00:00:00Z",
    "minModificationTime": "2026-01-01T00:00:00Z",
    "minModifitionTime": "2026-01-01T00:00:00Z",
    "includeDeleted": false,
    "includeInactive": false,
    "includeApproxTotalCount": false
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)
using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new PromotionsApi(config);
var body = JsonSerializer.Deserialize<GetPromotionContinuationInput>("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "isActive": false,
      "discountType": {},
      "filter": {
        "logic": {},
        "rules": [],
        "groups": []
      },
      "maxResultCount": 1,
      "continuationToken": "",
      "sorting": {
        "field": "",
        "descending": false
      },
      "maxCreationTime": "2026-01-01T00:00:00Z",
      "minCreationTime": "2026-01-01T00:00:00Z",
      "maxModificationTime": "2026-01-01T00:00:00Z",
      "maxModifitionTime": "2026-01-01T00:00:00Z",
      "minModificationTime": "2026-01-01T00:00:00Z",
      "minModifitionTime": "2026-01-01T00:00:00Z",
      "includeDeleted": false,
      "includeInactive": false,
      "includeApproxTotalCount": false
    }
    """);

var result = await api.PromotionsGetApproximateTotalCountAsync(body);

C# (raw HTTP)
using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/promotions/list/continuation/count");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "isActive": false,
      "discountType": {},
      "filter": {
        "logic": {},
        "rules": [],
        "groups": []
      },
      "maxResultCount": 1,
      "continuationToken": "",
      "sorting": {
        "field": "",
        "descending": false
      },
      "maxCreationTime": "2026-01-01T00:00:00Z",
      "minCreationTime": "2026-01-01T00:00:00Z",
      "maxModificationTime": "2026-01-01T00:00:00Z",
      "maxModifitionTime": "2026-01-01T00:00:00Z",
      "minModificationTime": "2026-01-01T00:00:00Z",
      "minModifitionTime": "2026-01-01T00:00:00Z",
      "includeDeleted": false,
      "includeInactive": false,
      "includeApproxTotalCount": false
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)
import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.PromotionsApi(client)
    body = winkpg_api.GetPromotionContinuationInput.from_dict({
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "isActive": False,
      "discountType": {},
      "filter": {
        "logic": {},
        "rules": [],
        "groups": []
      },
      "maxResultCount": 1,
      "continuationToken": "",
      "sorting": {
        "field": "",
        "descending": False
      },
      "maxCreationTime": "2026-01-01T00:00:00Z",
      "minCreationTime": "2026-01-01T00:00:00Z",
      "maxModificationTime": "2026-01-01T00:00:00Z",
      "maxModifitionTime": "2026-01-01T00:00:00Z",
      "minModificationTime": "2026-01-01T00:00:00Z",
      "minModifitionTime": "2026-01-01T00:00:00Z",
      "includeDeleted": False,
      "includeInactive": False,
      "includeApproxTotalCount": False
    })
    result = api.promotions_get_approximate_total_count(body)

pip install requests

Python (raw HTTP)
import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isActive": False,
  "discountType": {},
  "filter": {
    "logic": {},
    "rules": [],
    "groups": []
  },
  "maxResultCount": 1,
  "continuationToken": "",
  "sorting": {
    "field": "",
    "descending": False
  },
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxModificationTime": "2026-01-01T00:00:00Z",
  "maxModifitionTime": "2026-01-01T00:00:00Z",
  "minModificationTime": "2026-01-01T00:00:00Z",
  "minModifitionTime": "2026-01-01T00:00:00Z",
  "includeDeleted": False,
  "includeInactive": False,
  "includeApproxTotalCount": False
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/promotions/list/continuation/count",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description
suppressNulls required query boolean If true, omit properties with null values.

Request body

application/json , required

Field Type Description
merchantId required string (uuid) Scope to a single merchant. A merchant-scoped request is cheaper and faster than an unscoped one. nullable
isActive required boolean Scope to promotions that are switched on, or to those that are switched off. nullable
discountType required all of PromotionDiscountType Scope to one discount type. Conditional: When DiscountType is not null. nullable
filter required FilterGroup
maxResultCount required integer (int32) min 1max 100
continuationToken required string nullable
sorting required SortDescriptor
maxCreationTime required string (date-time) Upper bound on creation time. nullable
minCreationTime required string (date-time) Lower bound on creation time. nullable
maxModificationTime required string (date-time) Upper bound on last-modification time. nullable
maxModifitionTime required string (date-time) Deprecated misspelled alias of `maxModificationTime`. nullabledeprecated
minModificationTime required string (date-time) Lower bound on last-modification time. nullable
minModifitionTime required string (date-time) Deprecated misspelled alias of `minModificationTime`. nullabledeprecated
includeDeleted required boolean
includeInactive required boolean
includeApproxTotalCount required boolean Set to false to skip the approximate total count and receive a null count; omit it or set it to true to receive the count as before. nullable

This request body has no documented fields.

Responses

200 OK

Body: integer (int64) Each item has these fields.

Field Type Description

This response has no documented body fields.

403 Forbidden

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

401 Unauthorized

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

400 Bad Request

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

404 Not Found

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

501 Not Implemented

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

500 Internal Server Error

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

429 The request was refused because a rate limit was exceeded. Wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling.

Body: RateLimitProblemDetails Each item has these fields.

Field Type Description
type required string The problem type identifier. Always the same value: the failure is the status code itself, so there is no sub-type for a caller to branch on. nullable
title required string A short, human-readable summary of the problem type. nullable
status required integer (int32) The HTTP status code, repeated in the body as the problem-details format defines.
detail required string A human-readable explanation of this occurrence of the problem. nullable
retryAfterSeconds required integer (int32) How long to wait before retrying, in whole seconds, carrying the same figure as the `Retry-After` header. Always at least one: a value of zero would invite an immediate retry that is certain to be rejected again.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by Promotions

Authentication

    Reconnecting to the server

    Could not reconnect

    This session has ended

    Attempt 1

    Your work on this page is still here. Retrying keeps it; reloading starts the page again.

    The server no longer holds this page's state, so it has to be loaded again.