Skip to main content

List prices

POST 
/v2/prices/search

List prices

Request​

Body

List prices

    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

    List of Price primary identifiers

    productIds integer[]nullable

    Price product IDs list

    per integernullable

    Search for price per

    list

    object

    nullable

    greaterThan numbernullable

    greater than or equal

    lessThan numbernullable

    less than or equal

    equal numbernullable

    equal to

    cost

    object

    nullable

    greaterThan numbernullable

    greater than or equal

    lessThan numbernullable

    less than or equal

    equal numbernullable

    equal to

    suggested

    object

    nullable

    greaterThan numbernullable

    greater than or equal

    lessThan numbernullable

    less than or equal

    equal numbernullable

    equal to

    store

    object

    nullable

    greaterThan numbernullable

    greater than or equal

    lessThan numbernullable

    less than or equal

    equal numbernullable

    equal to

    bulkDiscountType stringnullable

    Possible values: [costpriceplus, listpricemin, netprice]

    Pricesheet type

    sortInputs string[]nullable

    Inputs to sort by

Responses​

Paginated list of prices

Schema

    items

    object[]

    required

    List of items of type Price

  • Array [

    • id stringrequired

    Primary identifier

    createdAt date-timerequired

    Creation date

    lastModifiedAt date-timerequired

    Last modified date

  • ]

    • 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...