Estimate shipping

POST /V1/carts/mine/estimate-shipping-methods-by-address-id

Estimate shipping

Body

addressId integer Required

The estimate address id

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
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/mine/estimate-shipping-methods-by-address-id

curl \
 -X POST https://magento2.winkelstraat.mac/rest/all/V1/carts/mine/estimate-shipping-methods-by-address-id \
 -d '{"addressId":42}'

Request examples

{
  "addressId": 42
}

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 (default)

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