Get Shop | Papertracc Docs

{
  "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"
    }
  }
}

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring

The identity for the active workspace.

Response

Successfully fetched shop

statusboolean

Always true on success.

messagestring

Human-readable outcome.

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

404

Not Found Error

Authentication

Headers

Response

Errors