Product currencies
Use these methods to obtain information about the available product currencies.
GET[host]/api/v2/my/products/currencies |
|
GET[host]/api/v2/my/products/currencies/{currencyId} |
Get a list of product currencies
Use this method to obtain a list of the available product currencies. A response includes only enabled product currencies.
Request
Header parameters:
Authorization: Bearer <token>
Query parameters:
The following filter parameter is available for this method:
- alphabeticCode
The alphabetic code of a currency (such as
USD).
The following sorting parameter is available for this method:
- createTime
The date and time when a currency was added to a product.
Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.
GET[host]/api/v2/my/products/currencies
curl --location -g --request GET 'https://host.name/api/v2/my/products/currencies?limit=10&offset=0&sort_order=desc&sort_by=createTime&filter[alphabeticCode]=USD' \
--header 'Authorization: Bearer <token>'
Response
A response includes an array of Product Currency objects providing information about the product currencies matching the request parameters.
Get product currency details
Use this method to obtain detailed information about a specified product currency.
Request
Header parameters:
Authorization: Bearer <access_token>
Path parameters:
- currencyId required
The identifier of a product currency.
GET[host]/api/v2/my/products/currencies/{currencyId}
curl --location --request GET 'https://host.name/api/v2/my/products/currencies/1' \
--header 'Authorization: Bearer <token>'
Response
A response contains a Product Currency object providing information about the specified product currency.