v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Product

Products.get

Returns Product with given id

get/entities/Products/{id}

Path parameters

idstring uuid required

ID of Product to retrieve

Response

Product data

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "allowed_pipelines": 1,
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "description": "string",
    "name": "string",
    "picture_id": "01234567-abcd-dcba-ffff-000000000000",
    "product_category_id": "01234567-abcd-dcba-ffff-000000000000",
    "product_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "sku": "string",
    "unit_symbol": "string",
    "revision": 1,
    "product_pipelines": {
      "allowed_pipelines": 1
    },
    "formatted_name": "string",
    "oppty_product_relation_type_id": "01234567-abcd-dcba-ffff-000000000000"
  }
}