Country
The Country API endpoints allow fetching supported countries and their allowed currencies, payment methods and shipping methods from a store.
Gets all the Countries in a Store
GET/umbraco/commerce/storefront/api/v1/countries
Query parameters
Header parameters
Response
Success
Body
idstring (uuid)
codestring
namenullable string
defaultCurrencyCurrencyReferenceDto (object)
defaultPaymentMethodPaymentMethodReferenceDto (object)
defaultShippingMethodShippingMethodReferenceDto (object)
regionsnullable array of RegionReferenceDto (object)
Request
Response
Gets a Country by ID or Alias
GET/umbraco/commerce/storefront/api/v1/country/{idOrAlias}
Path parameters
idOrAlias*string
The ID or the alias of the given resource
Query parameters
Header parameters
Response
Success
Body
idstring (uuid)
codestring
namenullable string
defaultCurrencyCurrencyReferenceDto (object)
defaultPaymentMethodPaymentMethodReferenceDto (object)
defaultShippingMethodShippingMethodReferenceDto (object)
regionsnullable array of RegionReferenceDto (object)
Request
Response
Gets the Currencies allowed in a Country
GET/umbraco/commerce/storefront/api/v1/country/{idOrAlias}/currencies
Path parameters
idOrAlias*string
The ID or the alias of the given resource
Query parameters
Header parameters
Response
Success
Body
idstring (uuid)
codestring
namenullable string
culturenullable string
formatTemplatenullable string
allowedCountriesnullable array of AllowedCountryDto (object)
Request
Response
Gets the Payment Methods allowed in a Country
GET/umbraco/commerce/storefront/api/v1/country/{idOrAlias}/paymentmethods
Path parameters
idOrAlias*string
The ID or the alias of the given resource
Query parameters
Header parameters
Response
Success
Body
idstring (uuid)
aliasstring
namenullable string
skunullable string
taxClassTaxClassReferenceDto (object)
paymentProviderAliasnullable string
pricePriceDto (object)
imageUrlnullable string
Request
Response
Gets the Shipping Methods allowed in a Country
GET/umbraco/commerce/storefront/api/v1/country/{idOrAlias}/shippingmethods
Path parameters
idOrAlias*string
The ID or the alias of the given resource
Query parameters
Header parameters
Response
Success
Body
idstring (uuid)
aliasstring
namenullable string
skunullable string
taxClassTaxClassReferenceDto (object)
pricePriceDto (object)
imageUrlnullable string
Request
Response
Gets the Payment Methods allowed in a Region
GET/umbraco/commerce/storefront/api/v1/country/{countryIdOrAlias}/region/{regionIdOrAlias}/paymentmethods
Path parameters
countryIdOrAlias*string
The ID or the alias of the country resource
regionIdOrAlias*string
The ID or the alias of the region resource
Query parameters
Header parameters
Response
Success
Body
idstring (uuid)
aliasstring
namenullable string
skunullable string
taxClassTaxClassReferenceDto (object)
paymentProviderAliasnullable string
pricePriceDto (object)
imageUrlnullable string
Request
Response
Gets the Payment Methods allowed in a Region
GET/umbraco/commerce/storefront/api/v1/country/{countryIdOrAlias}/region/{regionIdOrAlias}/paymentmethods
Path parameters
countryIdOrAlias*string
The ID or the alias of the country resource
regionIdOrAlias*string
The ID or the alias of the region resource
Query parameters
Header parameters
Response
Success
Body
idstring (uuid)
aliasstring
namenullable string
skunullable string
taxClassTaxClassReferenceDto (object)
paymentProviderAliasnullable string
pricePriceDto (object)
imageUrlnullable string
Request
Response
Last updated