Currency
Currency
List foreign currencies.
Accesstoken recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Example response
GET /v2/tenants/{tenantUid}/currencies HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"currencyUid": "text",
"currencyCode": "text",
"exchangeRate": 1,
"createdAt": "2025-11-13T01:52:55.962Z",
"createdBy": "text",
"lastModifiedAt": "2025-11-13T01:52:55.962Z",
"lastModifiedBy": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Add a currency with exchange rate. Currency codes follow the ISO 4217 standard. Exchange rates are entered as integers in cents (2 decimals).
Accesstoken recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]*ISO 4217 standard
in cents (2 decimals)
Example response
POST /v2/tenants/{tenantUid}/currencies HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61
{
"currencyUid": "text",
"currencyCode": "text",
"exchangeRate": 1
}Example response
{
"currencyUid": "text",
"currencyCode": "text",
"exchangeRate": 1,
"createdAt": "2025-11-13T01:52:55.962Z",
"createdBy": "text",
"lastModifiedAt": "2025-11-13T01:52:55.962Z",
"lastModifiedBy": "text"
}Get a currency.
Accesstoken recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Key to currency
Example response
GET /v2/tenants/{tenantUid}/currencies/{currencyUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"currencyUid": "text",
"currencyCode": "text",
"exchangeRate": 1,
"createdAt": "2025-11-13T01:52:55.962Z",
"createdBy": "text",
"lastModifiedAt": "2025-11-13T01:52:55.962Z",
"lastModifiedBy": "text"
}Update a currency.
Accesstoken recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Key to currency
ISO 4217 standard
in cents (2 decimals)
Example response
PUT /v2/tenants/{tenantUid}/currencies/{currencyUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"currencyCode": "text",
"exchangeRate": 1
}Example response
{
"currencyUid": "text",
"currencyCode": "text",
"exchangeRate": 1,
"createdAt": "2025-11-13T01:52:55.962Z",
"createdBy": "text",
"lastModifiedAt": "2025-11-13T01:52:55.962Z",
"lastModifiedBy": "text"
}Delete a currency.
Accesstoken recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Key to currency
No Content
DELETE /v2/tenants/{tenantUid}/currencies/{currencyUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Last updated
Was this helpful?