v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Product Details

Returns the details of a specific product. You can retrieve details of multiple products at a time.

get/product/get

Query parameters

skustring

SKU code of the product to fetch.

idinteger

Unique ID of the product to fetch. This id is assigned by Capillary when each product is added to the Capillary server.

include_hierarchyboolean

Pass true to retrieve product hierarchy.

ou_codestring

Identifier code of the organisation.

fetch_type'ALL' | 'ORG' | 'SCOPE'

ALL - Fetches details of product associated with both master org and org unit. ORG-Fetches details of products associated with master ORG. SCOPE-Fetches details of products associated with an org unit.

Response

200

Example response

{
  "response": {
    "status": {
      "success": true,
      "code": 200,
      "message": "Success"
    },
    "product": {
      "item": [
        {
          "item_id": "27286097",
          "sku": "Pearls",
          "item_ean": "Pearls",
          "price": "200",
          "in_stock": "true",
          "description": "White",
          "added_on": "2019-09-18 12:40:36",
          "item_status": {
            "status": true,
            "code": 2100,
            "message": "Product retrieval successful"
          }
        }
      ]
    }
  }
}