ReDoc documentation
required | object (checkout-data-shipping-information-interface) Interface ShippingInformationInterface |
200 Success.
401 Unauthorized
Unexpected error
{- "addressInformation": {
- "shipping_address": {
- "id": 0,
- "region": "string",
- "region_id": 0,
- "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": 0,
- "email": "string",
- "same_as_billing": 0,
- "customer_address_id": 0,
- "save_in_address_book": 0,
- "extension_attributes": {
- "discounts": [
- {
- "discount_data": {
- "amount": 0,
- "base_amount": 0,
- "original_amount": 0,
- "base_original_amount": 0
}, - "rule_label": "string",
- "rule_i_d": 0
}
], - "gift_registry_id": 0,
- "pickup_location_code": "string"
}, - "custom_attributes": [
- {
- "attribute_code": "string",
- "value": "string"
}
]
}, - "billing_address": {
- "id": 0,
- "region": "string",
- "region_id": 0,
- "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": 0,
- "email": "string",
- "same_as_billing": 0,
- "customer_address_id": 0,
- "save_in_address_book": 0,
- "extension_attributes": {
- "discounts": [
- {
- "discount_data": {
- "amount": 0,
- "base_amount": 0,
- "original_amount": 0,
- "base_original_amount": 0
}, - "rule_label": "string",
- "rule_i_d": 0
}
], - "gift_registry_id": 0,
- "pickup_location_code": "string"
}, - "custom_attributes": [
- {
- "attribute_code": "string",
- "value": "string"
}
]
}, - "shipping_method_code": "string",
- "shipping_carrier_code": "string",
- "extension_attributes": { },
- "custom_attributes": [
- {
- "attribute_code": "string",
- "value": "string"
}
]
}
}
{- "payment_methods": [
- {
- "code": "string",
- "title": "string"
}
], - "totals": {
- "grand_total": 0,
- "base_grand_total": 0,
- "subtotal": 0,
- "base_subtotal": 0,
- "discount_amount": 0,
- "base_discount_amount": 0,
- "subtotal_with_discount": 0,
- "base_subtotal_with_discount": 0,
- "shipping_amount": 0,
- "base_shipping_amount": 0,
- "shipping_discount_amount": 0,
- "base_shipping_discount_amount": 0,
- "tax_amount": 0,
- "base_tax_amount": 0,
- "weee_tax_applied_amount": 0,
- "shipping_tax_amount": 0,
- "base_shipping_tax_amount": 0,
- "subtotal_incl_tax": 0,
- "base_subtotal_incl_tax": 0,
- "shipping_incl_tax": 0,
- "base_shipping_incl_tax": 0,
- "base_currency_code": "string",
- "quote_currency_code": "string",
- "coupon_code": "string",
- "items_qty": 0,
- "items": [
- {
- "item_id": 0,
- "price": 0,
- "base_price": 0,
- "qty": 0,
- "row_total": 0,
- "base_row_total": 0,
- "row_total_with_discount": 0,
- "tax_amount": 0,
- "base_tax_amount": 0,
- "tax_percent": 0,
- "discount_amount": 0,
- "base_discount_amount": 0,
- "discount_percent": 0,
- "price_incl_tax": 0,
- "base_price_incl_tax": 0,
- "row_total_incl_tax": 0,
- "base_row_total_incl_tax": 0,
- "options": "string",
- "weee_tax_applied_amount": 0,
- "weee_tax_applied": "string",
- "extension_attributes": {
- "negotiable_quote_item_totals": {
- "cost": 0,
- "catalog_price": 0,
- "base_catalog_price": 0,
- "catalog_price_incl_tax": 0,
- "base_catalog_price_incl_tax": 0,
- "cart_price": 0,
- "base_cart_price": 0,
- "cart_tax": 0,
- "base_cart_tax": 0,
- "cart_price_incl_tax": 0,
- "base_cart_price_incl_tax": 0,
- "extension_attributes": { }
}
}, - "name": "string"
}
], - "total_segments": [
- {
- "code": "string",
- "title": "string",
- "value": 0,
- "area": "string",
- "extension_attributes": {
- "tax_grandtotal_details": [
- {
- "amount": 0,
- "rates": [
- null
], - "group_id": 0
}
], - "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": 0,
- "quote_status": "string",
- "created_at": "string",
- "updated_at": "string",
- "customer_group": 0,
- "base_to_quote_rate": 0,
- "cost_total": 0,
- "base_cost_total": 0,
- "original_total": 0,
- "base_original_total": 0,
- "original_tax": 0,
- "base_original_tax": 0,
- "original_price_incl_tax": 0,
- "base_original_price_incl_tax": 0,
- "negotiated_price_type": 0,
- "negotiated_price_value": 0
}, - "base_customer_balance_amount": 0,
- "customer_balance_amount": 0,
- "coupon_codes": [
- "string"
], - "coupons_labels": [
- "string"
], - "reward_points_balance": 0,
- "reward_currency_amount": 0,
- "base_reward_currency_amount": 0
}
}, - "extension_attributes": { }
}