> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api-docs.papertracc.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api-docs.papertracc.com/_mcp/server.

# Get Product

GET https://api.papertracc.com/v1/store/products/{handle}

Returns one product with its options, images, every variant's price and availability, and its average rating.

**Keys:** public key or secret key.

Reference: https://api-docs.papertracc.com/storefront/catalogue/products/get-product

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.
- `identity` header (required) — The identity for the active workspace.

## Servers

- `https://api.papertracc.com/v1` (Production, default)
- `https://api.papertracc.com/rc-1` (Release Candidate 1)

## Request

### Path parameters

- `handle` (string, required) — The record's handle.

### Query parameters

- `country` (string, optional) — Market to price for, as a two- or three-letter country code (`NG` or `NGA`). Defaults to the channel's default country.

## Response

### 200

Successfully fetched product

- `status` (boolean, required) — Always `true` on success.
- `message` (string, required) — Human-readable outcome.
- `data` (Product, required)

## Errors

### 400 Bad Request Error

The `channel` header is missing, the body is not valid JSON, or a field failed validation.

- `status` (boolean, required) — Always `false` on a failed request.
- `message` (string, required) — What went wrong, written for the shopper or the developer.
- `error_code` (string, optional) — Present on `402` responses.

### 401 Unauthorized Error

The API key is missing or invalid, the key owner is no longer an active member of the organisation, or the key owner is not a member of the workspace in the `identity` header.

- `status` (boolean, required) — Always `false` on a failed request.
- `message` (string, required) — What went wrong, written for the shopper or the developer.
- `error_code` (string, optional) — Present on `402` responses.

### 402 Payment Required Error

The workspace's subscription plan does not include the Open API.

- `status` (boolean, required) — Always `false` on a failed request.
- `message` (string, required) — What went wrong, written for the shopper or the developer.
- `error_code` (string, optional) — Present on `402` responses.

### 404 Not Found Error

The sales channel, or the record the request names, does not exist or is not published to this channel.

- `status` (boolean, required) — Always `false` on a failed request.
- `message` (string, required) — What went wrong, written for the shopper or the developer.
- `error_code` (string, optional) — Present on `402` responses.

## Types

### Product

- `id` (string, required)
- `handle` (string, required) — URL-safe identifier.
- `title` (string, required) — Product title.
- `description` (string, required, nullable) — HTML description.
- `vendor` (string, required, nullable)
- `product_type` (string, required, nullable)
- `tags` (list of string, required)
- `options` (list of ProductOption, required)
- `images` (list of Image, required)
- `seo` (Seo, required) — Search and social metadata.
- `price` (PriceRange, required)
- `available` (boolean, required)
- `variants` (list of Variant, required)
- `kind` (enum, required)
  - Allowed values: `GOODS`, `SERVICE`
- `price_on_request` (boolean, required)
- `requestable` (boolean, required) — Show a request button: the product is sold through order requests (its form is in `REQUEST` mode) or has an open price. Send the request with Create Request.
- `request_form` (RequestForm, required, nullable) — The questions to ask about this product. In `BUY_NOW` mode send the answers on the cart item; in `REQUEST` mode send them on Create Request. `null` when the product has no form.
- `rating` (Rating, required) — Average of the approved reviews.

### ProductOption

- `name` (string, required) — Option name.
- `values` (list of string, required)

### Image

- `id` (string, required)
- `src` (string, required) — Absolute image URL.
- `alt` (string, required) — Alternative text. Falls back to the file name.
- `type` (string, required) — Media type.
- `width` (integer, required) — Width in pixels, `0` when unknown.
- `height` (integer, required) — Height in pixels, `0` when unknown.

### Seo

Search and social metadata.

- `title` (string, required, nullable)
- `description` (string, required, nullable)
- `image` (string, required, nullable)

### PriceRange

- `currency` (string, required) — ISO 4217 code.
- `min_price` (string, required) — Decimal amount as a string, in the currency shown alongside it.
- `max_price` (string, required) — Decimal amount as a string, in the currency shown alongside it.
- `compare_at_min_price` (string, required, nullable) — Original price of the cheapest variant when it is on sale.

### Variant

- `id` (string, required) — Send this as `variant_id` when adding to a cart.
- `title` (string, required) — Variant title.
- `sku` (string, required) — Stock keeping unit.
- `options` (list of VariantOption, required)
- `currency` (string, required) — ISO 4217 code.
- `price` (string, required) — Decimal amount as a string, in the currency shown alongside it.
- `compare_at_price` (string, required, nullable)
- `available` (boolean, required)
- `image` (Image, required, nullable)
- `selling_unit` (string, required) — Unit the variant is sold in.
- `quantity_step` (string, required) — Smallest increment a quantity can change by.
- `unit_price` (UnitPrice, required, nullable) — Price per reference measure, for example per kilogram.
- `price_on_request` (boolean, required)
- `duration_minutes` (integer, required, nullable) — Length of a timed service.
- `condition` (enum, required) — Condition of this variant. Variants with the same options can be offered in more than one condition; each has its own id, price and stock.
  - Allowed values: `NEW`, `LOWER_GRADE`, `OPEN_BOX`, `USED`, `REFURBISHED`
