List all discounts for customers

Request

Authorization

Add parameter in header

api-key

Example:

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

Query Params

pageSize

integer

optional

This specifies the number of objects to returned, ranging between 10 and 100.

Example:

100

pageNumber

integer

optional

The parameter pageNumber indicates which page of the result should be requested.

Example:

1

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?pageSize=100&pageNumber=1&referenceDate=2024-03-13T13:28:06.419Z' \
--header 'api-key;'

Responses

🟢200Success

application/json

Body

pagination

object

optional

totalResults

integer

optional

The total number of records.

pageNumber

integer

optional

The current page number.

pageSize

integer

optional

The number of records returned per page.

totalPages

integer

optional

The total number of pages.

results

array [object {4}]

required

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.

Example

{
  "pagination": {
    "totalResults": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "totalPages": 0
  },
  "results": [
    {
      "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
              }
            }
          ]
        }
      ]
    }
  ]
}