Country | Umbraco Commerce

Umbraco Commerce

CMS Cloud Heartcore

Gets all the Countries in a Store

get

Query parameters

filterstringOptional

Filter the returned list of items

Example: {"value":" "}

fieldsstringOptional

Limit the properties returned in the response

Example: {"value":" "}

expandstringOptional

Defines the properties that should be expanded 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":"b805d672-dbef-40a1-84da-681b3b517dda"}

Current-OrderstringOptional

The ID of the current order associated with the current session

Example: 00cc7aae-85da-4ac2-861b-551dde08254d

Billing-CountrystringOptional

The ID or alias of the session default billing country

Example: {"value":"615fa89d-748d-45d4-8e64-82c040131121"}

Billing-RegionstringOptional

The ID or alias of the session default billing region

Example: {"value":"c7911176-93db-4ffd-b562-f40f33092010"}

Shipping-CountrystringOptional

The ID or alias of the session default shipping country

Example: {"value":"81f39f8e-5934-4319-ae80-be66b59338dc"}

Shipping-RegionstringOptional

The ID or alias of the session default shipping region

Example: {"value":"ff760c2f-2662-4647-afed-4299dd396b49"}

Tax-ClassstringOptional

The ID or alias of the session default tax class

Example: {"value":"62be54c6-00d7-462a-b362-8b88f80b65ec"}

CurrencystringOptional

The ID or alias of the session currency

Example: {"value":"af4121f9-d024-461d-8291-2ee6bfa65f60"}

Accept-LanguagestringOptional

The ISO culture code of the current session culture

Example: en-US

Customer-ReferencestringOptional

The unique reference for the customer associated with the current session

Example: cust_0701d208-da68-4800-a276-2011709fd722

Responses

200

application/json

404

Not Found

get

GET /umbraco/commerce/storefront/api/v1/countries HTTP/1.1
Host: 
Api-Key: text
Store: text
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "name": "text",
    "store": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "defaultCountry": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "defaultCurrency": "[Circular Reference]",
        "defaultPaymentMethod": "[Circular Reference]",
        "defaultShippingMethod": "[Circular Reference]",
        "regions": "[Circular Reference]"
      },
      "defaultTaxClass": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alias": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "defaultTaxRate": 1,
        "defaultTaxCode": "text",
        "taxRate": 1,
        "taxCode": "text",
        "countryRegionTaxClasses": "[Circular Reference]"
      },
      "baseCurrency": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "culture": "text",
        "symbol": "text",
        "decimalPlaces": 1,
        "decimalSeparator": "text",
        "groupSeparator": "text",
        "formatTemplate": "text",
        "allowedCountries": "[Circular Reference]"
      },
      "pricesIncludeTax": true
    },
    "defaultCurrency": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "text",
      "name": "text",
      "store": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alias": "text",
        "name": "text",
        "defaultCountry": "[Circular Reference]",
        "defaultTaxClass": "[Circular Reference]",
        "baseCurrency": "[Circular Reference]",
        "pricesIncludeTax": true
      },
      "culture": "text",
      "symbol": "text",
      "decimalPlaces": 1,
      "decimalSeparator": "text",
      "groupSeparator": "text",
      "formatTemplate": "text",
      "allowedCountries": [
        {
          "country": "[Circular Reference]"
        }
      ]
    },
    "defaultPaymentMethod": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "store": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alias": "text",
        "name": "text",
        "defaultCountry": "[Circular Reference]",
        "defaultTaxClass": "[Circular Reference]",
        "baseCurrency": "[Circular Reference]",
        "pricesIncludeTax": true
      },
      "sku": "text",
      "taxClass": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alias": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "defaultTaxRate": 1,
        "defaultTaxCode": "text",
        "taxRate": 1,
        "taxCode": "text",
        "countryRegionTaxClasses": "[Circular Reference]"
      },
      "paymentProviderAlias": "text",
      "imageUrl": "text"
    },
    "defaultShippingMethod": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "store": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alias": "text",
        "name": "text",
        "defaultCountry": "[Circular Reference]",
        "defaultTaxClass": "[Circular Reference]",
        "baseCurrency": "[Circular Reference]",
        "pricesIncludeTax": true
      },
      "sku": "text",
      "taxClass": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alias": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "defaultTaxRate": 1,
        "defaultTaxCode": "text",
        "taxRate": 1,
        "taxCode": "text",
        "countryRegionTaxClasses": "[Circular Reference]"
      },
      "imageUrl": "text"
    },
    "regions": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "store": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "alias": "text",
          "name": "text",
          "defaultCountry": "[Circular Reference]",
          "defaultTaxClass": "[Circular Reference]",
          "baseCurrency": "[Circular Reference]",
          "pricesIncludeTax": true
        },
        "country": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "code": "text",
          "name": "text",
          "store": "[Circular Reference]",
          "defaultCurrency": "[Circular Reference]",
          "defaultPaymentMethod": "[Circular Reference]",
          "defaultShippingMethod": "[Circular Reference]",
          "regions": "[Circular Reference]"
        },
        "defaultPaymentMethod": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "alias": "text",
          "name": "text",
          "store": "[Circular Reference]",
          "sku": "text",
          "taxClass": "[Circular Reference]",
          "paymentProviderAlias": "text",
          "imageUrl": "text"
        },
        "defaultShippingMethod": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "alias": "text",
          "name": "text",
          "store": "[Circular Reference]",
          "sku": "text",
          "taxClass": "[Circular Reference]",
          "imageUrl": "text"
        }
      }
    ]
  }
]