- `condition_label` (string, required) — Condition as shown to shoppers.
- `condition_note` (string, required, nullable) — What is different about units in this condition, written by the merchant.
- `sell_mode` (enum, required) — How this variant sells right now. `STOCK` sells from stock, and is sold out when `available` is `false`. `BACKORDER` is out of stock but can still be bought, and ships when stock arrives. `PREORDER` is not released yet and ships from `release_date`. `MADE_TO_ORDER` is made or sourced after the order and is ready `lead_time_days` later. A backorder only shows as `BACKORDER` while the variant is out of stock, and a pre-order becomes `STOCK` on its release date.
  - Allowed values: `STOCK`, `BACKORDER`, `PREORDER`, `MADE_TO_ORDER`
- `lead_time_days` (integer, required, nullable) — Days from the order until it ships (`BACKORDER`) or is ready (`MADE_TO_ORDER`). `null` when the merchant has not set one, and for `STOCK` and `PREORDER`.
- `release_date` (date, required, nullable) — Date a pre-order ships from. Set only when `sell_mode` is `PREORDER`.

### RequestForm

- `id` (string, required) — Pass it as `form_id` to Get Request Availability.
- `name` (string, required)
- `intro` (string, required, nullable) — Text to show above the questions.
- `fields` (list of RequestField, required)
- `mode` (enum, required) — `REQUEST`: the shopper sends a request with Create Request and the merchant replies with a price. `BUY_NOW`: the shopper answers the questions and adds the product to the cart, with `answers` and `needed_by` on the cart item.
  - Allowed values: `REQUEST`, `BUY_NOW`
- `deposit_percent` (double, required, nullable) — Share of the price the merchant asks for up front, from 0 to 100. Informational.
- `limited` (boolean, required) — The merchant takes a limited number of orders per day. Use Get Request Availability to grey out full days.
- `layaway` (LayawayPlan, optional, nullable) — Set when the store offers to take payment in instalments for this request (layaway). The store quotes the price later; the plan shows how payments are spread and when the goods are released.

### Rating

Average of the approved reviews.

- `average` (string, required) — Average approved rating to one decimal place. `0.0` when there are no reviews.
- `count` (integer, required) — Approved reviews.

### VariantOption

- `name` (string, required) — Option name.
- `value` (string, required) — Chosen value.

### UnitPrice

Price per reference measure, for example per kilogram.

- `amount` (string, required) — Decimal amount as a string, in the currency shown alongside it.
- `quantity_value` (string, required) — Size of one selling unit.
- `quantity_unit` (string, required) — Unit of `quantity_value`.
- `reference_value` (string, required) — Size the unit price is quoted for.
- `reference_unit` (string, required) — Unit of `reference_value`.

### RequestField

One question on a request form. Answer it with an item in `answers` whose `key` matches.

- `key` (string, required) — Send it back as the answer's `key`.
- `type` (enum, required) — Which answer field to send: `choices` for `CHOICE`, `text` for `TEXT` and `LONG_TEXT`, `number` for `NUMBER`, `yes` for `YES_NO`, `measurements` and `unit` for `MEASUREMENTS`, and `files` for `PHOTO`.
  - Allowed values: `CHOICE`, `TEXT`, `LONG_TEXT`, `NUMBER`, `YES_NO`, `MEASUREMENTS`, `PHOTO`
- `label` (string, required) — Question to show.
- `help` (string, required, nullable) — Hint to show under the question.
- `image` (string, required, nullable) — Picture URL to show with the question.
- `required` (boolean, required) — The request or cart line is refused without an answer.
- `multiple` (boolean, required) — For `CHOICE`: more than one option can be chosen.
- `options` (list of RequestFieldOption, required) — Choices for `CHOICE`. Empty for other types.
- `measurements` (list of RequestFieldMeasurement, required) — Measurements to ask for on `MEASUREMENTS`. Empty for other types.
- `max_length` (integer, required, nullable) — Longest answer for `TEXT` and `LONG_TEXT`, in characters.
- `min` (double, required, nullable) — Lowest answer for `NUMBER`.
- `max` (double, required, nullable) — Highest answer for `NUMBER`.
- `unit` (string, required, nullable) — Unit shown beside a `NUMBER` answer.
- `max_files` (integer, required, nullable) — Most pictures for `PHOTO`, from 1 to 5.

### LayawayPlan

- `name` (string, required) — The plan's name, e.g. "Three monthly payments".
- `instalments` (integer, required) — Number of payments.
- `release_instalment` (integer, required) — The payment after which the store releases the goods (1 = after the first).
- `days` (integer, required) — Days from the order date to the last payment.

