Skip to main content

Get all Currencies

GET 

https://useast.api.elasticpath.com/v2/currencies

Fetch all currencies.

Request

Query Parameters

    page[offset] string

    The number of records to offset the results by.

    page[limit] string

    The number of records per page.

Responses

OK

Schema
    data object[]
  • Array [
  • idstring

    The unique identifier for this currency.

    Example: 0c45e4ec-26e0-4043-86e4-c15b9cf985a0
    typestring

    Represents the type represents the object being returned.

    Example: currency
    codestring

    Specifies the currency code. For example, YEN.

    Example: GBP
    exchange_ratenumber

    Specifies the exchange rate from the default currency.

    Example: 1
    formatstring

    Specifies how the price currency is displayed. For example, "£{price}".

    Example: £{price}
    decimal_pointstring

    Indicates the decimal point character.

    Example: .
    thousand_separatorstring

    Indicates the thousand separator character.

    Example: ,
    decimal_placesnumber

    Indicates how many decimal places the currency is formatted to.

    Example: 2
    defaultboolean

    Specifies whether this is the default currency or not. Either true or false.

    Example: true
    enabledboolean

    Specifies if this currency is available for products. Either true or false.

    Example: true
    links object
    selfstring

    Specifies the URL of this currency.

    meta object
    timestamps object
    created_atstring

    Indicates the creation date of this currency.

    Example: 2023-11-07T23:04:18.845Z
    updated_at

    Indicates the updated date of this currency.

    Example: 2023-11-07T23:04:18.845Z
    ownerstring

    Indicates whether the owner is store or org.

    Example: store
  • ]

Authorization: http

name: bearerAuthtype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://useast.api.elasticpath.com/v2/currencies");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://useast.api.elasticpath.com
Auth
Parameters
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!