Get all discounts for product by id

Request

Authorization

Add parameter in header

api-key

Example:

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

Path Params

id

integer

required

Example:

1

Query Params

configuration

integer

optional

The id of the configuration. (ConfigurationHeaderId)

quantity

number

optional

The amount which is used to determine the price. (default = 1)

Example:

3

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/products/1?configuration=&quantity=3&referenceDate=2024-03-13T13:28:06.419Z' \
--header 'api-key;'

Responses

🟢200Success

application/json

Body

id

integer

optional

The unique identifier of the product.

code

string

optional

The unique code with which the product can be found.

name

string

optional

The name of the product.

discounts

array [object {8}]

optional

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.

fixedPrice

object

optional

A discount with a fixed price.

percentageAmount

object

optional

The discount based on a percentage

buyXGetY

object

optional

"Pay X, get Y price agreement.

tieredPercentageAmount

array [object {2}]

optional

Discount based on the amount

customFields

array [object {2}]

optional

The custom fields.

Example

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