Gets a Country by ID or Alias

get

Path parameters

idOrAliasone ofRequired

The ID or the alias of the given resource

Example: {"value":"3bebf017-2676-4989-bf5e-1989b77b9be6"}

stringOptional

Query parameters

fieldsstringOptional

Limit the properties returned in the response

Example: {"value":" "}

expandstringOptional

Defines the properties that should be expanded 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":"179590c4-25b0-47e6-8c2c-2bdc2a3bf9c6"}

Current-OrderstringOptional

The ID of the current order associated with the current session

Example: 5081a5fd-228e-4d10-abac-da74a5d47fb8

Billing-CountrystringOptional

The ID or alias of the session default billing country

Example: {"value":"524ad232-424c-4cbf-8b7b-4aab26048ecf"}

Billing-RegionstringOptional

The ID or alias of the session default billing region

Example: {"value":"7331417d-96e0-49cc-962d-edbb87b48870"}

Shipping-CountrystringOptional

The ID or alias of the session default shipping country

Example: {"value":"446f7a3c-3ab5-4b27-a420-2bac9d9b2203"}

Shipping-RegionstringOptional

The ID or alias of the session default shipping region

Example: {"value":"39a26454-2cc4-45cd-9469-f3f0a0750eb6"}

Tax-ClassstringOptional

The ID or alias of the session default tax class

Example: {"value":"188cf8e3-d9a8-4b26-975c-0f0a5ad2df53"}

CurrencystringOptional

The ID or alias of the session currency

Example: {"value":"35f9ac70-926f-447c-97a3-795ac011b0cf"}

Accept-LanguagestringOptional

The ISO culture code of the current session culture

Example: en-US

Customer-ReferencestringOptional

The unique reference for the customer associated with the current session

Example: cust_38632648-2b6b-4beb-ae1b-9f1a4e2659b9

Responses

200

application/json

Responseone of

404

Not Found

get

