Product

Product Registry

Maintain and manage product registries.

Create/Add a new product

Create a new product

POST/product/v1/_create

Body

application/json

Capture details of Product.

Product*array of Product (object)

Response

202400

Product request has been accepted.

Body

*/*

Product*array of Product (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/product/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Product": [
        {
          "type": "DRUG",
          "name": "Paracetamol"
        }
      ]
    }),
});
const data = await response.json();

Response

202

{
  "Product": [
    {
      "type": "DRUG",
      "name": "Paracetamol",
      "manufacturer": "J&J"
    }
  ]
}

Update product

Update product

POST/product/v1/_update

Body

application/json

Capture details of Product.

Product*array of Product (object)

Response

202400

Product request has been accepted.

Body

*/*

Product*array of Product (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/product/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Product": [
        {
          "type": "DRUG",
          "name": "Paracetamol"
        }
      ]
    }),
});
const data = await response.json();

Response

202

{
  "Product": [
    {
      "type": "DRUG",
      "name": "Paracetamol",
      "manufacturer": "J&J"
    }
  ]
}

Search product

Search product

POST/product/v1/_search

Query parameters

Body

application/json

Capture details of Product.

Product*ProductSearch (object)

Response

200400

Product.

Body

*/*

Product*array of Product (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/product/v1/_search?limit=0&offset=0&tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Product": {}
    }),
});
const data = await response.json();

Response

200

{
  "Product": [
    {
      "type": "DRUG",
      "name": "Paracetamol",
      "manufacturer": "J&J"
    }
  ]
}

Create/Add a new variant for a product

Create/Add a new variant for a product

POST/product/variant/v1/_create

Body

application/json

Capture details of Product Variant.

ProductVariant*array of ProductVariant (object)

Response

202400

Product Variant request has been accepted.

Body

*/*

ProductVariant*array of ProductVariant (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/product/variant/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ProductVariant": [
        {
          "productId": "text",
          "variation": "Paracetamol 200mg white color"
        }
      ]
    }),
});
const data = await response.json();

Response

202

{
  "ProductVariant": [
    {
      "productId": "text",
      "sku": "PAR-200",
      "variation": "Paracetamol 200mg white color"
    }
  ]
}

Update product variant

Update product variant

POST/product/variant/v1/_update

Body

application/json

Capture details of Product Variant.

ProductVariant*array of ProductVariant (object)

Response

202400

Product variant request has been accepted.

Body

*/*

ProductVariant*array of ProductVariant (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/product/variant/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ProductVariant": [
        {
          "productId": "text",
          "variation": "Paracetamol 200mg white color"
        }
      ]
    }),
});
const data = await response.json();

Response

202

{
  "ProductVariant": [
    {
      "productId": "text",
      "sku": "PAR-200",
      "variation": "Paracetamol 200mg white color"
    }
  ]
}

Search product variant

Search product variant

POST/product/variant/v1/_search

Query parameters

Body

application/json

Capture details of Product variant.

ProductVariant*ProductVariantSearch (object)

Response

200400

Product Variant.

Body

*/*

ProductVariant*array of ProductVariant (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/product/variant/v1/_search?limit=0&offset=0&tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ProductVariant": {}
    }),
});
const data = await response.json();

Response

200

{
  "ProductVariant": [
    {
      "productId": "text",
      "sku": "PAR-200",
      "variation": "Paracetamol 200mg white color"
    }
  ]
}