Get products

GET

/products

GET

/v1/products

$ curl https://api.sandbox.monite.com/v1/products \
>      -H "x-monite-version: 2023-09-01" \
>      -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
>      -H "Authorization: Bearer <token>"

1 {
2   "data": [
3     {
4       "id": "id",
5       "created_at": "2024-01-15T09:30:00Z",
6       "updated_at": "2024-01-15T09:30:00Z",
7       "entity_id": "entity_id",
8       "name": "name",
9       "description": "description",
10       "entity_user_id": "entity_user_id",
11       "external_reference": "HT-1234-S-BL",
12       "ledger_account_id": "ledger_account_id",
13       "measure_unit_id": "measure_unit_id",
14       "price": {
15         "currency": "AED",
16         "value": 1
17       },
18       "smallest_amount": 1.1,
19       "type": "product"
20     }
21   ],
22   "next_pagination_token": "next_pagination_token",
23   "prev_pagination_token": "prev_pagination_token"
24 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

orderenumOptional

Sort order (ascending by default). Typically used together with the sort parameter.

Allowed values:

limitintegerOptional1-100Defaults to 100

The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page.

pagination_tokenstringOptional

A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If pagination_token is specified, all other query parameters are ignored and inferred from the initial query.

If not specified, the first page of results will be returned.

A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. If not specified, the first page of results will be returned.

sort"name"Optional

The field to sort the results by. Typically used together with the order parameter.

id__instringOptionalformat: "uuid"

namestringOptional<=100 characters

name__containsstringOptional<=100 characters

name__icontainsstringOptional<=100 characters

typeenumOptional

Allowed values:

priceintegerOptional>=0

price__gtintegerOptional>=0

price__ltintegerOptional>=0

price__gteintegerOptional>=0

price__lteintegerOptional>=0

currencyenumOptional

currency__inenumOptional

measure_unit_idstringOptionalformat: "uuid"

created_at__gtdatetimeOptional

created_at__ltdatetimeOptional

created_at__gtedatetimeOptional

created_at__ltedatetimeOptional

Response

Successful Response

datalist of objects

next_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you’ve reached the last page).

prev_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you’ve reached the first page).

Errors

400

Get Products Request Bad Request Error

401

Get Products Request Unauthorized Error

403

Get Products Request Forbidden Error

422

Get Products Request Unprocessable Entity Error

500

Get Products Request Internal Server Error

Authentication

Headers

Query parameters

Response

Errors