API Objects

JSON objects of Cardsmobile Promo API

Documentation has moved

The information on this page is no longer updated and may be obsolete. The most current Koshelek documentation is now available at the new address:

https://developers.koshelek.app/en/

1. Item

The Item object contains promo details:

FieldTypeMandatoryDescription

promoId

Number

Yes

Unique promo reference ID.

name

String

Yes

Promo name.

startDate

String

Yes

Promo start date in format: YYYY-MM-DDTHH:MM:SS+00

endDate

String

No

Promo end date in format: YYYY-MM-DDTHH:MM:SS+00

null: indefinite promo (for promos created in partner's Koshelek for Business personal account).

status

String

Yes

Current promo state, based on promo start and end dates. Available promo states:

  • active — the promo is ongoing;

  • completed — the promo has ended;

  • planned — the promo is scheduled, yet not started.

Last updated