Estimate shipping by address and return list of available shipping methods

POST /V1/carts/{cartId}/estimate-shipping-methods

Path parameters

cartId string Required

Body

address object Required

Interface AddressInterface
Hide address attributes Show address attributes object
- id integer
  
  Id
- region string Required
  
  Region name
- region_id integer Required
  
  Region id
- region_code string Required
  
  Region code
- country_id string Required
  
  Country id
- street array[string] Required
  
  Street
- company string
  
  Company
- telephone string Required
  
  Telephone number
- fax string
  
  Fax number
- postcode string Required
  
  Postcode
- city string Required
  
  City name
- firstname string Required
  
  First name
- lastname string Required
  
  Last name
- middlename string
  
  Middle name
- prefix string
  
  Prefix
- suffix string
  
  Suffix
- vat_id string
  
  Vat id
- customer_id integer
  
  Customer id
- email string Required
  
  Billing/shipping email
- same_as_billing integer
  
  Same as billing flag
- customer_address_id integer
  
  Customer address id
- save_in_address_book integer
  
  Save in address book flag
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  discounts array[object]
  
  Rule discount Interface
  
  Hide discounts attributes Show discounts attributes object
  
  discount_data object Required
  
  Discount Data Interface
  
  Hide discount_data attributes Show discount_data attributes object
  
  amount number Required
  
  Amount
  
  base_amount number Required
  
  Base Amount
  
  original_amount number Required
  
  Original Amount
  
  base_original_amount number Required
  
  Base Original Amount
  
  rule_label string Required
  
  Rule Label
  
  rule_i_d integer Required
  
  Rule ID
  
  gift_registry_id integer
  
  pickup_location_code string
- custom_attributes array[object]
  
  Interface for custom attribute value.
  Hide custom_attributes attributes Show custom_attributes attributes object
  
  attribute_code string Required
  
  Attribute code
  
  value string Required
  
  Attribute value

Responses

200

200 Success.
Hide response attributes Show response attributes object
- carrier_code string Required
  
  Shipping carrier code.
- method_code string Required
  
  Shipping method code.
- carrier_title string
  
  Shipping carrier title. Otherwise, null.
- method_title string
  
  Shipping method title. Otherwise, null.
- amount number Required
  
  Shipping amount in store currency.
- base_amount number Required
  
  Shipping amount in base currency.
- available boolean Required
  
  The value of the availability flag for the current shipping method.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingMethodInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  carrier_codes array[object]
  
  Hide carrier_codes attributes Show carrier_codes attributes object
  
  code string Required
  
  name string Required
  
  delivery_window_dates array[object]
  
  Hide delivery_window_dates attributes Show delivery_window_dates attributes object
  
  carrier_code string Required
  
  from string Required
  
  to string Required
  
  method_title string Required
  
  expires string Required
  
  is_pickup_point boolean
  
  pickup_point object
  
  Hide pickup_point attributes Show pickup_point attributes object
  
  pick_up_point_id string Required
  
  carrier_method string Required
  
  name string
  
  address_lines array[string] Required
  
  city string Required
  
  state string
  
  country string Required
  
  postal string Required
  
  telephone string
  
  fax string
- error_message string Required
  
  Shipping Error message.
- price_excl_tax number Required
  
  Shipping price excl tax.
- price_incl_tax number Required
  
  Shipping price incl tax.
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
400

400 Bad Request
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

POST /V1/carts/{cartId}/estimate-shipping-methods

curl \
 -X POST https://magento2.winkelstraat.mac/rest/all/V1/carts/{cartId}/estimate-shipping-methods \
 -d '{"address":{"id":42,"region":"string","region_id":42,"region_code":"string","country_id":"string","street":["string"],"company":"string","telephone":"string","fax":"string","postcode":"string","city":"string","firstname":"string","lastname":"string","middlename":"string","prefix":"string","suffix":"string","vat_id":"string","customer_id":42,"email":"string","same_as_billing":42,"customer_address_id":42,"save_in_address_book":42,"extension_attributes":{"discounts":[{"discount_data":{"amount":42.0,"base_amount":42.0,"original_amount":42.0,"base_original_amount":42.0},"rule_label":"string","rule_i_d":42}],"gift_registry_id":42,"pickup_location_code":"string"},"custom_attributes":[{"attribute_code":"string","value":"string"}]}}'

Request examples

{
  "address": {
    "id": 42,
    "region": "string",
    "region_id": 42,
    "region_code": "string",
    "country_id": "string",
    "street": [
      "string"
    ],
    "company": "string",
    "telephone": "string",
    "fax": "string",
    "postcode": "string",
    "city": "string",
    "firstname": "string",
    "lastname": "string",
    "middlename": "string",
    "prefix": "string",
    "suffix": "string",
    "vat_id": "string",
    "customer_id": 42,
    "email": "string",
    "same_as_billing": 42,
    "customer_address_id": 42,
    "save_in_address_book": 42,
    "extension_attributes": {
      "discounts": [
        {
          "discount_data": {
            "amount": 42.0,
            "base_amount": 42.0,
            "original_amount": 42.0,
            "base_original_amount": 42.0
          },
          "rule_label": "string",
          "rule_i_d": 42
        }
      ],
      "gift_registry_id": 42,
      "pickup_location_code": "string"
    },
    "custom_attributes": [
      {
        "attribute_code": "string",
        "value": "string"
      }
    ]
  }
}

Response examples (200)

[
  {
    "carrier_code": "string",
    "method_code": "string",
    "carrier_title": "string",
    "method_title": "string",
    "amount": 42.0,
    "base_amount": 42.0,
    "available": true,
    "extension_attributes": {
      "carrier_codes": [
        {
          "code": "string",
          "name": "string"
        }
      ],
      "delivery_window_dates": [
        {
          "carrier_code": "string",
          "from": "string",
          "to": "string",
          "method_title": "string",
          "expires": "string"
        }
      ],
      "is_pickup_point": true,
      "pickup_point": {
        "pick_up_point_id": "string",
        "carrier_method": "string",
        "name": "string",
        "address_lines": [
          "string"
        ],
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "telephone": "string",
        "fax": "string"
      }
    },
    "error_message": "string",
    "price_excl_tax": 42.0,
    "price_incl_tax": 42.0
  }
]

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (400)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}