Estimate shipping methods
Estimate shipping by address and return list of available shipping methods
Path parameters
cartIdstringRequiredExample:
(Required)
<string>Header parameters
Content-TypestringOptionalExample:
application/jsonBody
objectOptionalExample:
{"address":{"region":"magna deserunt fugiat nulla","region_id":-54488238,"region_code":"et sint sunt aute laborum","country_id":"Lorem sunt anim id in","street":["sit magna","dolor"],"telephone":"magna ipsum labore veniam","postcode":"deserunt voluptate sed","city":"velit cupidatat","firstname":"cupidatat aute enim occaecat","lastname":"veniam reprehenderit officia","email":"exercitation dolore magna","id":90072107,"company":"ut est do","fax":"dolore commodo mollit fugiat","middlename":"occaecat ullamco do fugiat","prefix":"cupidatat anim est occaec","suffix":"aliqua dolor ut qui","vat_id":"occaecat eiusmod enim","customer_id":67214744,"same_as_billing":-74818288,"customer_address_id":37309966,"save_in_address_book":95923483,"extension_attributes":{"pickup_location_code":"tempor laborum ad sit","discounts":[{"discount_data":{"value":"<Error: Too many levels of nesting to fake this schema>"},"rule_label":"ad eiusmod","rule_id":-38241134},{"discount_data":{"value":"<Error: Too many levels of nesting to fake this schema>"},"rule_label":"dolor id","rule_id":-91251721}]},"custom_attributes":[{"attribute_code":"velit ex consequat est Duis","value":"ullamco anim commodo"},{"attribute_code":"exercitation incididunt","value":"dolor"}]}}Responses
200
OK
application/json
Responseobject
401
Unauthorized
application/json
500
Internal Server Error
application/json
post
/V1/carts/{cartId}/estimate-shipping-methodsPOST /V1/carts/{cartId}/estimate-shipping-methods HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 1247
{
"address": {
"region": "magna deserunt fugiat nulla",
"region_id": -54488238,
"region_code": "et sint sunt aute laborum",
"country_id": "Lorem sunt anim id in",
"street": [
"sit magna",
"dolor"
],
"telephone": "magna ipsum labore veniam",
"postcode": "deserunt voluptate sed",
"city": "velit cupidatat",
"firstname": "cupidatat aute enim occaecat",
"lastname": "veniam reprehenderit officia",
"email": "exercitation dolore magna",
"id": 90072107,
"company": "ut est do",
"fax": "dolore commodo mollit fugiat",
"middlename": "occaecat ullamco do fugiat",
"prefix": "cupidatat anim est occaec",
"suffix": "aliqua dolor ut qui",
"vat_id": "occaecat eiusmod enim",
"customer_id": 67214744,
"same_as_billing": -74818288,
"customer_address_id": 37309966,
"save_in_address_book": 95923483,
"extension_attributes": {
"pickup_location_code": "tempor laborum ad sit",
"discounts": [
{
"discount_data": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"rule_label": "ad eiusmod",
"rule_id": -38241134
},
{
"discount_data": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"rule_label": "dolor id",
"rule_id": -91251721
}
]
},
"custom_attributes": [
{
"attribute_code": "velit ex consequat est Duis",
"value": "ullamco anim commodo"
},
{
"attribute_code": "exercitation incididunt",
"value": "dolor"
}
]
}
}[
{
"carrier_code": "ipsum",
"method_code": "non minim consequat aliquip",
"amount": -92444781.97941546,
"base_amount": -77562039.40991369,
"available": false,
"error_message": "ullamco voluptate in consectetur irure",
"price_excl_tax": 62013714.3675794,
"price_incl_tax": -86538219.04194103,
"carrier_title": "officia Duis",
"method_title": "consequat cillum",
"extension_attributes": {}
},
{
"carrier_code": "eu tempor cupidatat in",
"method_code": "magna aliquip tempor",
"amount": 82616229.13105917,
"base_amount": 59618833.48766109,
"available": false,
"error_message": "aliqua",
"price_excl_tax": -73250455.59995478,
"price_incl_tax": -80469971.08916481,
"carrier_title": "fugiat nisi mollit",
"method_title": "in veniam proident",
"extension_attributes": {}
}
]