Estimate shipping by address and return list of available shipping methods
Estimate shipping by address and return list of available shipping methods
POST /V1/purchase-order-carts/{cartId}/estimate-shipping-methods
curl \
-X POST https://magento2.winkelstraat.mac/rest/all/V1/purchase-order-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"
}