GET /umbraco/commerce/storefront/api/v1/country/{idOrAlias} HTTP/1.1
Host: 
Api-Key: text
Store: text
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "code": "text",
  "name": "text",
  "store": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "alias": "text",
    "name": "text",
    "defaultCountry": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "text",
      "name": "text",
      "store": "[Circular Reference]",
      "defaultCurrency": "[Circular Reference]",
      "defaultPaymentMethod": "[Circular Reference]",
      "defaultShippingMethod": "[Circular Reference]",
      "regions": "[Circular Reference]"
    },
    "defaultTaxClass": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "store": "[Circular Reference]",
      "defaultTaxRate": 1,
      "defaultTaxCode": "text",
      "taxRate": 1,
      "taxCode": "text",
      "countryRegionTaxClasses": "[Circular Reference]"
    },
    "baseCurrency": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "text",
      "name": "text",
      "store": "[Circular Reference]",
      "culture": "text",
      "symbol": "text",
      "decimalPlaces": 1,
      "decimalSeparator": "text",
      "groupSeparator": "text",
      "formatTemplate": "text",
      "allowedCountries": "[Circular Reference]"
    },
    "pricesIncludeTax": true
  },
  "defaultCurrency": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "name": "text",
    "store": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "defaultCountry": "[Circular Reference]",
      "defaultTaxClass": "[Circular Reference]",
      "baseCurrency": "[Circular Reference]",
      "pricesIncludeTax": true
    },
    "culture": "text",
    "symbol": "text",
    "decimalPlaces": 1,
    "decimalSeparator": "text",
    "groupSeparator": "text",
    "formatTemplate": "text",
    "allowedCountries": [
      {
        "country": "[Circular Reference]"
      }
    ]
  },
  "defaultPaymentMethod": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "alias": "text",
    "name": "text",
    "store": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "defaultCountry": "[Circular Reference]",
      "defaultTaxClass": "[Circular Reference]",
      "baseCurrency": "[Circular Reference]",
      "pricesIncludeTax": true
    },
    "sku": "text",
    "taxClass": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "store": "[Circular Reference]",
      "defaultTaxRate": 1,
      "defaultTaxCode": "text",
      "taxRate": 1,
      "taxCode": "text",
      "countryRegionTaxClasses": "[Circular Reference]"
    },
    "paymentProviderAlias": "text",
    "imageUrl": "text"
  },
  "defaultShippingMethod": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "alias": "text",
    "name": "text",
    "store": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "defaultCountry": "[Circular Reference]",
      "defaultTaxClass": "[Circular Reference]",
      "baseCurrency": "[Circular Reference]",
      "pricesIncludeTax": true
    },
    "sku": "text",
    "taxClass": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "store": "[Circular Reference]",
      "defaultTaxRate": 1,
      "defaultTaxCode": "text",
      "taxRate": 1,
      "taxCode": "text",
      "countryRegionTaxClasses": "[Circular Reference]"
    },
    "imageUrl": "text"
  },
  "regions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "text",
      "name": "text",
      "store": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alias": "text",
        "name": "text",
        "defaultCountry": "[Circular Reference]",
        "defaultTaxClass": "[Circular Reference]",
        "baseCurrency": "[Circular Reference]",
        "pricesIncludeTax": true
      },
      "country": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "defaultCurrency": "[Circular Reference]",
        "defaultPaymentMethod": "[Circular Reference]",
        "defaultShippingMethod": "[Circular Reference]",
        "regions": "[Circular Reference]"
      },
      "defaultPaymentMethod": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alias": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "sku": "text",
        "taxClass": "[Circular Reference]",
        "paymentProviderAlias": "text",
        "imageUrl": "text"
      },
      "defaultShippingMethod": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alias": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "sku": "text",
        "taxClass": "[Circular Reference]",
        "imageUrl": "text"
      }
    }
  ]
}

Deprecated

Gets the Currencies allowed in a Country

get

Path parameters

idOrAliasone ofRequired

The ID or the alias of the given resource

Example: {"value":"25ffdd93-c095-44a4-af19-f75578d1cb9f"}

stringOptional

Query parameters

fieldsstringOptional

Limit the properties returned in the response

Example: {"value":" "}

expandstringOptional

Defines the properties that should be expanded 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":"639c9c43-82d2-4223-81f6-9e18282a5d39"}

Current-OrderstringOptional

The ID of the current order associated with the current session

Example: 5b14853d-8e51-4bde-8bd6-e1e9c06981ef

Billing-CountrystringOptional

The ID or alias of the session default billing country

Example: {"value":"a112d1a9-5cbd-4970-92c3-9ddb4ef54f01"}

Billing-RegionstringOptional

The ID or alias of the session default billing region

Example: {"value":"bd59a132-5e4e-4edc-b098-206fa9ca1785"}

Shipping-CountrystringOptional

The ID or alias of the session default shipping country

Example: {"value":"90a2e5d0-5691-44ab-b741-60a750a1fdc4"}

Shipping-RegionstringOptional

The ID or alias of the session default shipping region

Example: {"value":"2d90ec5a-f80f-47c5-8321-8d5514328867"}

Tax-ClassstringOptional

The ID or alias of the session default tax class

Example: {"value":"9a91dc6c-3c15-4aa6-a320-b5c74d19ba16"}

