Shipping method

The Shipping Method API endpoints allow fetching supported shipping methods from a store.

Deprecated

Gets all the Shipping Methods in a Store

get

Query parameters

LanguageIsoCodestringOptional

fieldsstringOptional

Limit the properties returned in the response

Example: {"value":" "}

expandstringOptional

Defines the properties that should be expanded in the response

Example: {"value":" "}

filterstringOptional

Filter the returned list of items

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":"5dbfd403-975b-494e-8267-8b665547a094"}

Current-OrderstringOptional

The ID of the current order associated with the current session

Example: 74a69338-2b96-44e7-ad01-72240f45c807

Billing-CountrystringOptional

The ID or alias of the session default billing country

Example: {"value":"f2300521-fb14-4d9a-b355-c6abbb2139f9"}

Billing-RegionstringOptional

The ID or alias of the session default billing region

Example: {"value":"c9a399e5-3d94-426e-a39c-2e8a234ddab9"}

Shipping-CountrystringOptional

The ID or alias of the session default shipping country

Example: {"value":"ee3211cd-d5e7-43c5-b543-4e6d743984f0"}

Shipping-RegionstringOptional

The ID or alias of the session default shipping region

Example: {"value":"d6208b1e-6e0b-4caa-a90c-b286d503ebb1"}

Tax-ClassstringOptional

The ID or alias of the session default tax class

Example: {"value":"0022e060-7d86-4f6c-b506-ce57567be4ed"}

CurrencystringOptional

The ID or alias of the session currency

Example: {"value":"43388489-9527-454d-b95a-190bf87b8ba3"}

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_a8ee3416-7279-4550-9fda-c969ff0b9fdf

Responses

200

application/json

404

Not Found

get

GET /umbraco/commerce/storefront/api/v1/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

Get a Shipping Method by ID or Alias

get

Path parameters

idOrAliasone ofRequired

The ID or the alias of the given resource

Example: {"value":"0e2044a4-4b01-49a9-9f36-9540d7ebc003"}

stringOptional

Query parameters

LanguageIsoCodestringOptional

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":"fa5f54db-b58e-4f47-9011-1b82f10e1cc7"}

Current-OrderstringOptional

The ID of the current order associated with the current session

Example: 02fdae23-2323-470c-87bd-6142155359de

Billing-CountrystringOptional

The ID or alias of the session default billing country

Example: {"value":"92947378-8fc4-4afb-88a1-8f605a3e59dc"}

Billing-RegionstringOptional

The ID or alias of the session default billing region

Example: {"value":"f43a5c66-e8d4-4e24-9648-a4f6f872846e"}

Shipping-CountrystringOptional

The ID or alias of the session default shipping country

Example: {"value":"6a74a3d9-524d-40c7-92cb-cc4c086b2dea"}

Shipping-RegionstringOptional

The ID or alias of the session default shipping region

Example: {"value":"827d1d64-fc7f-42da-8d0a-e7e46131e847"}

Tax-ClassstringOptional

The ID or alias of the session default tax class

Example: {"value":"c0a5c496-7f2c-4609-9a77-b05d9b5ce8d9"}

CurrencystringOptional

The ID or alias of the session currency

Example: {"value":"d5ea1bf0-f60d-496b-a953-45695a911cc6"}

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_c2ad270e-3a70-490a-8904-b26257e9ff06

Responses

200

application/json

Responseone of

404

Not Found

get

GET /umbraco/commerce/storefront/api/v1/shippingmethod/{idOrAlias} 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"
}

PreviousPayment method NextContent

Last updated 4 months ago

Was this helpful?