cart

cart.coupon.list

Get cart coupon discounts.

get/cart.coupon.list.json

Request

  • Base URL: https://api.api2cart.com/v1.1
  • URL: https://api.api2cart.com/v1.1/cart.coupon.list.json
  • Auth: API key in header x-api-key and API key in header x-store-key

Query parameters

startinteger

This parameter sets the number from which you want to get entities

countinteger

This parameter sets the entity amount that has to be retrieved. Max allowed count=250

page_cursorstring

Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)

coupons_idsstring

Filter coupons by ids

store_idstring

Filter coupons by store id

lang_idstring

Language id

availboolean

Filter coupons by avail status

statusstring

Defines coupon's status

date_start_fromstring

Filter entity by date_start (greater or equal)

date_start_tostring

Filter entity by date_start (less or equal)

date_end_fromstring

Filter entity by date_end (greater or equal)

date_end_tostring

Filter entity by date_end (less or equal)

response_fieldsstring

Set this parameter to choose which entity fields to retrieve. Use comma-separated field names in curly braces, nested to match the response structure, e.g. {result{product{id,name}}}. The wildcard * returns every field at a level: {} gives the whole response, {result{product{}}} all product fields.

paramsstring

Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to retrieve

excludestring

Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter params equal force_all

Response

successful operation

return_codeinteger nullable
return_messagestring nullable
additional_fieldsobject nullable
custom_fieldsobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.