CurrencystringOptional

The ID or alias of the session currency

Example: {"value":"b543ffa0-4d8c-4b2f-9f8b-7683c747484d"}

Accept-LanguagestringOptional

The ISO culture code of the current session culture

Example: en-US

Customer-ReferencestringOptional

The unique reference for the customer associated with the current session

Example: cust_fe0e4bb6-1eb0-4902-835c-cbcbc0585aef

Responses

200

application/json

404

Not Found

get

GET /umbraco/commerce/storefront/api/v1/country/{idOrAlias}/currencies HTTP/1.1
Host: 
Api-Key: text
Store: text
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "name": "text",
    "store": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "defaultCountry": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "defaultCurrency": "[Circular Reference]",
        "defaultPaymentMethod": "[Circular Reference]",
        "defaultShippingMethod": "[Circular Reference]",
        "regions": "[Circular Reference]"
      },
      "defaultTaxClass": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alias": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "defaultTaxRate": 1,
        "defaultTaxCode": "text",
        "taxRate": 1,
        "taxCode": "text",
        "countryRegionTaxClasses": "[Circular Reference]"
      },
      "baseCurrency": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "culture": "text",
        "symbol": "text",
        "decimalPlaces": 1,
        "decimalSeparator": "text",
        "groupSeparator": "text",
        "formatTemplate": "text",
        "allowedCountries": "[Circular Reference]"
      },
      "pricesIncludeTax": true
    },
    "culture": "text",
    "symbol": "text",
    "decimalPlaces": 1,
    "decimalSeparator": "text",
    "groupSeparator": "text",
    "formatTemplate": "text",
    "allowedCountries": [
      {
        "country": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "code": "text",
          "name": "text",
          "store": "[Circular Reference]",
          "defaultCurrency": "[Circular Reference]",
          "defaultPaymentMethod": "[Circular Reference]",
          "defaultShippingMethod": "[Circular Reference]",
          "regions": "[Circular Reference]"
        }
      }
    ]
  }
]

Deprecated

Gets the Payment Methods allowed in a Country

get

Path parameters

idOrAliasone ofRequired

The ID or the alias of the given resource

Example: {"value":"8df6751e-9acc-4968-9d68-88b43dcd51c7"}

stringOptional

Query parameters

fieldsstringOptional

Limit the properties returned in the response

Example: {"value":" "}

expandstringOptional

Defines the properties that should be expanded 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":"6f8ee881-0141-4e75-a701-0679d7829a23"}

Current-OrderstringOptional

The ID of the current order associated with the current session

Example: 3efdda02-b6dd-437a-aa91-8238394bde00

Billing-CountrystringOptional

The ID or alias of the session default billing country

Example: {"value":"a01b5e97-7769-4d8c-9cbc-ff978bc58fa4"}

Billing-RegionstringOptional

The ID or alias of the session default billing region

Example: {"value":"1cf83d54-0afa-4793-88d1-62e2e79ba4ef"}

Shipping-CountrystringOptional

The ID or alias of the session default shipping country

Example: {"value":"89918977-a89b-4572-b454-c335efc96ea3"}

Shipping-RegionstringOptional

The ID or alias of the session default shipping region

Example: {"value":"9c8ff67f-30c8-4f49-a5ed-98ead9a91164"}

Tax-ClassstringOptional

The ID or alias of the session default tax class

Example: {"value":"2233e86c-481c-4f1b-a76f-e50c45c0129b"}

CurrencystringOptional

The ID or alias of the session currency

Example: {"value":"76629e4f-86eb-4847-bd26-007a5149cabd"}

Accept-LanguagestringOptional

The ISO culture code of the current session culture

Example: en-US

Customer-ReferencestringOptional

The unique reference for the customer associated with the current session

Example: cust_32b61a21-40c3-4142-a310-bf1516ea2af2

Responses

200

application/json

404

Not Found

get

