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

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":"e408b010-7bba-4235-8d35-340b18939b4d"}

Current-OrderstringOptional

The ID of the current order associated with the current session

Example: f56f30d2-5f0c-4cf1-9db2-3afbfd26afe3

Billing-CountrystringOptional

The ID or alias of the session default billing country

Example: {"value":"21dabf17-766f-48a7-9fed-8e86dc1431d0"}

Billing-RegionstringOptional

The ID or alias of the session default billing region

Example: {"value":"f27e9337-e29d-4d31-9583-e772973f3309"}

Shipping-CountrystringOptional

The ID or alias of the session default shipping country

Example: {"value":"d67f50c9-9765-4326-ac71-23c9cfab9dcb"}

Shipping-RegionstringOptional

The ID or alias of the session default shipping region

Example: {"value":"9ab4f24a-09a5-408d-bf48-4b20b55e77a1"}

Tax-ClassstringOptional

The ID or alias of the session default tax class

Example: {"value":"84a6903a-166c-44e2-a2e3-be17b974da7e"}

CurrencystringOptional

The ID or alias of the session currency

Example: {"value":"ef3ed3ed-1f68-46ba-9ee2-662badabfb0e"}

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_ae840c37-7d89-4f32-a6e4-9453603c4140

Responses

200

OK

application/json

404

Not Found

get

HTTPcURLJavaScriptPython

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":"f1455c22-c890-4690-96d4-7ba5b78aff5f"}

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":"b90a7186-f13f-40f0-b45b-67fec2c9011c"}

Current-OrderstringOptional

The ID of the current order associated with the current session

Example: 076eeae9-c4c9-41f9-9145-b8a3fab223c3

Billing-CountrystringOptional

The ID or alias of the session default billing country

Example: {"value":"f63b87ed-d64a-4c29-8786-9c9a8068a1ef"}

Billing-RegionstringOptional

The ID or alias of the session default billing region

Example: {"value":"333f8d11-7c53-40b7-b6cf-934c4ae6adf9"}

Shipping-CountrystringOptional

The ID or alias of the session default shipping country

Example: {"value":"f6b88749-d555-4670-9b14-04335c0e8b55"}

Shipping-RegionstringOptional

The ID or alias of the session default shipping region

Example: {"value":"18a5899c-c202-497c-8a36-d7bb07781961"}

Tax-ClassstringOptional

The ID or alias of the session default tax class

Example: {"value":"260eeaf3-7293-4cc6-9794-3408c944f14b"}

CurrencystringOptional

The ID or alias of the session currency

Example: {"value":"4dd19787-db4b-4ffd-8c47-910d13e10b0d"}

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_8023900c-2ffc-4973-8f8e-ef09cb459561

Responses

200

OK

application/json

Responseone of

404

Not Found

get

HTTPcURLJavaScriptPython

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"
}