Appearance
Get customer price and their base prices
GET
/v1/api/customer/{code}/prices
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Path Parameters
code*
Type
Requiredstring
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
filter.price
Filter by price query param.
Format: filter.price={$not}:OPERATION:VALUE
Example: filter.price=$not:$like:John Doe&filter.price=like:John
Available Operations
- $eq
- $gt
- $gte
- $lt
- $lte
Type
array
filter.finalPrice
Filter by finalPrice query param.
Format: filter.finalPrice={$not}:OPERATION:VALUE
Example: filter.finalPrice=$not:$like:John Doe&filter.finalPrice=like:John
Available Operations
- $eq
- $gt
- $gte
- $lt
- $lte
Type
array
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: No default sorting specified, the result order is not guaranteed
Available Fields
- id
- pricelist
- product.code
Type
array
search
Search term to filter result values
Example: John
Default Value: No default value
Type
string
searchBy
List of fields to search by term to filter result values
Example: product.code
Default Value: By default all fields mentioned below will be used to search by term
Available Fields
- product.code
Type
array
select
List of fields to select.
Example: *,product.code,product.name
Default Value: By default all fields returns. If you want to select only some fields, provide them in query param
Type
string
Responses
application/json
JSON "data": [ { } ], "meta": { "itemsPerPage": 0, "totalItems": 0, "currentPage": 0, "totalPages": 0, "sortBy": [ [ ] ], "searchBy": [ "string" ], "search": "string", "select": [ "string" ], "filter": { } }, "links": { "first": "string", "previous": "string", "current": "string", "next": "string", "last": "string" }
{
}