GET /umbraco/commerce/storefront/api/v1/country/{idOrAlias}/paymentmethods HTTP/1.1
Host: 
Api-Key: text
Store: text
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "alias": "text",
    "name": "text",
    "store": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "defaultCountry": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "defaultCurrency": "[Circular Reference]",
        "defaultPaymentMethod": "[Circular Reference]",
        "defaultShippingMethod": "[Circular Reference]",
        "regions": "[Circular Reference]"
      },
      "defaultTaxClass": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alias": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "defaultTaxRate": 1,
        "defaultTaxCode": "text",
        "taxRate": 1,
        "taxCode": "text",
        "countryRegionTaxClasses": "[Circular Reference]"
      },
      "baseCurrency": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "culture": "text",
        "symbol": "text",
        "decimalPlaces": 1,
        "decimalSeparator": "text",
        "groupSeparator": "text",
        "formatTemplate": "text",
        "allowedCountries": "[Circular Reference]"
      },
      "pricesIncludeTax": true
    },
    "sku": "text",
    "taxClass": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "store": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alias": "text",
        "name": "text",
        "defaultCountry": "[Circular Reference]",
        "defaultTaxClass": "[Circular Reference]",
        "baseCurrency": "[Circular Reference]",
        "pricesIncludeTax": true
      },
      "defaultTaxRate": 1,
      "defaultTaxCode": "text",
      "taxRate": 1,
      "taxCode": "text",
      "countryRegionTaxClasses": [
        {
          "store": "[Circular Reference]",
          "country": "[Circular Reference]",
          "region": "[Circular Reference]",
          "taxRate": 1,
          "taxCode": "text"
        }
      ]
    },
    "paymentProviderAlias": "text",
    "imageUrl": "text"
  }
]

Deprecated

Gets the Shipping Methods allowed in a Country

get

Path parameters

idOrAliasone ofRequired

The ID or the alias of the given resource

Example: {"value":"35733b5a-e031-4697-a048-4ca9bce87fe3"}

stringOptional

Query parameters

fieldsstringOptional

Limit the properties returned in the response

Example: {"value":" "}

expandstringOptional

Defines the properties that should be expanded 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":"6690045d-1343-45ba-bbb2-30beb7edb038"}

Current-OrderstringOptional

The ID of the current order associated with the current session

Example: e90f68b9-1e27-4991-82d8-a7f2037e5b03

Billing-CountrystringOptional

The ID or alias of the session default billing country

Example: {"value":"b37e31b5-5d86-4d9b-a951-a9e6036ca545"}

Billing-RegionstringOptional

The ID or alias of the session default billing region

Example: {"value":"8f97084f-b32f-44b7-aecf-f7734a8e78d8"}

Shipping-CountrystringOptional

The ID or alias of the session default shipping country

Example: {"value":"ccf190c3-f291-4730-8a3f-caf4ebc07cd5"}

Shipping-RegionstringOptional

The ID or alias of the session default shipping region

Example: {"value":"f2b283c6-cb66-40d6-92f3-b465a8b78de0"}

Tax-ClassstringOptional

The ID or alias of the session default tax class

Example: {"value":"bc1a02b2-6f83-44ba-b689-12552f6ce18d"}

CurrencystringOptional

The ID or alias of the session currency

Example: {"value":"5f6dd0bf-568a-4c78-b8e9-27fead34a2c9"}

Accept-LanguagestringOptional

The ISO culture code of the current session culture

Example: en-US

Customer-ReferencestringOptional

The unique reference for the customer associated with the current session

Example: cust_2cf85338-fe49-407e-9af7-50e186dd476e

Responses

200

application/json

404

Not Found

get

GET /umbraco/commerce/storefront/api/v1/country/{idOrAlias}/shippingmethods HTTP/1.1
Host: 
Api-Key: text
Store: text
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "alias": "text",
    "name": "text",
    "store": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "defaultCountry": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "defaultCurrency": "[Circular Reference]",
        "defaultPaymentMethod": "[Circular Reference]",
        "defaultShippingMethod": "[Circular Reference]",
        "regions": "[Circular Reference]"
      },
      "defaultTaxClass": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alias": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "defaultTaxRate": 1,
        "defaultTaxCode": "text",
        "taxRate": 1,
        "taxCode": "text",
        "countryRegionTaxClasses": "[Circular Reference]"
      },
      "baseCurrency": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "culture": "text",
        "symbol": "text",
        "decimalPlaces": 1,
        "decimalSeparator": "text",
        "groupSeparator": "text",
        "formatTemplate": "text",
        "allowedCountries": "[Circular Reference]"
      },
      "pricesIncludeTax": true
    },
    "sku": "text",
    "taxClass": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "store": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alias": "text",
        "name": "text",
        "defaultCountry": "[Circular Reference]",
        "defaultTaxClass": "[Circular Reference]",
        "baseCurrency": "[Circular Reference]",
        "pricesIncludeTax": true
      },
      "defaultTaxRate": 1,
      "defaultTaxCode": "text",
      "taxRate": 1,
      "taxCode": "text",
      "countryRegionTaxClasses": [
        {
          "store": "[Circular Reference]",
          "country": "[Circular Reference]",
          "region": "[Circular Reference]",
          "taxRate": 1,
          "taxCode": "text"
        }
      ]
    },
    "imageUrl": "text"
  }
]

