Skip to main content
GET
/
products
/
{product_id}
Get a product by ID
curl --request GET \
  --url https://api.sandbox.monite.com/v1/products/{product_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "entity_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_reference": "<string>",
  "ledger_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "measure_unit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "price": {
    "currency": "AED",
    "value": 4503599627370495
  },
  "smallest_amount": 1073741823.5,
  "type": "product"
}

Authorizations

Authorization
string
header
required

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

Headers

x-monite-version
string<date>
required
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

product_id
string<uuid>
required

Response

Successful Response

id
string<uuid>
required

Unique ID of the product.

created_at
string<date-time>
required

Time at which the product was created. Timestamps follow the ISO 8601 standard.

updated_at
string<date-time>
required

Time at which the product was last updated. Timestamps follow the ISO 8601 standard.

entity_id
string<uuid>
required
name
string
required

Name of the product.

description
string

Description of the product.

entity_user_id
string<uuid>
external_reference
string

A user-defined identifier of the product. For example, an internal product code or SKU (stock keeping unit). Client applications can use this field to map the products in Monite to an external product catalog.

Required string length: 1 - 255
Examples:

"HT-1234-S-BL"

"SERVICE-67890"

ledger_account_id
string<uuid>
measure_unit_id
string<uuid>

The unique ID reference of the unit used to measure the quantity of this product (e.g. items, meters, kilograms).

price
object
smallest_amount
number

The smallest amount allowed for this product.

Required range: 0 <= x <= 2147483647
type
enum<string>
default:product

Specifies whether this offering is a product or service. This may affect the applicable tax rates.

Available options:
product,
service