Products

Get all products

Returns a paginated list of products in the current environment, starting from "previousId" limited by "size". with a metadata about the pagination.

get/products

Request

  • Base URL: https://pts-api.procountor.com/api
  • URL: https://pts-api.procountor.com/api/products
  • Auth: HTTP bearer

Query parameters

namestring

Name of product matched by substring.

previousIdinteger

Previous Id for pagination

sizeinteger

Page size for the results. Maximum value: 200.

orderById'ASC' | 'DESC'

Order the results by product ID

orderByVersion'ASC' | 'DESC'

Order the results by product version

groupinteger[]

Id of product group.

type'SALES' | 'PURCHASE' | 'TRAVEL'

Register type of product. If not given, then SALES and PURCHASE returned as default

codestring

Custom code assigned by the owner of the product. Matched by substring.

startDatestring date

Start date of activity period. Used by TRAVEL type only. Used to search all travel product which are in active state after that date (expiration date is after that date).

endDatestring date

End date of activity period. Used by TRAVEL type only. Used to search all travel product which were activated before that date (start date is before that date).

includeLocalizationsboolean

Include localized product names

activeboolean

Status of product

versionStartDatestring date-time

Start date of the search (product updated date)

versionEndDatestring date-time

End date of the search (product updated date)

Response

The products were successfully returned

Example response

{
  "results": [
    {
      "type": "TRAVEL",
      "currency": "EUR",
      "version": "2019-09-25T13:15:58"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.