Deprecated

Gets the Payment Methods allowed in a Region

get

Path parameters

countryIdOrAliasone ofRequired

The ID or the alias of the country resource

Example: {"value":"4a8e39fa-837f-47fc-afb1-68ba4389069f"}

stringOptional

regionIdOrAliasone ofRequired

The ID or the alias of the region resource

Example: {"value":"e8f5d367-1aaf-4c5c-a25a-d69829126a08"}

stringOptional

Query parameters

fieldsstringOptional

Limit the properties returned in the response

Example: {"value":" "}

expandstringOptional

Defines the properties that should be expanded 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":"0e13277c-0fa4-4bcb-bd99-2b250e451191"}

Current-OrderstringOptional

The ID of the current order associated with the current session

Example: 79e3eb6d-ed3e-400b-94fa-43c466cf290e

Billing-CountrystringOptional

The ID or alias of the session default billing country

Example: {"value":"41c4b8f7-af34-471e-b349-2b5db568aba0"}

Billing-RegionstringOptional

The ID or alias of the session default billing region

Example: {"value":"4bcec082-cc97-4d4d-85c5-c46d23aaa1aa"}

Shipping-CountrystringOptional

The ID or alias of the session default shipping country

Example: {"value":"287d11bd-6c35-4acb-9b67-6586777f3c1d"}

Shipping-RegionstringOptional

The ID or alias of the session default shipping region

Example: {"value":"e6a0da82-2403-4d9e-8135-215a32332308"}

Tax-ClassstringOptional

The ID or alias of the session default tax class

Example: {"value":"2bed7e9a-5d9a-4e4f-9539-5f85a11a772f"}

CurrencystringOptional

The ID or alias of the session currency

Example: {"value":"8ad0ff66-b6a7-4b71-921e-b656581b4723"}

Accept-LanguagestringOptional

The ISO culture code of the current session culture

Example: en-US

Customer-ReferencestringOptional

The unique reference for the customer associated with the current session

Example: cust_94377964-f740-47a0-9954-7740399303f9

Responses

200

application/json

404

Not Found

get

GET /umbraco/commerce/storefront/api/v1/country/{countryIdOrAlias}/region/{regionIdOrAlias}/paymentmethods HTTP/1.1
Host: 
Api-Key: text
Store: text
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "alias": "text",
    "name": "text",
    "store": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "defaultCountry": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "defaultCurrency": "[Circular Reference]",
        "defaultPaymentMethod": "[Circular Reference]",
        "defaultShippingMethod": "[Circular Reference]",
        "regions": "[Circular Reference]"
      },
      "defaultTaxClass": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alias": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "defaultTaxRate": 1,
        "defaultTaxCode": "text",
        "taxRate": 1,
        "taxCode": "text",
        "countryRegionTaxClasses": "[Circular Reference]"
      },
      "baseCurrency": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "culture": "text",
        "symbol": "text",
        "decimalPlaces": 1,
        "decimalSeparator": "text",
        "groupSeparator": "text",
        "formatTemplate": "text",
        "allowedCountries": "[Circular Reference]"
      },
      "pricesIncludeTax": true
    },
    "sku": "text",
    "taxClass": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "store": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alias": "text",
        "name": "text",
        "defaultCountry": "[Circular Reference]",
        "defaultTaxClass": "[Circular Reference]",
        "baseCurrency": "[Circular Reference]",
        "pricesIncludeTax": true
      },
      "defaultTaxRate": 1,
      "defaultTaxCode": "text",
      "taxRate": 1,
      "taxCode": "text",
      "countryRegionTaxClasses": [
        {
          "store": "[Circular Reference]",
          "country": "[Circular Reference]",
          "region": "[Circular Reference]",
          "taxRate": 1,
          "taxCode": "text"
        }
      ]
    },
    "paymentProviderAlias": "text",
    "imageUrl": "text"
  }
]

