Country

The Country API endpoints allow fetching supported countries and their allowed currencies, payment methods and shipping methods from a store.

PreviousCurrency NextPayment method

Last updated 9 months ago

Was this helpful?

Gets all the Countries in a Store

get

/umbraco/commerce/storefront/api/v1/countries

Query parameters

filterstring

Filter the returned list of items

Example: {"value":" "}

expandstring

Defines the properties that should be expanded in the response

Example: {"value":" "}

fieldsstring

Limit the properties returned in the response

Example: {"value":" "}

Header parameters

Api-Keystringrequired

API key specified through configuration to authorize access to the API.

Storestringrequired

The ID or the alias of the store

Example: {"value":"aaaee3a8-262b-468a-9850-cd3070f96276"}

Current-Orderstring · uuid

The ID of the current order associated with the current session

Example: 3939a415-ce07-462b-ae10-7e965e2e8e5c

Billing-Countrystring

The ID or alias of the session default billing country

Example: {"value":"b8fa37cd-d163-43dc-bf66-c0da215a4434"}

Billing-Regionstring

The ID or alias of the session default billing region

Example: {"value":"2afb85ce-71c5-4463-9433-d49ae13a2ed6"}

Shipping-Countrystring

The ID or alias of the session default shipping country

Example: {"value":"9037c567-8494-462f-aca9-cafd14b2b8f3"}

Shipping-Regionstring

The ID or alias of the session default shipping region

Example: {"value":"c0ffff68-4173-4d97-ad29-99634f67fb97"}

Tax-Classstring

The ID or alias of the session default tax class

Example: {"value":"46009e99-ef4e-4a28-8c8b-81f1a048244e"}

Currencystring

The ID or alias of the session currency

Example: {"value":"a9e6b7d6-6259-4d5d-816c-4cb6ebe06295"}

Accept-Languagestring

The ISO culture code of the current session culture

Example: en-US

Customer-Referencestring

The unique reference for the customer associated with the current session

Example: cust_b1a82255-000f-4954-9f04-393258d7b5f4

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/umbraco/commerce/storefront/api/v1/countries' \
  --header 'Api-Key: text' \
  --header 'Store: text'

200

404

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "name": "text",
    "defaultCurrency": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "text"
    },
    "defaultPaymentMethod": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text"
    },
    "defaultShippingMethod": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text"
    },
    "regions": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text"
      }
    ]
  }
]

Success

Gets a Country by ID or Alias

get

/umbraco/commerce/storefront/api/v1/country/{idOrAlias}

Path parameters

idOrAliasstringrequired

The ID or the alias of the given resource

Example: {"value":"7540acb8-4650-46d2-9ae9-988d611a4da2"}

Query parameters

expandstring

Defines the properties that should be expanded in the response

Example: {"value":" "}

fieldsstring

Limit the properties returned in the response

Example: {"value":" "}

Header parameters

Api-Keystringrequired

API key specified through configuration to authorize access to the API.

Storestringrequired

The ID or the alias of the store

Example: {"value":"39dd640b-fe70-45b7-94fc-bfa3d01785df"}

Current-Orderstring · uuid

The ID of the current order associated with the current session

Example: 5f6f4cf6-8a75-464c-9f91-2956b470058e

Billing-Countrystring

The ID or alias of the session default billing country

Example: {"value":"1caff81a-a59b-45af-9879-7ba5871cb536"}

Billing-Regionstring

The ID or alias of the session default billing region

Example: {"value":"8fe3ad9f-eead-4e1f-8556-52b590917cdd"}

Shipping-Countrystring

The ID or alias of the session default shipping country

Example: {"value":"8007ae4b-8a48-477c-beec-11577ce6bd9e"}

Shipping-Regionstring

The ID or alias of the session default shipping region

Example: {"value":"374d22a3-501c-47f4-bcc3-d22addaccabe"}

Tax-Classstring

The ID or alias of the session default tax class

Example: {"value":"0c0b0b74-ea44-40e0-9894-c75b98968eb3"}

Currencystring

The ID or alias of the session currency

Example: {"value":"36ef13cc-b9db-49b8-a5d1-2e26afebd456"}

Accept-Languagestring

The ISO culture code of the current session culture

Example: en-US

Customer-Referencestring

The unique reference for the customer associated with the current session

Example: cust_72224c93-8b0d-4e60-bb6f-e8f4923422d0

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/umbraco/commerce/storefront/api/v1/country/{idOrAlias}' \
  --header 'Api-Key: text' \
  --header 'Store: text'

