Skip to main content
Vindicia Knowledge Center

Fetch a specific product

Fetch a specific product

Retrieves a specific Product.

Route (URL) Parameters

Parameter Default Description Required
product n/a The id or the vid of the Product to retrieve Yes

Query Parameters

None.

Accepts

None.

Returns

JSON A full Product object.

  • cURL
  • Java
Example Request
curl -X GET \
-u acaff38d462f9430d5cbcbaf:a575771fc679b9de \
"https://api.prodtest.vindicia.com/products/prod_1234"
The above command returns JSON structured like this:
{
    "object": "Product",
    "id": "prod_1234",
    "vid": "190828347a650eeca011ac8a6be550416d4cf9a0",
    "created": "2016-05-15T23:45:06-07:00",

    "descriptions": {
        "object": "List",
        "data": [
            {
            "object": "ProductDescription",
            "language": "EN",
            "description": "prod_1234"
            }
        ],
        "total_count": 1
    },

    "status": "Active",
    "tax_classification": "DownloadableElectronicData",

    "default_billing_plan": {`...`},

    "metadata": {
        "COA_CODE": "GNGX102"
    },

    "entitlements": {`...`},
    "credit_granted": {`...`},

    "prices": {
        "object": "List",
        "data": [
            {
            "object": "ProductPrice",
            "amount": 2,
            "currency": "USD"
            }
        ],
        "total_count": 1
    }
}
import com.vindicia.client.CashBox;

CashBox.apiKey = "acaff38d462f9430d5cbcbafa575771fc679b9de";

Product.fetch("prod_1234");
The above command returns JSON structured like this:
{
    "object": "Product",
    "id": "prod_1234",
    "vid": "190828347a650eeca011ac8a6be550416d4cf9a0",
    "created": "2016-05-15T23:45:06-07:00",

    "descriptions": {
        "object": "List",
        "data": [
            {
            "object": "ProductDescription",
            "language": "EN",
            "description": "prod_1234"
            }
        ],
        "total_count": 1
    },

    "status": "Active",
    "tax_classification": "DownloadableElectronicData",

    "default_billing_plan": {`...`},

    "metadata": {
        "COA_CODE": "GNGX102"
    },

    "entitlements": {`...`},
    "credit_granted": {`...`},

    "prices": {
        "object": "List",
        "data": [
            {
            "object": "ProductPrice",
            "amount": 2,
            "currency": "USD"
            }
        ],
        "total_count": 1
    }
}

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top