Deprecated

Gets the Payment Methods allowed in a Region

get

Path parameters

countryIdOrAliasone ofRequired

The ID or the alias of the country resource

Example: {"value":"4a8e39fa-837f-47fc-afb1-68ba4389069f"}

stringOptional

regionIdOrAliasone ofRequired

The ID or the alias of the region resource

Example: {"value":"e8f5d367-1aaf-4c5c-a25a-d69829126a08"}

stringOptional

Query parameters

fieldsstringOptional

Limit the properties returned in the response

Example: {"value":" "}

expandstringOptional

Defines the properties that should be expanded 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":"0e13277c-0fa4-4bcb-bd99-2b250e451191"}

Current-OrderstringOptional

The ID of the current order associated with the current session

Example: 79e3eb6d-ed3e-400b-94fa-43c466cf290e

Billing-CountrystringOptional

The ID or alias of the session default billing country

Example: {"value":"41c4b8f7-af34-471e-b349-2b5db568aba0"}

Billing-RegionstringOptional

The ID or alias of the session default billing region

Example: {"value":"4bcec082-cc97-4d4d-85c5-c46d23aaa1aa"}

Shipping-CountrystringOptional

The ID or alias of the session default shipping country

Example: {"value":"287d11bd-6c35-4acb-9b67-6586777f3c1d"}

Shipping-RegionstringOptional

The ID or alias of the session default shipping region

Example: {"value":"e6a0da82-2403-4d9e-8135-215a32332308"}

Tax-ClassstringOptional

The ID or alias of the session default tax class

Example: {"value":"2bed7e9a-5d9a-4e4f-9539-5f85a11a772f"}

CurrencystringOptional

The ID or alias of the session currency

Example: {"value":"8ad0ff66-b6a7-4b71-921e-b656581b4723"}

Accept-LanguagestringOptional

The ISO culture code of the current session culture

Example: en-US

Customer-ReferencestringOptional

The unique reference for the customer associated with the current session

Example: cust_94377964-f740-47a0-9954-7740399303f9

Responses

200

application/json

404

Not Found

get

GET /umbraco/commerce/storefront/api/v1/country/{countryIdOrAlias}/region/{regionIdOrAlias}/paymentmethods HTTP/1.1
Host: 
Api-Key: text
Store: text
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "alias": "text",
    "name": "text",
    "store": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "defaultCountry": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "defaultCurrency": "[Circular Reference]",
        "defaultPaymentMethod": "[Circular Reference]",
        "defaultShippingMethod": "[Circular Reference]",
        "regions": "[Circular Reference]"
      },
      "defaultTaxClass": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alias": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "defaultTaxRate": 1,
        "defaultTaxCode": "text",
        "taxRate": 1,
        "taxCode": "text",
        "countryRegionTaxClasses": "[Circular Reference]"
      },
      "baseCurrency": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "culture": "text",
        "symbol": "text",
        "decimalPlaces": 1,
        "decimalSeparator": "text",
        "groupSeparator": "text",
        "formatTemplate": "text",
        "allowedCountries": "[Circular Reference]"
      },
      "pricesIncludeTax": true
    },
    "sku": "text",
    "taxClass": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "store": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alias": "text",
        "name": "text",
        "defaultCountry": "[Circular Reference]",
        "defaultTaxClass": "[Circular Reference]",
        "baseCurrency": "[Circular Reference]",
        "pricesIncludeTax": true
      },
      "defaultTaxRate": 1,
      "defaultTaxCode": "text",
      "taxRate": 1,
      "taxCode": "text",
      "countryRegionTaxClasses": [
        {
          "store": "[Circular Reference]",
          "country": "[Circular Reference]",
          "region": "[Circular Reference]",
          "taxRate": 1,
          "taxCode": "text"
        }
      ]
    },
    "paymentProviderAlias": "text",
    "imageUrl": "text"
  }
]