Skip to main content

List product discounts

POST 
/v2/discounts/search

List product discounts

Request​

Header Parameters

    tenant stringrequired

    Tenant identifier

Body

required

    page integernullable

    Possible values: >= 1

    Default value: 1

    Pagination page number

    offset integernullable

    Possible values: >= 1

    Default value: 12

    Pagination offset number

    createdAt

    object

    nullable

    greaterThan date-time

    Date greater than provided date

    lessThan date-time

    Date less than provided date

    lastModifiedAt

    object

    nullable

    greaterThan date-time

    Date greater than provided date

    lessThan date-time

    Date less than provided date

    ids string[]nullable

    Search by Discounts primary identifiers

    pricesheetIds string[]nullable

    Search by Pricesheets primary identifiers

    productIds integer[]nullable

    Search by product ids

    categoryIds integer[]nullable

    Search by category ids

    priceGroups string[]nullable

    Search by price groups

    value

    object

    nullable

    greaterThan numbernullable

    greater than or equal

    lessThan numbernullable

    less than or equal

    equal numbernullable

    equal to

    discountTypes number[]nullable

    Possible values: [[object Object]]

    Discount type

    quantityFrom

    object

    nullable

    greaterThan numbernullable

    greater than or equal

    lessThan numbernullable

    less than or equal

    equal numbernullable

    equal to

    sortInputs string[]nullable

    Inputs to sort by

    validFrom

    object

    nullable

    greaterThan date-time

    Date greater than provided date

    lessThan date-time

    Date less than provided date

    validTo

    object

    nullable

    greaterThan date-time

    Date greater than provided date

    lessThan date-time

    Date less than provided date

Responses​

Paginated list of discounts

Schema

    items

    object[]

    required

    List of items of type Discount

  • Array [

    • id stringrequired

    Primary identifier

    createdAt date-timerequired

    Creation date

    lastModifiedAt date-timerequired

    Last modified date

    validFrom date-time

    Start date from which the bulk pricing is effective. Must be a valid ISO 8601 date string

    validTo date-time

    Start date from which the bulk pricing is effective. Must be a valid ISO 8601 date string

  • ]

    • itemsFound integerrequired

    Total number of items found

    offset integernullablerequired

    Possible values: >= 1

    Default value: 12

    The amount of items to show per page

    page integernullablerequired

    Possible values: >= 1

    Default value: 1

    The current page

    pages integernullablerequired

    Possible values: >= 1

    Total amount of pages

    start integernullablerequired

    Possible values: >= 1

    Start position of the current page

    end integernullablerequired

    Possible values: >= 1

    End position of the current page

Loading...