Get all discounts for a customer by id

Request

Authorization

Add parameter in header

api-key

Example:

api-key: ********************

Path Params

id

integer

required

Example:

1

Query Params

referenceDate

string

optional

This date is used when calculating the price. (default = current date)

Example:

2024-03-13T13:28:06.419Z

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.logictrade.cloud/rest/v1/discounts/customers/1?referenceDate=2024-03-13T13:28:06.419Z' \
--header 'api-key;'

Responses

🟢200Success

application/json

Body

id

integer

optional

The unique identifier of the customer

number

string

optional

A unique number with which the customer can be found.

name

string

optional

The full name or business name of the customer.

discounts

array [object {6}]

optional

All discounts applicable to the customer.

description

string

optional

The description of the discount.

startDate

string <date>

optional

The start date of the discount.

endDate

string <date>

optional

The end date of the discount.

general

array [object {1}]

optional

Discounts that are always valid.

products

array [object {7}]

optional

Discounts for specific products.

productGroups

array [object {3}]

optional

Discounts on a group of items.

Example

{
  "id": 0,
  "number": "string",
  "name": "string",
  "discounts": [
    {
      "description": "string",
      "startDate": "2019-08-24",
      "endDate": "2019-08-24",
      "general": [
        {
          "percentageAmount": {
            "percentage": 0,
            "minQuantity": 0
          }
        }
      ],
      "products": [
        {
          "id": 0,
          "code": "string",
          "name": "string",
          "fixedPrice": {
            "price": 0,
            "minQuantity": 0
          },
          "percentageAmount": {
            "percentage": 0,
            "minQuantity": 0
          },
          "buyXGetY": {
            "buyQuantity": 0,
            "getQuantity": 0
          },
          "tieredPercentageAmount": [
            {
              "tier": 0,
              "precentage": 0
            }
          ]
        }
      ],
      "productGroups": [
        {
          "code": "string",
          "description": "string",
          "percentageAmount": {
            "percentage": 0,
            "minQuantity": 0
          }
        }
      ]
    }
  ]
}