> 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 Shop

GET https://api.papertracc.com/v1/store/shop

Returns the sales channel named in the `channel` header: its name, default currency, the countries it sells to and whether shoppers can pay online. Call it once to confirm your key, workspace and channel line up.

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

Reference: https://api-docs.papertracc.com/storefront/shop/get-shop

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

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

### Shop

- `name` (string, required) — Channel name.
- `handle` (string, required) — Channel handle, the value sent in the `channel` header.
- `description` (string, required, nullable)
- `currency` (string, required) — Currency of the channel's default price book.
- `countries` (list of Country, required) — Markets the channel sells to. One is the default.
- `checkout` (ShopCheckout, required) — Whether shoppers can pay for their orders online.

### Country

- `country_code` (string, required) — Three-letter ISO 3166-1 alpha-3 code of a market this channel sells to.
- `is_default` (boolean, required)

### ShopCheckout

Whether shoppers can pay for their orders online.

- `enabled` (boolean, required) — `true` when the workspace takes payment online through Papertracc Checkout for this channel's currency. Orders placed while it is on come back with a `checkout_url`.
- `methods` (list of enum, required) — How the shopper can pay on the checkout page. Empty when `enabled` is `false`.
  - Allowed values: `BANK_TRANSFER`
- `layaway` (list of LayawayTerm, required) — Instalment plans shoppers can choose at checkout. Empty when the channel offers no layaway or `enabled` is `false`. Call Get Layaway Options for the amounts on a cart.
- `layaway_minimum` (string, required, nullable) — Smallest order total that can be paid in instalments, as a decimal string. `null` when there is no minimum.

### LayawayTerm

An instalment plan the channel offers.

- `id` (string, required) — Send as `layaway_term_id` on Checkout Cart.
- `name` (string, required)
- `release_instalment` (integer, required) — The payment after which the store releases the goods (1 = after the first).
- `instalments` (list of LayawayTermInstalment, required)

### LayawayTermInstalment

- `type` (enum, required) — Whether `value` is a percentage of the order total or a fixed amount.
  - Allowed values: `PERCENTAGE_RATE`, `FLAT_RATE`
- `value` (string, required) — Decimal string.
- `net_days` (integer, required) — Days after the order date that this payment is due.

## Examples

**Response**

```json
{
  "status": true,
  "message": "Successfully fetched shop",
  "data": {
    "name": "Acme Web Store",
    "handle": "web",
    "description": "string",
    "currency": "NGN",
    "countries": [
      {
        "country_code": "NGA",
        "is_default": true
      }
    ],
    "checkout": {
      "enabled": true,
      "methods": [
        "BANK_TRANSFER"
      ],
      "layaway": [
        {
          "id": "string",
          "name": "Three monthly payments",
          "release_instalment": 2,
          "instalments": [
            {
              "type": "PERCENTAGE_RATE",
              "value": "40",
              "net_days": 30
            }
          ]
        }
      ],
      "layaway_minimum": "50000.00"
    }
  }
}
```

**SDK Code**

```python
import requests

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

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

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

print(response.json())
```

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

	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/shop")

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

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

```csharp
using RestSharp;

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