200

404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "code": "text",
  "name": "text",
  "defaultCurrency": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text"
  },
  "defaultPaymentMethod": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "alias": "text"
  },
  "defaultShippingMethod": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "alias": "text"
  },
  "regions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "text"
    }
  ]
}

Success

Gets the Currencies allowed in a Country

get

/umbraco/commerce/storefront/api/v1/country/{idOrAlias}/currencies

Path parameters

idOrAliasstringrequired

The ID or the alias of the given resource

Example: {"value":"1a4ad2a7-349b-47b2-bf4c-a1d7e1b8f063"}

Query parameters

expandstring

Defines the properties that should be expanded in the response

Example: {"value":" "}

fieldsstring

Limit the properties returned in the response

Example: {"value":" "}

Header parameters

Api-Keystringrequired

API key specified through configuration to authorize access to the API.

Storestringrequired

The ID or the alias of the store

Example: {"value":"ce04e0b5-8b72-484f-9d80-a58551cd61d9"}

Current-Orderstring · uuid

The ID of the current order associated with the current session

Example: 338b1ced-378a-4c68-a1bc-b71e5ea6a80c

Billing-Countrystring

The ID or alias of the session default billing country

Example: {"value":"c92f83d1-9148-44d1-a296-6abbe1dc0999"}

Billing-Regionstring

The ID or alias of the session default billing region

Example: {"value":"b07917b5-70d8-40fc-b35c-83a24fbda8e9"}

Shipping-Countrystring

The ID or alias of the session default shipping country

Example: {"value":"505d8dbf-7d46-4493-8989-cd6a972af6df"}

Shipping-Regionstring

The ID or alias of the session default shipping region

Example: {"value":"2dbaafcc-8b5c-454f-8c4c-e8b67d8761d1"}

Tax-Classstring

The ID or alias of the session default tax class

Example: {"value":"3f4cf70c-a93d-434f-940e-c9a92aa47094"}

Currencystring

The ID or alias of the session currency

Example: {"value":"2ab654d8-f683-48b7-b45d-2d3828805fce"}

Accept-Languagestring

The ISO culture code of the current session culture

Example: en-US

Customer-Referencestring

The unique reference for the customer associated with the current session

Example: cust_b93c2d78-1a50-4980-ab6e-718d6b13acc1

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/umbraco/commerce/storefront/api/v1/country/{idOrAlias}/currencies' \
  --header 'Api-Key: text' \
  --header 'Store: text'

200

404

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "name": "text",
    "culture": "text",
    "formatTemplate": "text",
    "allowedCountries": [
      {
        "country": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "code": "text"
        }
      }
    ]
  }
]

Success

Gets the Payment Methods allowed in a Country

get

/umbraco/commerce/storefront/api/v1/country/{idOrAlias}/paymentmethods

Path parameters

idOrAliasstringrequired

The ID or the alias of the given resource

Example: {"value":"80b94f39-9697-44e6-8ecb-1212ba074910"}

Query parameters

expandstring

Defines the properties that should be expanded in the response

Example: {"value":" "}

fieldsstring

Limit the properties returned in the response

Example: {"value":" "}

Header parameters

Api-Keystringrequired

API key specified through configuration to authorize access to the API.

Storestringrequired

The ID or the alias of the store

Example: {"value":"7bdc7462-97ae-425c-88ec-9fb5e479fc61"}

Current-Orderstring · uuid

The ID of the current order associated with the current session

Example: 3cf3c75e-777e-470d-af12-811bfb56decc

Billing-Countrystring

The ID or alias of the session default billing country

Example: {"value":"033fb3f7-9633-4b0d-9f76-47eec8b4e0db"}

Billing-Regionstring

The ID or alias of the session default billing region

Example: {"value":"2f0afc87-b993-49db-8dc2-3aa87691026e"}

Shipping-Countrystring

The ID or alias of the session default shipping country

Example: {"value":"be7376a4-135b-4211-965e-dd6b3a6da86a"}

Shipping-Regionstring

The ID or alias of the session default shipping region

Example: {"value":"9950a82a-9e7f-4d16-a444-9edbc9088ef5"}

Tax-Classstring

The ID or alias of the session default tax class

Example: {"value":"ac4e2892-ea4a-401f-b749-39bb971f1f94"}

Currencystring

The ID or alias of the session currency

Example: {"value":"64ea1e7f-c69a-4535-a1ce-3dade8d33cc6"}

Accept-Languagestring

The ISO culture code of the current session culture

Example: en-US

