Currency

PreviousConfig NextCustomer

Was this helpful?

Get currency

get

Get a currency.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

currencyUidstringrequired

Key to currency

Responses

application/json

objectoptional

get

GET /v2/tenants/{tenantUid}/currencies/{currencyUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "currencyUid": "text",
  "currencyCode": "text",
  "exchangeRate": 1,
  "createdAt": "2025-04-18T00:56:22.670Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-04-18T00:56:22.670Z",
  "lastModifiedBy": "text"
}

Delete currency

delete

Delete a currency.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

currencyUidstringrequired

Key to currency

Responses

delete

DELETE /v2/tenants/{tenantUid}/currencies/{currencyUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

List foreign currencies

get

List foreign currencies.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Query parameters

pageNumberintegeroptional

Reference to a specific page in a result set.

pageSizeintegeroptional

The number of items per page in a result set.

Responses

application/json

objectoptional

get

GET /v2/tenants/{tenantUid}/currencies HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "currencyUid": "text",
      "currencyCode": "text",
      "exchangeRate": 1,
      "createdAt": "2025-04-18T00:56:22.670Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-04-18T00:56:22.670Z",
      "lastModifiedBy": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Add currency

post

Add a currency with exchange rate. Currency codes follow the ISO 4217 standard. Exchange rates are entered as integers in cents (2 decimals).

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Body

currencyUidstringoptionalPattern: ^[A-Za-z0-9-_]*

currencyCodestringrequired

ISO 4217 standard

exchangeRateintegerrequired

in cents (2 decimals)

Responses

application/json

objectoptional

post

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
}

201

Example response

{
  "currencyUid": "text",
  "currencyCode": "text",
  "exchangeRate": 1,
  "createdAt": "2025-04-18T00:56:22.670Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-04-18T00:56:22.670Z",
  "lastModifiedBy": "text"
}

Update currency

put

Update a currency.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

currencyUidstringrequired

Key to currency

Body

currencyCodestringoptional

ISO 4217 standard

exchangeRateintegeroptional

in cents (2 decimals)

Responses

application/json

objectoptional

put

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
}

200

Example response

{
  "currencyUid": "text",
  "currencyCode": "text",
  "exchangeRate": 1,
  "createdAt": "2025-04-18T00:56:22.670Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-04-18T00:56:22.670Z",
  "lastModifiedBy": "text"
}