> 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 Request Form

GET https://api.papertracc.com/v1/store/requests/form

Returns the store's custom request form: the questions to ask when the shopper wants something that is not in the catalogue. Returns `404` when the store does not take custom requests. A product's own form comes with Get Product as `request_form`.

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

Reference: https://api-docs.papertracc.com/storefront/requests/get-request-form

## 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)

## Response

### 200

Successfully fetched request form

- `status` (boolean, required) — Always `true` on success.
- `message` (string, required) — Human-readable outcome.
- `data` (RequestForm, 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

### 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.

### 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 request form",
  "data": {
    "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
    }
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.papertracc.com/v1/store/requests/form"

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

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

print(response.json())
```

```javascript
const url = 'https://api.papertracc.com/v1/store/requests/form';
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/requests/form"

	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/requests/form")

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/requests/form")
  .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/requests/form', [
  'headers' => [
    'Authorization' => 'Bearer <apiKey>',
    'channel' => 'channel',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.papertracc.com/v1/store/requests/form");
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/requests/form")! 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()
```