Customer-Referencestring

The unique reference for the customer associated with the current session

Example: cust_21d95084-2a0b-45e8-a619-9b2ed3e89eee

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/umbraco/commerce/storefront/api/v1/country/{idOrAlias}/paymentmethods' \
  --header 'Api-Key: text' \
  --header 'Store: text'

200

404

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "alias": "text",
    "name": "text",
    "sku": "text",
    "taxClass": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text"
    },
    "paymentProviderAlias": "text",
    "price": {
      "currency": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text"
      },
      "withoutTax": 1,
      "tax": 1,
      "withTax": 1,
      "formatted": {
        "withoutTax": "text",
        "tax": "text",
        "withTax": "text"
      }
    },
    "imageUrl": "text"
  }
]

Success

Gets the Shipping Methods allowed in a Country

get

/umbraco/commerce/storefront/api/v1/country/{idOrAlias}/shippingmethods

Path parameters

idOrAliasstringrequired

The ID or the alias of the given resource

Example: {"value":"d8b00204-3b3b-4bc0-a715-9aa1c01795c1"}

Query parameters

expandstring

Defines the properties that should be expanded in the response

Example: {"value":" "}

fieldsstring

Limit the properties returned in the response

Example: {"value":" "}

Header parameters

Api-Keystringrequired

API key specified through configuration to authorize access to the API.

Storestringrequired

The ID or the alias of the store

Example: {"value":"b16d136e-5b57-4812-b231-ad95fc473142"}

Current-Orderstring · uuid

The ID of the current order associated with the current session

Example: 691fa037-f27c-45a5-ac80-cb5c9ad5e6d5

Billing-Countrystring

The ID or alias of the session default billing country

Example: {"value":"46d309bb-258e-415b-a2db-1ef712c2c0aa"}

Billing-Regionstring

The ID or alias of the session default billing region

Example: {"value":"1060cb1a-ad6c-4b41-bd3b-3ecbc26ef531"}

Shipping-Countrystring

The ID or alias of the session default shipping country

Example: {"value":"09013686-7d5a-47dc-a52b-736366c0fc37"}

Shipping-Regionstring

The ID or alias of the session default shipping region

Example: {"value":"7f6298ed-aada-446e-b2f1-95ea60840bdc"}

Tax-Classstring

The ID or alias of the session default tax class

Example: {"value":"984db4a2-86b1-4c2b-96b1-60422d420be9"}

Currencystring

The ID or alias of the session currency

Example: {"value":"61cd7707-f12a-493c-93d7-aa76be7f6a42"}

Accept-Languagestring

The ISO culture code of the current session culture

Example: en-US

Customer-Referencestring

The unique reference for the customer associated with the current session

Example: cust_0ee595ef-93e8-449b-8cf3-bbc4364d4391

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/umbraco/commerce/storefront/api/v1/country/{idOrAlias}/shippingmethods' \
  --header 'Api-Key: text' \
  --header 'Store: text'

200

404

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "alias": "text",
    "name": "text",
    "sku": "text",
    "taxClass": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text"
    },
    "price": {
      "currency": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text"
      },
      "withoutTax": 1,
      "tax": 1,
      "withTax": 1,
      "formatted": {
        "withoutTax": "text",
        "tax": "text",
        "withTax": "text"
      }
    },
    "imageUrl": "text"
  }
]

Success

Gets the Payment Methods allowed in a Region

get

/umbraco/commerce/storefront/api/v1/country/{countryIdOrAlias}/region/{regionIdOrAlias}/paymentmethods

Path parameters

countryIdOrAliasstringrequired

The ID or the alias of the country resource

Example: {"value":"aaba32bf-030a-4698-9cc9-4331dcba8fa2"}

regionIdOrAliasstringrequired

The ID or the alias of the region resource

Example: {"value":"b3ea7224-dd02-4d20-8dc4-98704474751b"}

Query parameters

expandstring

Defines the properties that should be expanded in the response

Example: {"value":" "}

fieldsstring

Limit the properties returned in the response

Example: {"value":" "}

Header parameters

Api-Keystringrequired

API key specified through configuration to authorize access to the API.

Storestringrequired

The ID or the alias of the store

Example: {"value":"87aff01f-8d57-4198-a7e1-b951f2f0b637"}

Current-Orderstring · uuid

The ID of the current order associated with the current session

Example: 4cb7359e-aabd-474b-af9f-3842f141b46e

Billing-Countrystring

The ID or alias of the session default billing country

Example: {"value":"114305df-42cb-4b30-ad05-0609f035dadb"}