### RequestFieldOption

- `label` (string, required) — Text to show, and the value to send back in `choices`.
- `image` (string, required, nullable) — Picture URL for the option.
- `prices` (list of RequestOptionPrice, required) — Extra charge per currency when the option is chosen. Empty when the option is free. On a `BUY_NOW` form the cart adds it to the line as `add_on`.

### RequestFieldMeasurement

- `label` (string, required) — Measurement to ask for.
- `required` (boolean, required)

### RequestOptionPrice

- `currency_code` (string, required) — ISO 4217 currency code.
- `rate` (string, required) — Extra charged for choosing this option, as a decimal string in `currency_code`.

## Examples

**Response**

```json
{
  "status": true,
  "message": "Successfully fetched product",
  "data": {
    "id": "string",
    "handle": "silk-scarf",
    "title": "Silk scarf",
    "description": "string",
    "vendor": "string",
    "product_type": "string",
    "tags": [
      "string"
    ],
    "options": [
      {
        "name": "Colour",
        "values": [
          "string"
        ]
      }
    ],
    "images": [
      {
        "id": "string",
        "src": "https://cdn.papertracc.com/projects/acme/products/silk-scarf.jpg",
        "alt": "Blue silk scarf",
        "type": "image",
        "width": 1,
        "height": 1
      }
    ],
    "seo": {
      "title": "string",
      "description": "string",
      "image": "string"
    },
    "price": {
      "currency": "NGN",
      "min_price": "25000.00",
      "max_price": "32000.00",
      "compare_at_min_price": "string"
    },
    "available": true,
    "variants": [
      {
        "id": "string",
        "title": "Blue",
        "sku": "SCARF-BLUE",
        "options": [
          {
            "name": "Colour",
            "value": "Blue"
          }
        ],
        "currency": "NGN",
        "price": "25000.00",
        "compare_at_price": "string",
        "available": true,
        "image": {
          "id": "string",
          "src": "https://cdn.papertracc.com/projects/acme/products/silk-scarf.jpg",
          "alt": "Blue silk scarf",
          "type": "image",
          "width": 1,
          "height": 1
        },
        "selling_unit": "EACH",
        "quantity_step": "1",
        "unit_price": {
          "amount": "5000.00",
          "quantity_value": "500",
          "quantity_unit": "G",
          "reference_value": "1",
          "reference_unit": "KG"
        },
        "price_on_request": true,
        "duration_minutes": 1,
        "condition": "NEW",
        "condition_label": "New",
        "condition_note": "Small mark on the left sleeve",
        "sell_mode": "STOCK",
        "lead_time_days": 14,
        "release_date": "2026-12-12"
      }
    ],
    "kind": "GOODS",
    "price_on_request": true,
    "requestable": true,
    "request_form": {
      "id": "string",
      "name": "Custom outfit",
      "intro": "string",
      "fields": [
        {
          "key": "fabric",
          "type": "CHOICE",
          "label": "Fabric",
          "help": "string",
          "image": "string",
          "required": true,
          "multiple": true,
          "options": [
            {
              "label": "Gold embroidery",
              "image": "string",
              "prices": [
                {
                  "currency_code": "NGN",
                  "rate": "5000"
                }
              ]
            }
          ],
          "measurements": [
            {
              "label": "Chest",
              "required": true
            }
          ],
          "max_length": 1,
          "min": 1.1,
          "max": 1.1,
          "unit": "pieces",
          "max_files": 1
        }
      ],
      "mode": "REQUEST",
      "deposit_percent": 1.1,
      "limited": true,
      "layaway": {
        "name": "string",
        "instalments": 1,
        "release_instalment": 1,
        "days": 1
      }
    },
    "rating": {
      "average": "4.5",
      "count": 1
    }
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.papertracc.com/v1/store/products/handle"

headers = {
    "channel": "channel",
    "Authorization": "Bearer <apiKey>"
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.papertracc.com/v1/store/products/handle';
const options = {method: 'GET', headers: {channel: 'channel', Authorization: 'Bearer <apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.papertracc.com/v1/store/products/handle"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("channel", "channel")
	req.Header.Add("Authorization", "Bearer <apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.papertracc.com/v1/store/products/handle")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["channel"] = 'channel'
request["Authorization"] = 'Bearer <apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.papertracc.com/v1/store/products/handle")
  .header("channel", "channel")
  .header("Authorization", "Bearer <apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.papertracc.com/v1/store/products/handle', [
  'headers' => [
    'Authorization' => 'Bearer <apiKey>',
    'channel' => 'channel',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.papertracc.com/v1/store/products/handle");
var request = new RestRequest(Method.GET);
request.AddHeader("channel", "channel");
request.AddHeader("Authorization", "Bearer <apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "channel": "channel",
  "Authorization": "Bearer <apiKey>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.papertracc.com/v1/store/products/handle")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```