ReDoc documentation
Enables an administrative user to return information for a specified cart.
200 Success.
400 Bad Request
401 Unauthorized
Unexpected error
{- "id": 0,
- "created_at": "string",
- "updated_at": "string",
- "converted_at": "string",
- "is_active": true,
- "is_virtual": true,
- "items": [
- {
- "item_id": 0,
- "sku": "string",
- "qty": 0,
- "name": "string",
- "price": 0,
- "product_type": "string",
- "quote_id": "string",
- "product_option": {
- "extension_attributes": {
- "custom_options": [
- {
- "option_id": "string",
- "option_value": "string",
- "extension_attributes": {
- "file_info": null
}
}
], - "bundle_options": [
- {
- "option_id": 0,
- "option_qty": 0,
- "option_selections": [
- null
], - "extension_attributes": { }
}
], - "downloadable_option": {
- "downloadable_links": [
- 0
]
}, - "giftcard_item_option": {
- "giftcard_amount": "string",
- "custom_giftcard_amount": 0,
- "giftcard_sender_name": "string",
- "giftcard_recipient_name": "string",
- "giftcard_sender_email": "string",
- "giftcard_recipient_email": "string",
- "giftcard_message": "string",
- "extension_attributes": {
- "giftcard_created_codes": [
- null
]
}
}, - "configurable_item_options": [
- {
- "option_id": "string",
- "option_value": 0,
- "extension_attributes": { }
}
], - "grouped_options": [
- {
- "id": 0,
- "qty": 0,
- "extension_attributes": { }
}
]
}
}, - "extension_attributes": {
- "discounts": [
- {
- "discount_data": {
- "amount": 0,
- "base_amount": 0,
- "original_amount": 0,
- "base_original_amount": 0
}, - "rule_label": "string",
- "rule_id": 0
}
], - "negotiable_quote_item": {
- "item_id": 0,
- "original_price": 0,
- "original_tax_amount": 0,
- "original_discount_amount": 0,
- "extension_attributes": { }
}
}
}
], - "items_count": 0,
- "items_qty": 0,
- "customer": {
- "id": 0,
- "group_id": 0,
- "default_billing": "string",
- "default_shipping": "string",
- "confirmation": "string",
- "created_at": "string",
- "updated_at": "string",
- "created_in": "string",
- "dob": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "middlename": "string",
- "prefix": "string",
- "suffix": "string",
- "gender": 0,
- "store_id": 0,
- "taxvat": "string",
- "website_id": 0,
- "addresses": [
- {
- "id": 0,
- "customer_id": 0,
- "region": {
- "region_code": "string",
- "region": "string",
- "region_id": 0,
- "extension_attributes": { }
}, - "region_id": 0,
- "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",
- "default_shipping": true,
- "default_billing": true,
- "extension_attributes": { },
- "custom_attributes": [
- {
- "attribute_code": "string",
- "value": "string"
}
]
}
], - "disable_auto_group_change": 0,
- "extension_attributes": {
- "company_attributes": {
- "customer_id": 0,
- "company_id": 0,
- "job_title": "string",
- "status": 0,
- "telephone": "string",
- "extension_attributes": { }
}, - "assistance_allowed": 0,
- "is_subscribed": true
}, - "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_id": 0
}
], - "gift_registry_id": 0,
- "pickup_location_code": "string",
- "bolt_id": "string"
}, - "custom_attributes": [
- {
- "attribute_code": "string",
- "value": "string"
}
]
}, - "reserved_order_id": "string",
- "orig_order_id": 0,
- "currency": {
- "global_currency_code": "string",
- "base_currency_code": "string",
- "store_currency_code": "string",
- "quote_currency_code": "string",
- "store_to_base_rate": 0,
- "store_to_quote_rate": 0,
- "base_to_global_rate": 0,
- "base_to_quote_rate": 0,
- "extension_attributes": { }
}, - "customer_is_guest": true,
- "customer_note": "string",
- "customer_note_notify": true,
- "customer_tax_class_id": 0,
- "store_id": 0,
- "extension_attributes": {
- "shipping_assignments": [
- {
- "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": [
- null
], - "gift_registry_id": 0,
- "pickup_location_code": "string",
- "bolt_id": "string"
}, - "custom_attributes": [
- {
- "attribute_code": null,
- "value": null
}
]
}, - "method": "string",
- "extension_attributes": { }
}, - "items": [
- {
- "item_id": 0,
- "sku": "string",
- "qty": 0,
- "name": "string",
- "price": 0,
- "product_type": "string",
- "quote_id": "string",
- "product_option": {
- "extension_attributes": {
- "custom_options": [ ],
- "bundle_options": [ ],
- "downloadable_option": null,
- "giftcard_item_option": null,
- "configurable_item_options": [ ],
- "grouped_options": [ ]
}
}, - "extension_attributes": {
- "discounts": [
- null
], - "negotiable_quote_item": {
- "item_id": null,
- "original_price": null,
- "original_tax_amount": null,
- "original_discount_amount": null,
- "extension_attributes": null
}
}
}
], - "extension_attributes": { }
}
], - "negotiable_quote": {
- "quote_id": 0,
- "is_regular_quote": true,
- "status": "string",
- "negotiated_price_type": 0,
- "negotiated_price_value": 0,
- "shipping_price": 0,
- "quote_name": "string",
- "expiration_period": "string",
- "email_notification_status": 0,
- "has_unconfirmed_changes": true,
- "is_shipping_tax_changed": true,
- "is_customer_price_changed": true,
- "notifications": 0,
- "applied_rule_ids": "string",
- "is_address_draft": true,
- "deleted_sku": "string",
- "creator_id": 0,
- "creator_type": 0,
- "original_total_price": 0,
- "base_original_total_price": 0,
- "negotiated_total_price": 0,
- "base_negotiated_total_price": 0,
- "extension_attributes": { }
}
}
}
Assigns a specified customer to a specified shopping cart.
200 Success.
400 Bad Request
401 Unauthorized
Internal Server error
Unexpected error
{- "customerId": 0,
- "storeId": 0
}
true