List currencies

GET/v1/api/store/{team_slug}/setting/currency

v1Operation ID v1_public_currency_index

Returns the team's currencies in one list. Deleted currencies are left out.

YoPrint works in one currency per team: the default currency. Its symbol appears on PDFs, emails and formatted amounts (such as formatted_calc_total), and its iso code is sent to integrations such as QuickBooks and Shopify. A new sales order records the default currency when it is created, and YoPrint doesn't convert between currencies.

The team's first currency is its default. No operation changes the default: default in a request is ignored.

Permission

Any team member can call it. Reading needs no extra permission.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (6)

  • defaultbooleanrequired

    Whether it is the team's currency.

  • idstringrequired
  • isostringrequired

    The three-letter ISO 4217 code, in capitals.

  • namestringrequired
  • symbolstringrequired
  • trashedbooleanrequired
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

Notes

• The currency with default: true is the one YoPrint uses.

Related

• PATCHUpdate a currency without checks/v1/api/store/{team_slug}/setting/currency/{hash_id}

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/setting/currency' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": [
    {
      "default": true,
      "id": "Y3WvW4mbyTw1sO",
      "iso": "USD",
      "name": "US Dollar",
      "symbol": "$",
      "trashed": false
    }
  ],
  "status": 200,
  "success": true
}