Search bulk cost prices

POST 
/v2/bulk-cost-prices/search

Search bulk cost prices

Request

application/json

Body

Search bulk cost prices

pagenumber
Pagination page number. [Default to 1]
Default value: 1
offsetnumber
Pagination offset number. [Default to 12]
Default value: 12
idsstring[]
List of Bulk Cost Prices primary identifiers
Example: ["018fcdb1-52d3-7c32-bf7c-46d49b338bca","018fcdb1-52d3-72c4-85dc-4ade9c4de935","018fcdb1-52d3-74b6-86d6-5e705b84c1e2"]
priceIdsstring[]
List of price primary identifiers
Example: ["018fcdb1-52d3-7c32-bf7c-46d49b338bca","018fcdb1-52d3-72c4-85dc-4ade9c4de935","018fcdb1-52d3-74b6-86d6-5e705b84c1e2"]

quantityFrom

object

greaterThannumber

greater than or equal

Example: 1

lessThannumber

less than or equal

Example: 1

equalnumber

equal to

Example: 1

value

object

greaterThannumber

greater than or equal

Example: 1.55

lessThannumber

less than or equal

Example: 1.55

equalnumber

equal to

Example: 1.55

validFrom

object

greaterThandate-time

Date greater than provided date

Example: 2314-03-14T03:14:15.926Z

lessThandate-time

Date less than provided date

Example: 2314-03-14T03:14:15.926Z

validTo

object

greaterThandate-time

Date greater than provided date

Example: 2314-03-14T03:14:15.926Z

lessThandate-time

Date less than provided date

Example: 2314-03-14T03:14:15.926Z
sortInputsstring[]
Inputs to sort by
Example: [{"field":"createdAt","order":"asc"}]

Responses

200

Paginated list of bulk cost prices

application/json

Schema

Schema

items

object[]

required

List of items of type BulkCostPrice

Array [

idstringrequired

Primary identifier

Example: 1234

createdAtdate-timerequired

Creation date

Example: 2022-01-01T00:00:00.000Z

lastModifiedAtdate-timerequired

Last modified date

Example: 2022-01-02T00:00:00.000Z

validFromdate-time

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

Example: 2022-01-01T00:00:00.000Z

validTodate-time

End date of the bulk pricing offer. Must be a valid ISO 8601 date string

Example: 2022-01-31T00:00:00.000Z

]

itemsFoundintegerrequired
Total number of items found
Example: 12
offsetintegernullablerequired
The amount of items to show per page
Possible values: >= 1
Default value: 12
Example: 12
pageintegernullablerequired
The current page
Possible values: >= 1
Default value: 1
Example: 4
pagesintegernullablerequired
Total amount of pages
Possible values: >= 1
Example: 1
startintegernullablerequired
Start position of the current page
Possible values: >= 1
Example: 1
endintegernullablerequired
End position of the current page
Possible values: >= 1
Example: 12

Example (from schema)

{
  "items": [
    {
      "id": 1234,
      "createdAt": "2022-01-01T00:00:00.000Z",
      "lastModifiedAt": "2022-01-02T00:00:00.000Z",
      "validFrom": "2022-01-01T00:00:00.000Z",
      "validTo": "2022-01-31T00:00:00.000Z"
    }
  ],
  "itemsFound": 12,
  "offset": 12,
  "page": 4,
  "pages": 1,
  "start": 1,
  "end": 12
}

400

Bad request

403

Forbidden.

500

Unknown get bulk cost prices error