TOtopi
ops
ops-discounts

Get a discount

Changed on

Show discount info

get/ops/discount/{id}

Request

  • Base URL
    https://api.topi-staging.eu
  • URL
    https://api.topi-staging.eu/ops/discount/{id}
  • Auth
    OAuth 2
    Authorization code: /oauth2/authorize
    Token URL: /oauth2/token scopes: discount:read

Path parameters

idstring regexp required

discount ID

Example:739b63c2-9e58-4964-b38d-4ebb424de242

Response

OK response.

allowed_usage_countinteger required

how many times this discount code can be used

codestring

discount code

created_atstring date-time required
descriptionstring

discount description (campaign, seller ...

disabled_atstring date-time
idstring regexp required

discount ID

rulesobject required

How this discount will be applied

seller_idstring regexp required

seller ID

type'fixed_initial_rent_waiver' required
updated_atstring date-time required
usage_countinteger required
valid_fromstring date-time required
valid_untilstring date-time required

Example response

{
  "allowed_usage_count": 1,
  "code": "abc123",
  "created_at": "1970-01-01T00:00:01Z",
  "description": "abc123",
  "disabled_at": "1970-01-01T00:00:01Z",
  "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
  "minimum_merchandise_value": {
    "amount": 34000,
    "currency": "EUR"
  },
  "rules": {
    "abc123": "abc123"
  },
  "seller_id": "739b63c2-9e58-4964-b38d-4ebb424de242",
  "type": "fixed_initial_rent_waiver",
  "updated_at": "1970-01-01T00:00:01Z",
  "usage_count": 1,
  "valid_from": "1970-01-01T00:00:01Z",
  "valid_until": "1970-01-01T00:00:01Z"
}

Changes

  • ac6979514123Revision changes
    • info

      api operation id discount.showDiscount removed and replaced with discount#showDiscount

  • 7ff7ee94b30eRevision changes
    • info

      api operation id discount#showDiscount removed and replaced with discount.showDiscount

    • info

      api tag ops-discounts added