application/json
POST
/V1/carts/{cartId}/shipping-information
cURL (application/json)
curl \
--request POST 'https://magento2.winkelstraat.mac/rest/all/V1/carts/{cartId}/shipping-information' \
--header "Content-Type: application/json" \
--data '{"addressInformation":{"shipping_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"}]},"billing_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"}]},"shipping_method_code":"string","shipping_carrier_code":"string","extension_attributes":{"newsletter_subscribe":"string"},"custom_attributes":[{"attribute_code":"string","value":"string"}]}}'
curl \
--request POST 'https://magento2.winkelstraat.mac/rest/all/V1/carts/{cartId}/shipping-information' \
--header "Content-Type: application/xml"
Request examples
{
"addressInformation": {
"shipping_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"
}
]
},
"billing_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"
}
]
},
"shipping_method_code": "string",
"shipping_carrier_code": "string",
"extension_attributes": {
"newsletter_subscribe": "string"
},
"custom_attributes": [
{
"attribute_code": "string",
"value": "string"
}
]
}
}
Request examples
<?xml version="1.0" encoding="UTF-8"?>
<root>
<addressInformation>
<shipping-address>
<id type="integer">42</id>
<region>string</region>
<region-id type="integer">42</region-id>
<region-code>string</region-code>
<country-id>string</country-id>
<street type="array">
<street>string</street>
</street>
<company>string</company>
<telephone>string</telephone>
<fax>string</fax>
<postcode>string</postcode>
<city>string</city>
<firstname>string</firstname>
<lastname>string</lastname>
<middlename>string</middlename>
<prefix>string</prefix>
<suffix>string</suffix>
<vat-id>string</vat-id>
<customer-id type="integer">42</customer-id>
<email>string</email>
<same-as-billing type="integer">42</same-as-billing>
<customer-address-id type="integer">42</customer-address-id>
<save-in-address-book type="integer">42</save-in-address-book>
<extension-attributes>
<discounts type="array">
<discount>
<discount-data>
<amount type="float">42.0</amount>
<base-amount type="float">42.0</base-amount>
<original-amount type="float">42.0</original-amount>
<base-original-amount type="float">42.0</base-original-amount>
</discount-data>
<rule-label>string</rule-label>
<rule-i-d type="integer">42</rule-i-d>
</discount>
</discounts>
<gift-registry-id type="integer">42</gift-registry-id>
<pickup-location-code>string</pickup-location-code>
</extension-attributes>
<custom-attributes type="array">
<custom-attribute>
<attribute-code>string</attribute-code>
<value>string</value>
</custom-attribute>
</custom-attributes>
</shipping-address>
<billing-address>
<id type="integer">42</id>
<region>string</region>
<region-id type="integer">42</region-id>
<region-code>string</region-code>
<country-id>string</country-id>
<street type="array">
<street>string</street>
</street>
<company>string</company>
<telephone>string</telephone>
<fax>string</fax>
<postcode>string</postcode>
<city>string</city>
<firstname>string</firstname>
<lastname>string</lastname>
<middlename>string</middlename>
<prefix>string</prefix>
<suffix>string</suffix>
<vat-id>string</vat-id>
<customer-id type="integer">42</customer-id>
<email>string</email>
<same-as-billing type="integer">42</same-as-billing>
<customer-address-id type="integer">42</customer-address-id>
<save-in-address-book type="integer">42</save-in-address-book>
<extension-attributes>
<discounts type="array">
<discount>
<discount-data>
<amount type="float">42.0</amount>
<base-amount type="float">42.0</base-amount>
<original-amount type="float">42.0</original-amount>
<base-original-amount type="float">42.0</base-original-amount>
</discount-data>
<rule-label>string</rule-label>
<rule-i-d type="integer">42</rule-i-d>
</discount>
</discounts>
<gift-registry-id type="integer">42</gift-registry-id>
<pickup-location-code>string</pickup-location-code>
</extension-attributes>
<custom-attributes type="array">
<custom-attribute>
<attribute-code>string</attribute-code>
<value>string</value>
</custom-attribute>
</custom-attributes>
</billing-address>
<shipping-method-code>string</shipping-method-code>
<shipping-carrier-code>string</shipping-carrier-code>
<extension-attributes>
<newsletter-subscribe>string</newsletter-subscribe>
</extension-attributes>
<custom-attributes type="array">
<custom-attribute>
<attribute-code>string</attribute-code>
<value>string</value>
</custom-attribute>
</custom-attributes>
</addressInformation>
</root>
Response examples (200)
{
"payment_methods": [
{
"code": "string",
"title": "string"
}
],
"totals": {
"grand_total": 42.0,
"base_grand_total": 42.0,
"subtotal": 42.0,
"base_subtotal": 42.0,
"discount_amount": 42.0,
"base_discount_amount": 42.0,
"subtotal_with_discount": 42.0,
"base_subtotal_with_discount": 42.0,
"shipping_amount": 42.0,
"base_shipping_amount": 42.0,
"shipping_discount_amount": 42.0,
"base_shipping_discount_amount": 42.0,
"tax_amount": 42.0,
"base_tax_amount": 42.0,
"weee_tax_applied_amount": 42.0,
"shipping_tax_amount": 42.0,
"base_shipping_tax_amount": 42.0,
"subtotal_incl_tax": 42.0,
"base_subtotal_incl_tax": 42.0,
"shipping_incl_tax": 42.0,
"base_shipping_incl_tax": 42.0,
"base_currency_code": "string",
"quote_currency_code": "string",
"coupon_code": "string",
"items_qty": 42,
"items": [
{
"item_id": 42,
"price": 42.0,
"base_price": 42.0,
"qty": 42.0,
"row_total": 42.0,
"base_row_total": 42.0,
"row_total_with_discount": 42.0,
"tax_amount": 42.0,
"base_tax_amount": 42.0,
"tax_percent": 42.0,
"discount_amount": 42.0,
"base_discount_amount": 42.0,
"discount_percent": 42.0,
"price_incl_tax": 42.0,
"base_price_incl_tax": 42.0,
"row_total_incl_tax": 42.0,
"base_row_total_incl_tax": 42.0,
"options": "string",
"weee_tax_applied_amount": 42.0,
"weee_tax_applied": "string",
"extension_attributes": {
"negotiable_quote_item_totals": {
"cost": 42.0,
"catalog_price": 42.0,
"base_catalog_price": 42.0,
"catalog_price_incl_tax": 42.0,
"base_catalog_price_incl_tax": 42.0,
"cart_price": 42.0,
"base_cart_price": 42.0,
"cart_tax": 42.0,
"base_cart_tax": 42.0,
"cart_price_incl_tax": 42.0,
"base_cart_price_incl_tax": 42.0,
"extension_attributes": {}
},
"sku": "string",
"manufacturer_name": "string",
"regular_price_incl_tax": "string"
},
"name": "string"
}
],
"total_segments": [
{
"code": "string",
"title": "string",
"value": 42.0,
"area": "string",
"extension_attributes": {
"tax_grandtotal_details": [
{
"amount": 42.0,
"rates": [
{
"percent": "string",
"title": "string"
}
],
"group_id": 42
}
],
"gift_cards": "string",
"gw_order_id": "string",
"gw_item_ids": [
"string"
],
"gw_allow_gift_receipt": "string",
"gw_add_card": "string",
"gw_price": "string",
"gw_base_price": "string",
"gw_items_price": "string",
"gw_items_base_price": "string",
"gw_card_price": "string",
"gw_card_base_price": "string",
"gw_base_tax_amount": "string",
"gw_tax_amount": "string",
"gw_items_base_tax_amount": "string",
"gw_items_tax_amount": "string",
"gw_card_base_tax_amount": "string",
"gw_card_tax_amount": "string",
"gw_price_incl_tax": "string",
"gw_base_price_incl_tax": "string",
"gw_card_price_incl_tax": "string",
"gw_card_base_price_incl_tax": "string",
"gw_items_price_incl_tax": "string",
"gw_items_base_price_incl_tax": "string"
}
}
],
"extension_attributes": {
"coupon_label": "string",
"negotiable_quote_totals": {
"items_count": 42,
"quote_status": "string",
"created_at": "string",
"updated_at": "string",
"customer_group": 42,
"base_to_quote_rate": 42.0,
"cost_total": 42.0,
"base_cost_total": 42.0,
"original_total": 42.0,
"base_original_total": 42.0,
"original_tax": 42.0,
"base_original_tax": 42.0,
"original_price_incl_tax": 42.0,
"base_original_price_incl_tax": 42.0,
"negotiated_price_type": 42,
"negotiated_price_value": 42.0
},
"base_customer_balance_amount": 42.0,
"customer_balance_amount": 42.0,
"coupon_codes": [
"string"
],
"coupons_labels": [
"string"
],
"reward_points_balance": 42.0,
"reward_currency_amount": 42.0,
"base_reward_currency_amount": 42.0
}
},
"extension_attributes": {
"adyen_payment_methods_response": "string",
"adyen_connected_terminals": "string"
}
}
Response examples (200)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<payment-methods type="array">
<payment-method>
<code>string</code>
<title>string</title>
</payment-method>
</payment-methods>
<totals>
<grand-total type="float">42.0</grand-total>
<base-grand-total type="float">42.0</base-grand-total>
<subtotal type="float">42.0</subtotal>
<base-subtotal type="float">42.0</base-subtotal>
<discount-amount type="float">42.0</discount-amount>
<base-discount-amount type="float">42.0</base-discount-amount>
<subtotal-with-discount type="float">42.0</subtotal-with-discount>
<base-subtotal-with-discount type="float">42.0</base-subtotal-with-discount>
<shipping-amount type="float">42.0</shipping-amount>
<base-shipping-amount type="float">42.0</base-shipping-amount>
<shipping-discount-amount type="float">42.0</shipping-discount-amount>
<base-shipping-discount-amount type="float">42.0</base-shipping-discount-amount>
<tax-amount type="float">42.0</tax-amount>
<base-tax-amount type="float">42.0</base-tax-amount>
<weee-tax-applied-amount type="float">42.0</weee-tax-applied-amount>
<shipping-tax-amount type="float">42.0</shipping-tax-amount>
<base-shipping-tax-amount type="float">42.0</base-shipping-tax-amount>
<subtotal-incl-tax type="float">42.0</subtotal-incl-tax>
<base-subtotal-incl-tax type="float">42.0</base-subtotal-incl-tax>
<shipping-incl-tax type="float">42.0</shipping-incl-tax>
<base-shipping-incl-tax type="float">42.0</base-shipping-incl-tax>
<base-currency-code>string</base-currency-code>
<quote-currency-code>string</quote-currency-code>
<coupon-code>string</coupon-code>
<items-qty type="integer">42</items-qty>
<items type="array">
<item>
<item-id type="integer">42</item-id>
<price type="float">42.0</price>
<base-price type="float">42.0</base-price>
<qty type="float">42.0</qty>
<row-total type="float">42.0</row-total>
<base-row-total type="float">42.0</base-row-total>
<row-total-with-discount type="float">42.0</row-total-with-discount>
<tax-amount type="float">42.0</tax-amount>
<base-tax-amount type="float">42.0</base-tax-amount>
<tax-percent type="float">42.0</tax-percent>
<discount-amount type="float">42.0</discount-amount>
<base-discount-amount type="float">42.0</base-discount-amount>
<discount-percent type="float">42.0</discount-percent>
<price-incl-tax type="float">42.0</price-incl-tax>
<base-price-incl-tax type="float">42.0</base-price-incl-tax>
<row-total-incl-tax type="float">42.0</row-total-incl-tax>
<base-row-total-incl-tax type="float">42.0</base-row-total-incl-tax>
<options>string</options>
<weee-tax-applied-amount type="float">42.0</weee-tax-applied-amount>
<weee-tax-applied>string</weee-tax-applied>
<extension-attributes>
<negotiable-quote-item-totals>
<cost type="float">42.0</cost>
<catalog-price type="float">42.0</catalog-price>
<base-catalog-price type="float">42.0</base-catalog-price>
<catalog-price-incl-tax type="float">42.0</catalog-price-incl-tax>
<base-catalog-price-incl-tax type="float">42.0</base-catalog-price-incl-tax>
<cart-price type="float">42.0</cart-price>
<base-cart-price type="float">42.0</base-cart-price>
<cart-tax type="float">42.0</cart-tax>
<base-cart-tax type="float">42.0</base-cart-tax>
<cart-price-incl-tax type="float">42.0</cart-price-incl-tax>
<base-cart-price-incl-tax type="float">42.0</base-cart-price-incl-tax>
<extension-attributes>
</extension-attributes>
</negotiable-quote-item-totals>
<sku>string</sku>
<manufacturer-name>string</manufacturer-name>
<regular-price-incl-tax>string</regular-price-incl-tax>
</extension-attributes>
<name>string</name>
</item>
</items>
<total-segments type="array">
<total-segment>
<code>string</code>
<title>string</title>
<value type="float">42.0</value>
<area>string</area>
<extension-attributes>
<tax-grandtotal-details type="array">
<tax-grandtotal-detail>
<amount type="float">42.0</amount>
<rates type="array">
<rate>
<percent>string</percent>
<title>string</title>
</rate>
</rates>
<group-id type="integer">42</group-id>
</tax-grandtotal-detail>
</tax-grandtotal-details>
<gift-cards>string</gift-cards>
<gw-order-id>string</gw-order-id>
<gw-item-ids type="array">
<gw-item-id>string</gw-item-id>
</gw-item-ids>
<gw-allow-gift-receipt>string</gw-allow-gift-receipt>
<gw-add-card>string</gw-add-card>
<gw-price>string</gw-price>
<gw-base-price>string</gw-base-price>
<gw-items-price>string</gw-items-price>
<gw-items-base-price>string</gw-items-base-price>
<gw-card-price>string</gw-card-price>
<gw-card-base-price>string</gw-card-base-price>
<gw-base-tax-amount>string</gw-base-tax-amount>
<gw-tax-amount>string</gw-tax-amount>
<gw-items-base-tax-amount>string</gw-items-base-tax-amount>
<gw-items-tax-amount>string</gw-items-tax-amount>
<gw-card-base-tax-amount>string</gw-card-base-tax-amount>
<gw-card-tax-amount>string</gw-card-tax-amount>
<gw-price-incl-tax>string</gw-price-incl-tax>
<gw-base-price-incl-tax>string</gw-base-price-incl-tax>
<gw-card-price-incl-tax>string</gw-card-price-incl-tax>
<gw-card-base-price-incl-tax>string</gw-card-base-price-incl-tax>
<gw-items-price-incl-tax>string</gw-items-price-incl-tax>
<gw-items-base-price-incl-tax>string</gw-items-base-price-incl-tax>
</extension-attributes>
</total-segment>
</total-segments>
<extension-attributes>
<coupon-label>string</coupon-label>
<negotiable-quote-totals>
<items-count type="integer">42</items-count>
<quote-status>string</quote-status>
<created-at>string</created-at>
<updated-at>string</updated-at>
<customer-group type="integer">42</customer-group>
<base-to-quote-rate type="float">42.0</base-to-quote-rate>
<cost-total type="float">42.0</cost-total>
<base-cost-total type="float">42.0</base-cost-total>
<original-total type="float">42.0</original-total>
<base-original-total type="float">42.0</base-original-total>
<original-tax type="float">42.0</original-tax>
<base-original-tax type="float">42.0</base-original-tax>
<original-price-incl-tax type="float">42.0</original-price-incl-tax>
<base-original-price-incl-tax type="float">42.0</base-original-price-incl-tax>
<negotiated-price-type type="integer">42</negotiated-price-type>
<negotiated-price-value type="float">42.0</negotiated-price-value>
</negotiable-quote-totals>
<base-customer-balance-amount type="float">42.0</base-customer-balance-amount>
<customer-balance-amount type="float">42.0</customer-balance-amount>
<coupon-codes type="array">
<coupon-code>string</coupon-code>
</coupon-codes>
<coupons-labels type="array">
<coupons-label>string</coupons-label>
</coupons-labels>
<reward-points-balance type="float">42.0</reward-points-balance>
<reward-currency-amount type="float">42.0</reward-currency-amount>
<base-reward-currency-amount type="float">42.0</base-reward-currency-amount>
</extension-attributes>
</totals>
<extension-attributes>
<adyen-payment-methods-response>string</adyen-payment-methods-response>
<adyen-connected-terminals>string</adyen-connected-terminals>
</extension-attributes>
</root>
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 (401)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<message>string</message>
<errors type="array">
<error>
<message>string</message>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
</error>
</errors>
<code type="integer">42</code>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
<trace>string</trace>
</root>
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"
}
Response examples (default)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<message>string</message>
<errors type="array">
<error>
<message>string</message>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
</error>
</errors>
<code type="integer">42</code>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
<trace>string</trace>
</root>