Get Product Details

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response Parameters

ParameterDatatypeDescription
item\_idlongUnique ID of the product generated by the system.
skustringSKU of the product.
item\_eanstringEuropean article number of the product.
pricedoublePrice of the product.
in\_stockbooleanShows true if the item product is available, else shows false.
descriptionstringBrief description of the product.
long\_descriptionstringDetailed description of the product as in the database.
img\_urlstringURL of the product image.
attributesobjAttributes of the product in name-value pairs.
added\_ondate-timeDate and time of the product addition.
sizeobjSize of the product in name:value pairs.
stylestringProduct style in name:value pairs.
brandstringBrand name (as per the database) of the product.
colorobjColor of the product (as per the database) .
categoryobjParent category name of the product (as per the database).
ou\_idintegerIndicates the ID of the OU. -1 indicates that the product belongs to a master org. This is applicable only if OU support for product inventory is enabled.
Query Params
string

SKU code of the product to fetch.

int64

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

boolean

Pass true to retrieve product hierarchy.

string

Identifier code of the organisation.

string
enum

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.

Allowed:
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json