Billing-Regionstring

The ID or alias of the session default billing region

Example: {"value":"624c58a0-e840-4510-808c-8c17126e841d"}

Shipping-Countrystring

The ID or alias of the session default shipping country

Example: {"value":"5a98bf85-c567-493e-ad2d-0c2a42e93729"}

Shipping-Regionstring

The ID or alias of the session default shipping region

Example: {"value":"c537ad6d-c21b-46d9-a0f9-d3af308fb3e1"}

Tax-Classstring

The ID or alias of the session default tax class

Example: {"value":"37da8bae-7033-4277-9950-e413d8558a54"}

Currencystring

The ID or alias of the session currency

Example: {"value":"c53b28d6-8cca-402e-9dec-5c7fd6683d8c"}

Accept-Languagestring

The ISO culture code of the current session culture

Example: en-US

Customer-Referencestring

The unique reference for the customer associated with the current session

Example: cust_83a3d6aa-f5f8-4abb-827d-82286bdb6373

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/umbraco/commerce/storefront/api/v1/country/{countryIdOrAlias}/region/{regionIdOrAlias}/paymentmethods' \
  --header 'Api-Key: text' \
  --header 'Store: text'

200

404

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "alias": "text",
    "name": "text",
    "sku": "text",
    "taxClass": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text"
    },
    "paymentProviderAlias": "text",
    "price": {
      "currency": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text"
      },
      "withoutTax": 1,
      "tax": 1,
      "withTax": 1,
      "formatted": {
        "withoutTax": "text",
        "tax": "text",
        "withTax": "text"
      }
    },
    "imageUrl": "text"
  }
]

Success

Gets the Payment Methods allowed in a Region

get

/umbraco/commerce/storefront/api/v1/country/{countryIdOrAlias}/region/{regionIdOrAlias}/paymentmethods

Path parameters

countryIdOrAliasstringrequired

The ID or the alias of the country resource

Example: {"value":"aaba32bf-030a-4698-9cc9-4331dcba8fa2"}

regionIdOrAliasstringrequired

The ID or the alias of the region resource

Example: {"value":"b3ea7224-dd02-4d20-8dc4-98704474751b"}

Query parameters

expandstring

Defines the properties that should be expanded in the response

Example: {"value":" "}

fieldsstring

Limit the properties returned in the response

Example: {"value":" "}

Header parameters

Api-Keystringrequired

API key specified through configuration to authorize access to the API.

Storestringrequired

The ID or the alias of the store

Example: {"value":"87aff01f-8d57-4198-a7e1-b951f2f0b637"}

Current-Orderstring · uuid

The ID of the current order associated with the current session

Example: 4cb7359e-aabd-474b-af9f-3842f141b46e

Billing-Countrystring

The ID or alias of the session default billing country

Example: {"value":"114305df-42cb-4b30-ad05-0609f035dadb"}

Billing-Regionstring

The ID or alias of the session default billing region

Example: {"value":"624c58a0-e840-4510-808c-8c17126e841d"}

Shipping-Countrystring

The ID or alias of the session default shipping country

Example: {"value":"5a98bf85-c567-493e-ad2d-0c2a42e93729"}

Shipping-Regionstring

The ID or alias of the session default shipping region

Example: {"value":"c537ad6d-c21b-46d9-a0f9-d3af308fb3e1"}

Tax-Classstring

The ID or alias of the session default tax class

Example: {"value":"37da8bae-7033-4277-9950-e413d8558a54"}

Currencystring

The ID or alias of the session currency

Example: {"value":"c53b28d6-8cca-402e-9dec-5c7fd6683d8c"}

Accept-Languagestring

The ISO culture code of the current session culture

Example: en-US

Customer-Referencestring

The unique reference for the customer associated with the current session

Example: cust_83a3d6aa-f5f8-4abb-827d-82286bdb6373

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/umbraco/commerce/storefront/api/v1/country/{countryIdOrAlias}/region/{regionIdOrAlias}/paymentmethods' \
  --header 'Api-Key: text' \
  --header 'Store: text'

200

404

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "alias": "text",
    "name": "text",
    "sku": "text",
    "taxClass": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text"
    },
    "paymentProviderAlias": "text",
    "price": {
      "currency": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text"
      },
      "withoutTax": 1,
      "tax": 1,
      "withTax": 1,
      "formatted": {
        "withoutTax": "text",
        "tax": "text",
        "withTax": "text"
      }
    },
    "imageUrl": "text"
  }
]

Success