Module magento.cart
ballerinax/magento.cart Ballerina library
1.3.2
Overview
The Magento REST API v2.2 connector(https://devdocs.magento.com/guides/v2.4/rest/bk-rest.html) OpenAPI specification.
The Magento B2B Rest API service enables applications to build and manage a customized commerce store.
Key Features
- Programmatic access to create and manage resources via REST API
- Secure authentication with API key or OAuth support
- Seamless integration with REST API endpoints
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Obtain tokens by following this guide
Clients
magento.cart: Client
Isolated
This is a generated connector for Magento REST API v2.2 OpenAPI specification. The Magento B2B Rest API service enables applications to build and manage a customized commerce store.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Follow this guide and obtain tokens.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
createEmptyCartForGuest
Isolated FunctionRemote Function
Creates an empty cart and quote for a guest
checkGiftCardAddedToCart
Isolated FunctionRemote Function
Checks gift card balance if added to the cart
addGiftCardToGuestCart
Isolated FunctionRemote Function
function addGiftCardToGuestCart(string cartId, CartidGiftcardsBody payload) returns boolean|errorAdds gift card to the cart
deleteGiftCardAccountByQuoteId
Isolated FunctionRemote Function
Removes GiftCard Account entity
listsActiveCheckoutAgreements
Isolated FunctionRemote Function
function listsActiveCheckoutAgreements() returns CheckoutAgreementsDataAgreementInterface[]|errorLists active checkout agreements.
Return Type
- CheckoutAgreementsDataAgreementInterface[]|error - 200 Success.
getInformationForCartForSpecifiedCustomer
Isolated FunctionRemote Function
function getInformationForCartForSpecifiedCustomer() returns QuoteDataCartInterface|errorReturns information for the cart for a specified customer
Return Type
- QuoteDataCartInterface|error - 200 Success.
saveQuote
Isolated FunctionRemote Function
function saveQuote(CartsMineBody payload) returns Response|errorSaves quote
Parameters
- payload CartsMineBody -
createEmptyCartForCustomerIfNoCart
Isolated FunctionRemote Function
Creates an empty cart and quote for a specified customer if customer does not have a cart yet.
applyStoreCreditCustomerBalance
Isolated FunctionRemote Function
Applies store credit
unapplyStoreCreditCustomerBalance
Isolated FunctionRemote Function
Unapplies store credit.
getBillingAddressForSpecifiedQuote
Isolated FunctionRemote Function
function getBillingAddressForSpecifiedQuote() returns QuoteDataAddressInterface|errorReturns the billing address for a specified quote
Return Type
- QuoteDataAddressInterface|error - 200 Success.
assignsSpecifiedBillingAddress
Isolated FunctionRemote Function
function assignsSpecifiedBillingAddress(MineBillingaddressBody payload) returns int|errorAssigns a specified billing address to a specified cart
Parameters
- payload MineBillingaddressBody -
getGiftCardBalanceIfAppliedGivenCart
Isolated FunctionRemote Function
Checks gift card balance if applied to given cart
Parameters
- giftCardCode string -
saveCheckoutFields
Isolated FunctionRemote Function
function saveCheckoutFields(MineCheckoutfieldsBody payload) returns Response|errorSaves Checkout Fields
Parameters
- payload MineCheckoutfieldsBody -
setShippingBillingMethodsAndCollectTotal
Isolated FunctionRemote Function
function setShippingBillingMethodsAndCollectTotal(MineCollecttotalsBody payload) returns QuoteDataTotalsInterface|errorSets shipping/billing methods and additional data for cart and collect totals.
Parameters
- payload MineCollecttotalsBody -
Return Type
- QuoteDataTotalsInterface|error - 200 Success.
saveSearchRequest
Isolated FunctionRemote Function
function saveSearchRequest(CollectionpointSearchrequestBody payload) returns TemandoShippingDataCollectionPointSearchRequestInterface|errorShipping collection point search request
Parameters
- payload CollectionpointSearchrequestBody -
Return Type
- TemandoShippingDataCollectionPointSearchRequestInterface|error - 200 Success.
deleteCartCollectionPointSearchRequest
Isolated FunctionRemote Function
Deletes cart collection point search request
getCollectionPointsSearchRequest
Isolated FunctionRemote Function
function getCollectionPointsSearchRequest() returns TemandoShippingDataCollectionPointQuoteCollectionPointInterface[]|errorGets collection points search request
Return Type
- TemandoShippingDataCollectionPointQuoteCollectionPointInterface[]|error - 200 Success.
selectCollectionPoint
Isolated FunctionRemote Function
function selectCollectionPoint(CollectionpointSelectBody payload) returns boolean|errorSelects cart collection point
Parameters
- payload CollectionpointSelectBody -
getInformationForCoupon
Isolated FunctionRemote Function
Returns information for a coupon in a specified cart
deleteCouponFromCart
Isolated FunctionRemote Function
Deletes a coupon from a specified cart
addCouponByCodeToCart
Isolated FunctionRemote Function
Adds a coupon by code to a specified cart
Parameters
- couponCode string - The coupon code data.
handleSelectedDeliveryOption
Isolated FunctionRemote Function
function handleSelectedDeliveryOption(MineDeliveryoptionBody payload) returns Response|errorHandles selected delivery option
Parameters
- payload MineDeliveryoptionBody -
estimateShippingByExtendedAddress
Isolated FunctionRemote Function
function estimateShippingByExtendedAddress(MineEstimateshippingmethodsBody payload) returns QuoteDataShippingMethodInterface[]|errorEstimates shipping by address and return list of available shipping methods
Parameters
- payload MineEstimateshippingmethodsBody -
Return Type
- QuoteDataShippingMethodInterface[]|error - 200 Success.
estimateShippingMethodsByAddressId
Isolated FunctionRemote Function
function estimateShippingMethodsByAddressId(MineEstimateshippingmethodsbyaddressidBody payload) returns QuoteDataShippingMethodInterface[]|errorEstimates shipping
Parameters
Return Type
- QuoteDataShippingMethodInterface[]|error - 200 Success.
getGiftMessageForSpecifiedOrder
Isolated FunctionRemote Function
function getGiftMessageForSpecifiedOrder() returns GiftMessageDataMessageInterface|errorReturns the gift message for a specified order
Return Type
- GiftMessageDataMessageInterface|error - 200 Success.
setGiftMessageForAnOrder
Isolated FunctionRemote Function
function setGiftMessageForAnOrder(MineGiftmessageBody payload) returns boolean|errorSets the gift message for an entire order
Parameters
- payload MineGiftmessageBody -
getGiftMessageForSpecifiedItem
Isolated FunctionRemote Function
function getGiftMessageForSpecifiedItem(int itemId) returns GiftMessageDataMessageInterface|errorReturns the gift message for a specified item in a specified shopping cart
Parameters
- itemId int - The item ID.
Return Type
- GiftMessageDataMessageInterface|error - 200 Success.
setGiftMessageForSpecifiedItem
Isolated FunctionRemote Function
function setGiftMessageForSpecifiedItem(int itemId, GiftmessageItemidBody payload) returns boolean|errorSets the gift message for a specified item in a specified shopping cart
addGiftCardToCart
Isolated FunctionRemote Function
function addGiftCardToCart(MineGiftcardsBody payload) returns boolean|errorAdds gift card to the cart
Parameters
- payload MineGiftcardsBody -
removeGiftCardAccountEntity
Isolated FunctionRemote Function
Removes GiftCard Account entity
Parameters
- giftCardCode string -
listItemsAssignedToSpecifiedCart
Isolated FunctionRemote Function
function listItemsAssignedToSpecifiedCart() returns QuoteDataCartItemInterface[]|errorLists items that are assigned to a specified cart
Return Type
- QuoteDataCartItemInterface[]|error - 200 Success.
addOrUpdateSpecificCartItem
Isolated FunctionRemote Function
function addOrUpdateSpecificCartItem(MineItemsBody payload) returns QuoteDataCartItemInterface|errorAdds/updates the specified cart item
Parameters
- payload MineItemsBody -
Return Type
- QuoteDataCartItemInterface|error - 200 Success.
addOrUpdateSpecificCartItemByID
Isolated FunctionRemote Function
function addOrUpdateSpecificCartItemByID(string itemId, ItemsItemidBody payload) returns QuoteDataCartItemInterface|errorAdds/updates the specified cart item
Return Type
- QuoteDataCartItemInterface|error - 200 Success.
removesTheSpecifiedItemFromSpecifiedCart
Isolated FunctionRemote Function
Removes the specified item from the specified cart
Parameters
- itemId int - The item ID of the item to be removed.
placeAnOrderForSpecifiedCart
Isolated FunctionRemote Function
function placeAnOrderForSpecifiedCart(MineOrderBody payload) returns int|errorPlaces an order for a specified cart
Parameters
- payload MineOrderBody -
getPaymentInformation
Isolated FunctionRemote Function
function getPaymentInformation() returns CheckoutDataPaymentDetailsInterface|errorGets payment information
Return Type
- CheckoutDataPaymentDetailsInterface|error - 200 Success.
savePaymentInformationAndPlaceOrderForSpecifiedCart
Isolated FunctionRemote Function
function savePaymentInformationAndPlaceOrderForSpecifiedCart(MinePaymentinformationBody payload) returns int|errorSets payment information and place order for a specified cart
Parameters
- payload MinePaymentinformationBody -
listAvailablePaymentMethodsForSpecifiedShoppingCart
Isolated FunctionRemote Function
function listAvailablePaymentMethodsForSpecifiedShoppingCart() returns QuoteDataPaymentMethodInterface[]|errorLists available payment methods for a specified shopping cart
Return Type
- QuoteDataPaymentMethodInterface[]|error - 200 Success.
getThePaymentMethodForSpecifiedShoppingCart
Isolated FunctionRemote Function
function getThePaymentMethodForSpecifiedShoppingCart() returns QuoteDataPaymentInterface|errorReturns the payment method for a specified shopping cart
Return Type
- QuoteDataPaymentInterface|error - 200 Success.
addSpecifiedPaymentMethodSpecifiedShoppingCart
Isolated FunctionRemote Function
function addSpecifiedPaymentMethodSpecifiedShoppingCart(MineSelectedpaymentmethodBody payload) returns string|errorAdds a specified payment method to a specified shopping cart
Parameters
- payload MineSelectedpaymentmethodBody -
setPaymentInformationForSpecifiedCart
Isolated FunctionRemote Function
function setPaymentInformationForSpecifiedCart(MineSetpaymentinformationBody payload) returns int|errorSets payment information for a specified cart
Parameters
- payload MineSetpaymentinformationBody -
saveAddressInformation
Isolated FunctionRemote Function
function saveAddressInformation(MineShippinginformationBody payload) returns CheckoutDataPaymentDetailsInterface|errorSaves address information
Parameters
- payload MineShippinginformationBody -
Return Type
- CheckoutDataPaymentDetailsInterface|error - 200 Success.
listApplicableShippingMethodsForSpecifiedQuote
Isolated FunctionRemote Function
function listApplicableShippingMethodsForSpecifiedQuote() returns QuoteDataShippingMethodInterface[]|errorLists applicable shipping methods for a specified quote
Return Type
- QuoteDataShippingMethodInterface[]|error - 200 Success.
getQuoteTotalDataForSpecifiedCart
Isolated FunctionRemote Function
function getQuoteTotalDataForSpecifiedCart() returns QuoteDataTotalsInterface|errorReturns quote totals data for a specified cart
Return Type
- QuoteDataTotalsInterface|error - 200 Success.
calculateQuoteTotalBasedOnAddressAndShippingMethod
Isolated FunctionRemote Function
function calculateQuoteTotalBasedOnAddressAndShippingMethod(MineTotalsinformationBody payload) returns QuoteDataTotalsInterface|errorCalculates quote totals based on address and shipping method
Parameters
- payload MineTotalsinformationBody -
Return Type
- QuoteDataTotalsInterface|error - 200 Success.
enablesAdministrativeUsersToListCarts
Isolated FunctionRemote Function
function enablesAdministrativeUsersToListCarts(string? searchcriteriaFiltergroups0Filters0Field, string? searchcriteriaFiltergroups0Filters0Value, string? searchcriteriaFiltergroups0Filters0Conditiontype, string? searchcriteriaSortorders0Field, string? searchcriteriaSortorders0Direction, int? searchcriteriaPagesize, int? searchcriteriaCurrentpage) returns QuoteDataCartSearchResultsInterface|errorEnables administrative users to list carts that match specified search criteria
Parameters
- searchcriteriaFiltergroups0Filters0Field string? (default ()) - Field
- searchcriteriaFiltergroups0Filters0Value string? (default ()) - Value
- searchcriteriaFiltergroups0Filters0Conditiontype string? (default ()) - Condition type
- searchcriteriaSortorders0Field string? (default ()) - Sorting field.
- searchcriteriaSortorders0Direction string? (default ()) - Sorting direction.
- searchcriteriaPagesize int? (default ()) - Page size.
- searchcriteriaCurrentpage int? (default ()) - Current page.
Return Type
- QuoteDataCartSearchResultsInterface|error - 200 Success.
enablesAdministrativeUserToReturnInformation
Isolated FunctionRemote Function
function enablesAdministrativeUserToReturnInformation(int cartId) returns QuoteDataCartInterface|errorEnables an administrative user to return information for a specified cart
Parameters
- cartId int -
Return Type
- QuoteDataCartInterface|error - 200 Success.
assignSpecifiedCustomerToShoppingCart
Isolated FunctionRemote Function
function assignSpecifiedCustomerToShoppingCart(int cartId, CartsCartidBody payload) returns boolean|errorAssigns a specified customer to a specified shopping cart
quoteBillingAddressForSpecifiedQuote
Isolated FunctionRemote Function
function quoteBillingAddressForSpecifiedQuote(int cartId) returns QuoteDataAddressInterface|errorReturns the billing address for a specified quote
Parameters
- cartId int - The cart ID.
Return Type
- QuoteDataAddressInterface|error - 200 Success.
assignBillingAddressToSpecifiedCartByID
Isolated FunctionRemote Function
function assignBillingAddressToSpecifiedCartByID(int cartId, CartidBillingaddressBody payload) returns int|errorAssigns a specified billing address to a specified cart
getInformationForCouponInSpecifiedCart
Isolated FunctionRemote Function
Returns information for a coupon in a specified cart
Parameters
- cartId int - The cart ID.
deleteCouponFromASpecCartByID
Isolated FunctionRemote Function
Deletes a coupon from a specified cart
Parameters
- cartId int - The cart ID.
addQuoteCouponByCodeToSpecifiedCartByID
Isolated FunctionRemote Function
function addQuoteCouponByCodeToSpecifiedCartByID(int cartId, string couponCode) returns boolean|errorAdds a coupon by code to a specified cart
estimateShippingByAddressByCartID
Isolated FunctionRemote Function
function estimateShippingByAddressByCartID(string cartId, CartidEstimateshippingmethodsBody payload) returns QuoteDataShippingMethodInterface[]|errorEstimates shipping by address and return list of available shipping methods
Return Type
- QuoteDataShippingMethodInterface[]|error - 200 Success.
estimateShippingMethodsByAddressIdAndCartID
Isolated FunctionRemote Function
function estimateShippingMethodsByAddressIdAndCartID(int cartId, CartidEstimateshippingmethodsbyaddressidBody payload) returns QuoteDataShippingMethodInterface[]|errorEstimates shipping
Return Type
- QuoteDataShippingMethodInterface[]|error - 200 Success.
getGiftMessageForSpecificOrderByCartID
Isolated FunctionRemote Function
function getGiftMessageForSpecificOrderByCartID(int cartId) returns GiftMessageDataMessageInterface|errorReturns the gift message for a specified order
Parameters
- cartId int - The shopping cart ID.
Return Type
- GiftMessageDataMessageInterface|error - 200 Success.
setGiftMessageForEntireOrderByCartID
Isolated FunctionRemote Function
function setGiftMessageForEntireOrderByCartID(int cartId, CartidGiftmessageBody payload) returns boolean|errorSets the gift message for an entire order
getGiftMessageForSpecificItemOfSpecShopping
Isolated FunctionRemote Function
function getGiftMessageForSpecificItemOfSpecShopping(int cartId, int itemId) returns GiftMessageDataMessageInterface|errorReturns the gift message for a specified item in a specified shopping cart
Return Type
- GiftMessageDataMessageInterface|error - 200 Success.
setGiftMessageForSpecItemInASpecShopping
Isolated FunctionRemote Function
function setGiftMessageForSpecItemInASpecShopping(int cartId, int itemId, GiftmessageItemidBody2 payload) returns boolean|errorSets the gift message for a specified item in a specified shopping cart
removeGiftCardAccountEntityByCartID
Isolated FunctionRemote Function
Removes GiftCard Account entity
listItemsAssignedToSpecificCart
Isolated FunctionRemote Function
function listItemsAssignedToSpecificCart(int cartId) returns QuoteDataCartItemInterface[]|errorLists items that are assigned to a specified cart
Parameters
- cartId int - The cart ID.
Return Type
- QuoteDataCartItemInterface[]|error - 200 Success.
addOrUpdateTheSpecificCartItem
Isolated FunctionRemote Function
function addOrUpdateTheSpecificCartItem(string cartId, string itemId, ItemsItemidBody2 payload) returns QuoteDataCartItemInterface|errorAdds/updates the specified cart item
Return Type
- QuoteDataCartItemInterface|error - 200 Success.
removesSpecificItemFromSpecifiedCart
Isolated FunctionRemote Function
Removes the specified item from the specified cart
placesAnOrderForSpecifiedCart
Isolated FunctionRemote Function
function placesAnOrderForSpecifiedCart(int cartId, CartidOrderBody payload) returns int|errorPlaces an order for a specified cart
listAvailablePaymentMethodsForShoppingCart
Isolated FunctionRemote Function
function listAvailablePaymentMethodsForShoppingCart(int cartId) returns QuoteDataPaymentMethodInterface[]|errorLists available payment methods for a specified shopping cart
Parameters
- cartId int - The cart ID.
Return Type
- QuoteDataPaymentMethodInterface[]|error - 200 Success.
getPaymentMethodForSpecifiedShoppingCartByID
Isolated FunctionRemote Function
function getPaymentMethodForSpecifiedShoppingCartByID(int cartId) returns QuoteDataPaymentInterface|errorReturns the payment method for a specified shopping cart
Parameters
- cartId int - The cart ID.
Return Type
- QuoteDataPaymentInterface|error - 200 Success.
addSpecifiedPaymentMethodToSpecifiedShoppingCart
Isolated FunctionRemote Function
function addSpecifiedPaymentMethodToSpecifiedShoppingCart(int cartId, CartidSelectedpaymentmethodBody payload) returns string|errorAdds a specified payment method to a specified shopping cart
checkoutShippingInformationByID
Isolated FunctionRemote Function
function checkoutShippingInformationByID(int cartId, CartidShippinginformationBody payload) returns CheckoutDataPaymentDetailsInterface|errorchecks out Shipping Information By ID
Return Type
- CheckoutDataPaymentDetailsInterface|error - 200 Success.
getApplicableShippingMethodsForSpecifiedQuote
Isolated FunctionRemote Function
function getApplicableShippingMethodsForSpecifiedQuote(int cartId) returns QuoteDataShippingMethodInterface[]|errorLists applicable shipping methods for a specified quote
Parameters
- cartId int - The shopping cart ID.
Return Type
- QuoteDataShippingMethodInterface[]|error - 200 Success.
getQuoteTotalsDataForASpecifiedCart
Isolated FunctionRemote Function
function getQuoteTotalsDataForASpecifiedCart(int cartId) returns QuoteDataTotalsInterface|errorReturns quote totals data for a specified cart
Parameters
- cartId int - The cart ID.
Return Type
- QuoteDataTotalsInterface|error - 200 Success.
checkoutTotalsBasedOnAddressAndShippingMethod
Isolated FunctionRemote Function
function checkoutTotalsBasedOnAddressAndShippingMethod(int cartId, CartidTotalsinformationBody payload) returns QuoteDataTotalsInterface|errorCalculates quote totals based on address and shipping method
Return Type
- QuoteDataTotalsInterface|error - 200 Success.
getGiftCardsByQuoteID
Isolated FunctionRemote Function
function getGiftCardsByQuoteID(int quoteId) returns GiftCardAccountDataGiftCardAccountInterface|errorReturns GiftCard Account cards
Parameters
- quoteId int -
Return Type
- GiftCardAccountDataGiftCardAccountInterface|error - 200 Success.
addOrUpdateTheSpecifiedCartItem
Isolated FunctionRemote Function
function addOrUpdateTheSpecifiedCartItem(string quoteId, QuoteidItemsBody payload) returns QuoteDataCartItemInterface|errorAdds/updates the specified cart item
Return Type
- QuoteDataCartItemInterface|error - 200 Success.
Records
magento.cart: BundleDataBundleOptionExtensionInterface
ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface
magento.cart: BundleDataBundleOptionInterface
Interface BundleOptionInterface
Fields
- option_id int - Bundle option id.
- option_qty int - Bundle option quantity.
- option_selections int[] - Bundle option selection ids.
- extension_attributes? BundleDataBundleOptionExtensionInterface - ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface
magento.cart: CartidBillingaddressBody
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
- useForShipping? boolean -
magento.cart: CartidBillingaddressBody1
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
- useForShipping? boolean -
magento.cart: CartidEstimateshippingmethodsBody
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
magento.cart: CartidEstimateshippingmethodsBody1
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
magento.cart: CartidEstimateshippingmethodsbyaddressidBody
Fields
- addressId int - The estimate address id
magento.cart: CartidEstimateshippingmethodsbyaddressidBody1
Fields
- addressId int - The estimate address id
magento.cart: CartidGiftcardsBody
Fields
- giftCardAccountData GiftCardAccountDataGiftCardAccountInterface - Gift Card Account data
magento.cart: CartidGiftcardsBody1
Fields
- giftCardAccountData GiftCardAccountDataGiftCardAccountInterface - Gift Card Account data
magento.cart: CartidGiftmessageBody
Fields
- giftMessage GiftMessageDataMessageInterface - Interface MessageInterface
magento.cart: CartidGiftmessageBody1
Fields
- giftMessage GiftMessageDataMessageInterface - Interface MessageInterface
magento.cart: CartidOrderBody
Fields
- paymentMethod? QuoteDataPaymentInterface - Interface PaymentInterface
magento.cart: CartidOrderBody1
Fields
- paymentMethod? QuoteDataPaymentInterface - Interface PaymentInterface
magento.cart: CartidSelectedpaymentmethodBody
Fields
- method QuoteDataPaymentInterface - Interface PaymentInterface
magento.cart: CartidSelectedpaymentmethodBody1
Fields
- method QuoteDataPaymentInterface - Interface PaymentInterface
magento.cart: CartidShippinginformationBody
Fields
- addressInformation CheckoutDataShippingInformationInterface - Interface ShippingInformationInterface
magento.cart: CartidShippinginformationBody1
Fields
- addressInformation CheckoutDataShippingInformationInterface - Interface ShippingInformationInterface
magento.cart: CartidTotalsinformationBody
Fields
- addressInformation CheckoutDataTotalsInformationInterface - Interface TotalsInformationInterface
magento.cart: CartidTotalsinformationBody1
Fields
- addressInformation CheckoutDataTotalsInformationInterface - Interface TotalsInformationInterface
magento.cart: CartsCartidBody
Fields
- customerId int - The customer ID.
- storeId int -
magento.cart: CartsCartidBody1
Fields
- customerId int - The customer ID.
- storeId int -
magento.cart: CartsMineBody
Fields
- quote QuoteDataCartInterface - Interface CartInterface
magento.cart: CartsMineBody1
Fields
- quote QuoteDataCartInterface - Interface CartInterface
magento.cart: CatalogDataCustomOptionExtensionInterface
ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface
Fields
- file_info? FrameworkDataImageContentInterface - Image Content data interface
magento.cart: CatalogDataCustomOptionInterface
Interface CustomOptionInterface
Fields
- option_id string - Option id
- option_value string - Option value
- extension_attributes? CatalogDataCustomOptionExtensionInterface - ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface
magento.cart: CheckoutAgreementsDataAgreementExtensionInterface
ExtensionInterface class for @see \Magento\CheckoutAgreements\Api\Data\AgreementInterface
magento.cart: CheckoutAgreementsDataAgreementInterface
Interface AgreementInterface
Fields
- agreement_id int - Agreement ID.
- name string - Agreement name.
- content string - Agreement content.
- content_height? string - Agreement content height. Otherwise, null.
- checkbox_text string - Agreement checkbox text.
- is_active boolean - Agreement status.
- is_html boolean -
- true - HTML. * false - plain text.
- mode int - The agreement applied mode.
- extension_attributes? CheckoutAgreementsDataAgreementExtensionInterface - ExtensionInterface class for @see \Magento\CheckoutAgreements\Api\Data\AgreementInterface
magento.cart: CheckoutDataPaymentDetailsExtensionInterface
ExtensionInterface class for @see \Magento\Checkout\Api\Data\PaymentDetailsInterface
magento.cart: CheckoutDataPaymentDetailsInterface
Interface PaymentDetailsInterface
Fields
- payment_methods QuoteDataPaymentMethodInterface[] -
- totals QuoteDataTotalsInterface - Interface TotalsInterface
- extension_attributes? CheckoutDataPaymentDetailsExtensionInterface - ExtensionInterface class for @see \Magento\Checkout\Api\Data\PaymentDetailsInterface
magento.cart: CheckoutDataShippingInformationExtensionInterface
ExtensionInterface class for @see \Magento\Checkout\Api\Data\ShippingInformationInterface
magento.cart: CheckoutDataShippingInformationInterface
Interface ShippingInformationInterface
Fields
- shipping_address QuoteDataAddressInterface - Interface AddressInterface
- billing_address? QuoteDataAddressInterface - Interface AddressInterface
- shipping_method_code string - Shipping method code
- shipping_carrier_code string - Carrier code
- extension_attributes? CheckoutDataShippingInformationExtensionInterface - ExtensionInterface class for @see \Magento\Checkout\Api\Data\ShippingInformationInterface
- custom_attributes? FrameworkAttributeInterface[] - Custom attributes values.
magento.cart: CheckoutDataTotalsInformationExtensionInterface
ExtensionInterface class for @see \Magento\Checkout\Api\Data\TotalsInformationInterface
magento.cart: CheckoutDataTotalsInformationInterface
Interface TotalsInformationInterface
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
- shipping_method_code? string - Shipping method code
- shipping_carrier_code? string - Carrier code
- extension_attributes? CheckoutDataTotalsInformationExtensionInterface - ExtensionInterface class for @see \Magento\Checkout\Api\Data\TotalsInformationInterface
- custom_attributes? FrameworkAttributeInterface[] - Custom attributes values.
magento.cart: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy? ProxyConfig - Proxy server related options
magento.cart: CollectionpointSearchrequestBody
Fields
- countryId string -
- postcode string -
magento.cart: CollectionpointSearchrequestBody1
Fields
- countryId string -
- postcode string -
magento.cart: CollectionpointSelectBody
Fields
- entityId int -
magento.cart: CollectionpointSelectBody1
Fields
- entityId int -
magento.cart: CompanyDataCompanyCustomerExtensionInterface
ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyCustomerInterface
magento.cart: CompanyDataCompanyCustomerInterface
Extended customer custom attributes interface.
Fields
- customer_id? int - Customer ID.
- company_id? int - Company ID.
- job_title? string - Get job title.
- status? int - Customer status.
- telephone? string - Get telephone.
- extension_attributes? CompanyDataCompanyCustomerExtensionInterface - ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyCustomerInterface
magento.cart: ConfigurableProductDataConfigurableItemOptionValueExtensionInterface
ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface
magento.cart: ConfigurableProductDataConfigurableItemOptionValueInterface
Interface ConfigurableItemOptionValueInterface
Fields
- option_id string - Option SKU
- option_value? int - Item id
- extension_attributes? ConfigurableProductDataConfigurableItemOptionValueExtensionInterface - ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface
magento.cart: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache? CacheConfig - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
magento.cart: CustomerDataAddressExtensionInterface
ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface
magento.cart: CustomerDataAddressInterface
Customer address interface.
Fields
- id? int - ID
- customer_id? int - Customer ID
- region? CustomerDataRegionInterface - Customer address region interface.
- region_id? int - Region ID
- country_id? string - Country code in ISO_3166-2 format
- street? string[] - Street
- company? string - Company
- telephone? string - Telephone number
- fax? string - Fax number
- postcode? string - Postcode
- city? string - City name
- firstname? string - First name
- lastname? string - Last name
- middlename? string - Middle name
- prefix? string - Prefix
- suffix? string - Suffix
- vat_id? string - Vat id
- default_shipping? boolean - If this address is default shipping address.
- default_billing? boolean - If this address is default billing address
- extension_attributes? CustomerDataAddressExtensionInterface - ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface
- custom_attributes? FrameworkAttributeInterface[] - Custom attributes values.
magento.cart: CustomerDataCustomerExtensionInterface
ExtensionInterface class for @see \Magento\Customer\Api\Data\CustomerInterface
Fields
- company_attributes? CompanyDataCompanyCustomerInterface - Extended customer custom attributes interface.
- is_subscribed? boolean -
- amazon_id? string -
- vertex_customer_code? string -
magento.cart: CustomerDataCustomerInterface
Customer interface.
Fields
- id? int - Customer id
- group_id? int - Group id
- default_billing? string - Default billing address id
- default_shipping? string - Default shipping address id
- confirmation? string - Confirmation
- created_at? string - Created at time
- updated_at? string - Updated at time
- created_in? string - Created in area
- dob? string - Date of birth
- email string - Email address
- firstname string - First name
- lastname string - Last name
- middlename? string - Middle name
- prefix? string - Prefix
- suffix? string - Suffix
- gender? int - Gender
- store_id? int - Store id
- taxvat? string - Tax Vat
- website_id? int - Website id
- addresses? CustomerDataAddressInterface[] - Customer addresses.
- disable_auto_group_change? int - Disable auto group change flag.
- extension_attributes? CustomerDataCustomerExtensionInterface - ExtensionInterface class for @see \Magento\Customer\Api\Data\CustomerInterface
- custom_attributes? FrameworkAttributeInterface[] - Custom attributes values.
magento.cart: CustomerDataOptionInterface
Option interface.
Fields
- label string - Option label
- value? string - Option value
- options? CustomerDataOptionInterface[] - Nested options
magento.cart: CustomerDataRegionExtensionInterface
ExtensionInterface class for @see \Magento\Customer\Api\Data\RegionInterface
magento.cart: CustomerDataRegionInterface
Customer address region interface.
Fields
- region_code string - Region code
- region string - Region
- region_id int - Region id
- extension_attributes? CustomerDataRegionExtensionInterface - ExtensionInterface class for @see \Magento\Customer\Api\Data\RegionInterface
magento.cart: DownloadableDataDownloadableOptionInterface
Downloadable Option
Fields
- downloadable_links int[] - The list of downloadable links
magento.cart: ErrorErrorsItem
Error details
Fields
- message? string - Error message
- parameters? ErrorParameters - Error parameters list
magento.cart: ErrorParametersItem
Error parameters item
Fields
- resources? string - ACL resource
- fieldName? string - Missing or invalid field name
- fieldValue? string - Incorrect field value
magento.cart: ErrorResponse
Fields
- message string - Error message
- errors? ErrorErrors - Errors list
- code? int - Error code
- parameters? ErrorParameters - Error parameters list
- trace? string - Stack trace
magento.cart: FrameworkAttributeInterface
Interface for custom attribute value.
Fields
- attribute_code string - Attribute code
- value string - Attribute value
magento.cart: FrameworkCriteriaInterface
Interface CriteriaInterface
Fields
- mapper_interface_name string - Associated Mapper Interface name
- criteria_list FrameworkCriteriaInterface[] - Criteria objects added to current Composite Criteria
- filters string[] - List of filters
- orders string[] - Ordering criteria
- 'limit string[] - Limit
magento.cart: FrameworkDataImageContentInterface
Image Content data interface
Fields
- base64_encoded_data string - Media data (base64 encoded content)
- 'type string - MIME type
- name string - Image name
magento.cart: FrameworkFilter
Filter which can be used by any methods from service layer.
Fields
- 'field string - Field
- value string - Value
- condition_type? string - Condition type
magento.cart: FrameworkSearchCriteriaInterface
Search criteria interface.
Fields
- filter_groups FrameworkSearchFilterGroup[] - A list of filter groups.
- sort_orders? FrameworkSortOrder[] - Sort order.
- page_size? int - Page size.
- current_page? int - Current page.
magento.cart: FrameworkSearchFilterGroup
Groups two or more filters together using a logical OR
Fields
- filters? FrameworkFilter[] - A list of filters in this group
magento.cart: FrameworkSortOrder
Data object for sort order.
Fields
- 'field string - Sorting field.
- direction string - Sorting direction.
magento.cart: GiftCardAccountDataGiftCardAccountExtensionInterface
ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface
magento.cart: GiftCardAccountDataGiftCardAccountInterface
Gift Card Account data
Fields
- gift_cards string[] - Cards codes
- gift_cards_amount decimal - Cards amount in quote currency
- base_gift_cards_amount decimal - Cards amount in base currency
- gift_cards_amount_used decimal - Cards amount used in quote currency
- base_gift_cards_amount_used decimal - Cards amount used in base currency
- extension_attributes? GiftCardAccountDataGiftCardAccountExtensionInterface - ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface
magento.cart: GiftCardDataGiftCardOptionExtensionInterface
ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface
magento.cart: GiftCardDataGiftCardOptionInterface
Interface GiftCardOptionInterface
Fields
- giftcard_amount string - Gift card amount.
- custom_giftcard_amount? decimal - Gift card open amount value.
- giftcard_sender_name string - Gift card sender name.
- giftcard_recipient_name string - Gift card recipient name.
- giftcard_sender_email string - Gift card sender email.
- giftcard_recipient_email string - Gift card recipient email.
- giftcard_message? string - Giftcard message.
- extension_attributes? GiftCardDataGiftCardOptionExtensionInterface - ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface
magento.cart: GiftMessageDataMessageExtensionInterface
ExtensionInterface class for @see \Magento\GiftMessage\Api\Data\MessageInterface
Fields
- entity_id? string -
- entity_type? string -
- wrapping_id? int -
- wrapping_allow_gift_receipt? boolean -
- wrapping_add_printed_card? boolean -
magento.cart: GiftMessageDataMessageInterface
Interface MessageInterface
Fields
- gift_message_id? int - Gift message ID. Otherwise, null.
- customer_id? int - Customer ID. Otherwise, null.
- sender string - Sender name.
- recipient string - Recipient name.
- message string - Message text.
- extension_attributes? GiftMessageDataMessageExtensionInterface - ExtensionInterface class for @see \Magento\GiftMessage\Api\Data\MessageInterface
magento.cart: GiftmessageItemidBody
Fields
- giftMessage GiftMessageDataMessageInterface - Interface MessageInterface
magento.cart: GiftmessageItemidBody1
Fields
- giftMessage GiftMessageDataMessageInterface - Interface MessageInterface
magento.cart: GiftmessageItemidBody2
Fields
- giftMessage GiftMessageDataMessageInterface - Interface MessageInterface
magento.cart: GiftmessageItemidBody3
Fields
- giftMessage GiftMessageDataMessageInterface - Interface MessageInterface
magento.cart: ItemsItemidBody
Fields
- cartItem QuoteDataCartItemInterface - Interface CartItemInterface
magento.cart: ItemsItemidBody1
Fields
- cartItem QuoteDataCartItemInterface - Interface CartItemInterface
magento.cart: ItemsItemidBody2
Fields
- cartItem QuoteDataCartItemInterface - Interface CartItemInterface
magento.cart: ItemsItemidBody3
Fields
- cartItem QuoteDataCartItemInterface - Interface CartItemInterface
magento.cart: MineBillingaddressBody
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
- useForShipping? boolean -
magento.cart: MineBillingaddressBody1
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
- useForShipping? boolean -
magento.cart: MineCheckoutfieldsBody
Fields
- serviceSelection FrameworkAttributeInterface[] -
magento.cart: MineCheckoutfieldsBody1
Fields
- serviceSelection FrameworkAttributeInterface[] -
magento.cart: MineCollecttotalsBody
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- shippingCarrierCode? string - The carrier code.
- shippingMethodCode? string - The shipping method code.
- additionalData? QuoteDataTotalsAdditionalDataInterface - Additional data for totals collection.
magento.cart: MineCollecttotalsBody1
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- shippingCarrierCode? string - The carrier code.
- shippingMethodCode? string - The shipping method code.
- additionalData? QuoteDataTotalsAdditionalDataInterface - Additional data for totals collection.
magento.cart: MineDeliveryoptionBody
Fields
- selectedOption string -
magento.cart: MineDeliveryoptionBody1
Fields
- selectedOption string -
magento.cart: MineEstimateshippingmethodsBody
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
magento.cart: MineEstimateshippingmethodsBody1
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
magento.cart: MineEstimateshippingmethodsbyaddressidBody
Fields
- addressId int - The estimate address id
magento.cart: MineEstimateshippingmethodsbyaddressidBody1
Fields
- addressId int - The estimate address id
magento.cart: MineGiftcardsBody
Fields
- giftCardAccountData GiftCardAccountDataGiftCardAccountInterface - Gift Card Account data
magento.cart: MineGiftcardsBody1
Fields
- giftCardAccountData GiftCardAccountDataGiftCardAccountInterface - Gift Card Account data
magento.cart: MineGiftmessageBody
Fields
- giftMessage GiftMessageDataMessageInterface - Interface MessageInterface
magento.cart: MineGiftmessageBody1
Fields
- giftMessage GiftMessageDataMessageInterface - Interface MessageInterface
magento.cart: MineItemsBody
Fields
- cartItem QuoteDataCartItemInterface - Interface CartItemInterface
magento.cart: MineItemsBody1
Fields
- cartItem QuoteDataCartItemInterface - Interface CartItemInterface
magento.cart: MineOrderBody
Fields
- paymentMethod? QuoteDataPaymentInterface - Interface PaymentInterface
magento.cart: MineOrderBody1
Fields
- paymentMethod? QuoteDataPaymentInterface - Interface PaymentInterface
magento.cart: MinePaymentinformationBody
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress? QuoteDataAddressInterface - Interface AddressInterface
magento.cart: MinePaymentinformationBody1
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress? QuoteDataAddressInterface - Interface AddressInterface
magento.cart: MineSelectedpaymentmethodBody
Fields
- method QuoteDataPaymentInterface - Interface PaymentInterface
magento.cart: MineSelectedpaymentmethodBody1
Fields
- method QuoteDataPaymentInterface - Interface PaymentInterface
magento.cart: MineSetpaymentinformationBody
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress? QuoteDataAddressInterface - Interface AddressInterface
magento.cart: MineSetpaymentinformationBody1
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress? QuoteDataAddressInterface - Interface AddressInterface
magento.cart: MineShippinginformationBody
Fields
- addressInformation CheckoutDataShippingInformationInterface - Interface ShippingInformationInterface
magento.cart: MineShippinginformationBody1
Fields
- addressInformation CheckoutDataShippingInformationInterface - Interface ShippingInformationInterface
magento.cart: MineTotalsinformationBody
Fields
- addressInformation CheckoutDataTotalsInformationInterface - Interface TotalsInformationInterface
magento.cart: MineTotalsinformationBody1
Fields
- addressInformation CheckoutDataTotalsInformationInterface - Interface TotalsInformationInterface
magento.cart: NegotiableQuoteDataNegotiableQuoteExtensionInterface
ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteInterface
magento.cart: NegotiableQuoteDataNegotiableQuoteInterface
Interface NegotiableQuoteInterface
Fields
- quote_id int - Negotiable quote ID.
- is_regular_quote boolean - Is regular quote.
- status string - Negotiable quote status.
- negotiated_price_type int - Negotiated price type.
- negotiated_price_value decimal - Negotiated price value.
- shipping_price decimal - Proposed shipping price.
- quote_name string - Negotiable quote name.
- expiration_period string - Expiration period.
- email_notification_status int - Email notification status.
- has_unconfirmed_changes boolean - Has unconfirmed changes.
- is_shipping_tax_changed boolean - Shipping tax changes.
- is_customer_price_changed boolean - Customer price changes.
- notifications int - Quote notifications.
- applied_rule_ids string - Quote rules.
- is_address_draft boolean - Is address draft.
- deleted_sku string - Deleted products sku.
- creator_id int - Quote creator id.
- creator_type int - Quote creator type.
- original_total_price? decimal - Quote original total price.
- base_original_total_price? decimal - Quote original total price in base currency.
- negotiated_total_price? decimal - Quote negotiated total price.
- base_negotiated_total_price? decimal - Quote negotiated total price in base currency.
- extension_attributes? NegotiableQuoteDataNegotiableQuoteExtensionInterface - ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteInterface
magento.cart: NegotiableQuoteDataNegotiableQuoteItemExtensionInterface
ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemInterface
magento.cart: NegotiableQuoteDataNegotiableQuoteItemInterface
Interface CompanyQuoteConfigInterface
Fields
- item_id int - Quote item id
- original_price decimal - Quote item original price
- original_tax_amount decimal - Quote item original tax amount
- original_discount_amount decimal - Quote item original discount amount
- extension_attributes? NegotiableQuoteDataNegotiableQuoteItemExtensionInterface - ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemInterface
magento.cart: NegotiableQuoteDataNegotiableQuoteItemTotalsExtensionInterface
ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemTotalsInterface
magento.cart: NegotiableQuoteDataNegotiableQuoteItemTotalsInterface
Extension attribute for quote item totals model.
Fields
- cost decimal - Cost for quote item.
- catalog_price decimal - Catalog price for quote item.
- base_catalog_price decimal - Catalog price for quote item in base currency.
- catalog_price_incl_tax decimal - Catalog price with included tax for quote item.
- base_catalog_price_incl_tax decimal - Catalog price with included tax for quote item in base currency.
- cart_price decimal - Cart price for quote item.
- base_cart_price decimal - Cart price for quote item in base currency.
- cart_tax decimal - Tax from catalog price for quote item.
- base_cart_tax decimal - Tax from catalog price for quote item in base currency.
- cart_price_incl_tax decimal - Cart price with included tax for quote item.
- base_cart_price_incl_tax decimal - Cart price with included tax for quote item in base currency.
- extension_attributes? NegotiableQuoteDataNegotiableQuoteItemTotalsExtensionInterface - ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemTotalsInterface
magento.cart: NegotiableQuoteDataNegotiableQuoteTotalsInterface
Extension attribute for quote totals model.
Fields
- items_count int - The number of different items or products in the cart.
- quote_status string - Negotiable quote status.
- created_at string - The cart creation date and time.
- updated_at string - The cart last update date and time.
- customer_group int - Customer group id.
- base_to_quote_rate decimal - Base currency to quote currency rate.
- cost_total decimal - Total cost for quote.
- base_cost_total decimal - Total cost for quote in base currency.
- original_total decimal - Original quote total.
- base_original_total decimal - Original quote total in base currency.
- original_tax decimal - Original tax amount for quote.
- base_original_tax decimal - Original tax amount for quote in base currency.
- original_price_incl_tax decimal - Original price with included tax for quote.
- base_original_price_incl_tax decimal - Original price with included tax for quote in base currency.
- negotiated_price_type int - Negotiable quote type.
- negotiated_price_value decimal - Negotiable price value for quote.
magento.cart: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
magento.cart: QuoteDataAddressExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface
Fields
- gift_registry_id? int -
- checkout_fields? FrameworkAttributeInterface[] -
magento.cart: QuoteDataAddressInterface
Interface AddressInterface
Fields
- id? int - Id
- region string - Region name
- region_id int - Region id
- region_code string - Region code
- country_id string - Country id
- street string[] - Street
- company? string - Company
- telephone string - Telephone number
- fax? string - Fax number
- postcode string - Postcode
- city string - City name
- firstname string - First name
- lastname string - Last name
- middlename? string - Middle name
- prefix? string - Prefix
- suffix? string - Suffix
- vat_id? string - Vat id
- customer_id? int - Customer id
- email string - Billing/shipping email
- same_as_billing? int - Same as billing flag
- customer_address_id? int - Customer address id
- save_in_address_book? int - Save in address book flag
- extension_attributes? QuoteDataAddressExtensionInterface - ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface
- custom_attributes? FrameworkAttributeInterface[] - Custom attributes values.
magento.cart: QuoteDataCartExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\CartInterface
Fields
- shipping_assignments? QuoteDataShippingAssignmentInterface[] -
- negotiable_quote? NegotiableQuoteDataNegotiableQuoteInterface - Interface NegotiableQuoteInterface
- amazon_order_reference_id? string -
magento.cart: QuoteDataCartInterface
Interface CartInterface
Fields
- id int - Cart/quote ID.
- created_at? string - Cart creation date and time. Otherwise, null.
- updated_at? string - Cart last update date and time. Otherwise, null.
- converted_at? string - Cart conversion date and time. Otherwise, null.
- is_active? boolean - Active status flag value. Otherwise, null.
- is_virtual? boolean - Virtual flag value. Otherwise, null.
- items? QuoteDataCartItemInterface[] - Array of items. Otherwise, null.
- items_count? int - Number of different items or products in the cart. Otherwise, null.
- items_qty? decimal - Total quantity of all cart items. Otherwise, null.
- customer CustomerDataCustomerInterface - Customer interface.
- billing_address? QuoteDataAddressInterface - Interface AddressInterface
- reserved_order_id? string - Reserved order ID. Otherwise, null.
- orig_order_id? int - Original order ID. Otherwise, null.
- currency? QuoteDataCurrencyInterface - Interface CurrencyInterface
- customer_is_guest? boolean - For guest customers, false for logged in customers
- customer_note? string - Notice text
- customer_note_notify? boolean - Customer notification flag
- customer_tax_class_id? int - Customer tax class ID.
- store_id int - Store identifier
- extension_attributes? QuoteDataCartExtensionInterface - ExtensionInterface class for @see \Magento\Quote\Api\Data\CartInterface
magento.cart: QuoteDataCartItemExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface
Fields
- negotiable_quote_item? NegotiableQuoteDataNegotiableQuoteItemInterface - Interface CompanyQuoteConfigInterface
magento.cart: QuoteDataCartItemInterface
Interface CartItemInterface
Fields
- item_id? int - Item ID. Otherwise, null.
- sku? string - Product SKU. Otherwise, null.
- qty decimal - Product quantity.
- name? string - Product name. Otherwise, null.
- price? decimal - Product price. Otherwise, null.
- product_type? string - Product type. Otherwise, null.
- quote_id string - Quote id.
- product_option? QuoteDataProductOptionInterface - Product option interface
- extension_attributes? QuoteDataCartItemExtensionInterface - ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface
magento.cart: QuoteDataCartSearchResultsInterface
Interface CartSearchResultsInterface
Fields
- items QuoteDataCartInterface[] - Carts list.
- search_criteria FrameworkSearchCriteriaInterface - Search criteria interface.
- total_count int - Total count.
magento.cart: QuoteDataCurrencyExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\CurrencyInterface
magento.cart: QuoteDataCurrencyInterface
Interface CurrencyInterface
Fields
- global_currency_code? string - Global currency code
- base_currency_code? string - Base currency code
- store_currency_code? string - Store currency code
- quote_currency_code? string - Quote currency code
- store_to_base_rate? decimal - Store currency to base currency rate
- store_to_quote_rate? decimal - Store currency to quote currency rate
- base_to_global_rate? decimal - Base currency to global currency rate
- base_to_quote_rate? decimal - Base currency to quote currency rate
- extension_attributes? QuoteDataCurrencyExtensionInterface - ExtensionInterface class for @see \Magento\Quote\Api\Data\CurrencyInterface
magento.cart: QuoteDataPaymentExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\PaymentInterface
Fields
- agreement_ids? string[] -
magento.cart: QuoteDataPaymentInterface
Interface PaymentInterface
Fields
- po_number? string - Purchase order number
- method string - Payment method code
- additional_data? string[] - Payment additional details
- extension_attributes? QuoteDataPaymentExtensionInterface - ExtensionInterface class for @see \Magento\Quote\Api\Data\PaymentInterface
magento.cart: QuoteDataPaymentMethodInterface
Interface PaymentMethodInterface
Fields
- code string - Payment method code
- title string - Payment method title
magento.cart: QuoteDataProductOptionExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface
Fields
- custom_options? CatalogDataCustomOptionInterface[] -
- bundle_options? BundleDataBundleOptionInterface[] -
- configurable_item_options? ConfigurableProductDataConfigurableItemOptionValueInterface[] -
- downloadable_option? DownloadableDataDownloadableOptionInterface - Downloadable Option
- giftcard_item_option? GiftCardDataGiftCardOptionInterface - Interface GiftCardOptionInterface
magento.cart: QuoteDataProductOptionInterface
Product option interface
Fields
- extension_attributes? QuoteDataProductOptionExtensionInterface - ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface
magento.cart: QuoteDataShippingAssignmentExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingAssignmentInterface
magento.cart: QuoteDataShippingAssignmentInterface
Interface ShippingAssignmentInterface
Fields
- shipping QuoteDataShippingInterface - Interface ShippingInterface
- items QuoteDataCartItemInterface[] -
- extension_attributes? QuoteDataShippingAssignmentExtensionInterface - ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingAssignmentInterface
magento.cart: QuoteDataShippingExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingInterface
magento.cart: QuoteDataShippingInterface
Interface ShippingInterface
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
- method string - Shipping method
- extension_attributes? QuoteDataShippingExtensionInterface - ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingInterface
magento.cart: QuoteDataShippingMethodExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingMethodInterface
magento.cart: QuoteDataShippingMethodInterface
Interface ShippingMethodInterface
Fields
- carrier_code string - Shipping carrier code.
- method_code string - Shipping method code.
- carrier_title? string - Shipping carrier title. Otherwise, null.
- method_title? string - Shipping method title. Otherwise, null.
- amount decimal - Shipping amount in store currency.
- base_amount decimal - Shipping amount in base currency.
- available boolean - The value of the availability flag for the current shipping method.
- extension_attributes? QuoteDataShippingMethodExtensionInterface - ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingMethodInterface
- error_message string - Shipping Error message.
- price_excl_tax decimal - Shipping price excl tax.
- price_incl_tax decimal - Shipping price incl tax.
magento.cart: QuoteDataTotalsAdditionalDataExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsAdditionalDataInterface
Fields
- gift_messages? GiftMessageDataMessageInterface[] -
magento.cart: QuoteDataTotalsAdditionalDataInterface
Additional data for totals collection.
Fields
- extension_attributes? QuoteDataTotalsAdditionalDataExtensionInterface - ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsAdditionalDataInterface
- custom_attributes? FrameworkAttributeInterface[] - Custom attributes values.
magento.cart: QuoteDataTotalSegmentExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalSegmentInterface
Fields
- tax_grandtotal_details? TaxDataGrandTotalDetailsInterface[] -
- 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 -
- vertex_tax_calculation_messages? string[] -
magento.cart: QuoteDataTotalSegmentInterface
Interface TotalsInterface
Fields
- code string - Code
- title? string - Total title
- value decimal - Total value
- area? string - Display area code.
- extension_attributes? QuoteDataTotalSegmentExtensionInterface - ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalSegmentInterface
magento.cart: QuoteDataTotalsExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsInterface
Fields
- coupon_label? string -
- base_customer_balance_amount? decimal -
- customer_balance_amount? decimal -
- negotiable_quote_totals? NegotiableQuoteDataNegotiableQuoteTotalsInterface - Extension attribute for quote totals model.
- reward_points_balance? decimal -
- reward_currency_amount? decimal -
- base_reward_currency_amount? decimal -
magento.cart: QuoteDataTotalsInterface
Interface TotalsInterface
Fields
- grand_total? decimal - Grand total in quote currency
- base_grand_total? decimal - Grand total in base currency
- subtotal? decimal - Subtotal in quote currency
- base_subtotal? decimal - Subtotal in base currency
- discount_amount? decimal - Discount amount in quote currency
- base_discount_amount? decimal - Discount amount in base currency
- subtotal_with_discount? decimal - Subtotal in quote currency with applied discount
- base_subtotal_with_discount? decimal - Subtotal in base currency with applied discount
- shipping_amount? decimal - Shipping amount in quote currency
- base_shipping_amount? decimal - Shipping amount in base currency
- shipping_discount_amount? decimal - Shipping discount amount in quote currency
- base_shipping_discount_amount? decimal - Shipping discount amount in base currency
- tax_amount? decimal - Tax amount in quote currency
- base_tax_amount? decimal - Tax amount in base currency
- weee_tax_applied_amount decimal - Item weee tax applied amount in quote currency.
- shipping_tax_amount? decimal - Shipping tax amount in quote currency
- base_shipping_tax_amount? decimal - Shipping tax amount in base currency
- subtotal_incl_tax? decimal - Subtotal including tax in quote currency
- base_subtotal_incl_tax? decimal - Subtotal including tax in base currency
- shipping_incl_tax? decimal - Shipping including tax in quote currency
- base_shipping_incl_tax? decimal - Shipping including tax in base currency
- base_currency_code? string - Base currency code
- quote_currency_code? string - Quote currency code
- coupon_code? string - Applied coupon code
- items_qty? int - Items qty
- items? QuoteDataTotalsItemInterface[] - Totals by items
- total_segments QuoteDataTotalSegmentInterface[] - Dynamically calculated totals
- extension_attributes? QuoteDataTotalsExtensionInterface - ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsInterface
magento.cart: QuoteDataTotalsItemExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsItemInterface
Fields
- negotiable_quote_item_totals? NegotiableQuoteDataNegotiableQuoteItemTotalsInterface - Extension attribute for quote item totals model.
magento.cart: QuoteDataTotalsItemInterface
Interface TotalsItemInterface
Fields
- item_id int - Item id
- price decimal - Item price in quote currency.
- base_price decimal - Item price in base currency.
- qty decimal - Item quantity.
- row_total decimal - Row total in quote currency.
- base_row_total decimal - Row total in base currency.
- row_total_with_discount? decimal - Row total with discount in quote currency. Otherwise, null.
- tax_amount? decimal - Tax amount in quote currency. Otherwise, null.
- base_tax_amount? decimal - Tax amount in base currency. Otherwise, null.
- tax_percent? decimal - Tax percent. Otherwise, null.
- discount_amount? decimal - Discount amount in quote currency. Otherwise, null.
- base_discount_amount? decimal - Discount amount in base currency. Otherwise, null.
- discount_percent? decimal - Discount percent. Otherwise, null.
- price_incl_tax? decimal - Price including tax in quote currency. Otherwise, null.
- base_price_incl_tax? decimal - Price including tax in base currency. Otherwise, null.
- row_total_incl_tax? decimal - Row total including tax in quote currency. Otherwise, null.
- base_row_total_incl_tax? decimal - Row total including tax in base currency. Otherwise, null.
- options string - Item price in quote currency.
- weee_tax_applied_amount decimal - Item weee tax applied amount in quote currency.
- weee_tax_applied string - Item weee tax applied in quote currency.
- extension_attributes? QuoteDataTotalsItemExtensionInterface - ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsItemInterface
- name? string - Product name. Otherwise, null.
magento.cart: QuoteidItemsBody
Fields
- cartItem QuoteDataCartItemInterface - Interface CartItemInterface
magento.cart: QuoteidItemsBody1
Fields
- cartItem QuoteDataCartItemInterface - Interface CartItemInterface
magento.cart: TaxDataGrandTotalDetailsInterface
Interface GrandTotalDetailsInterface
Fields
- amount decimal - Tax amount value
- rates TaxDataGrandTotalRatesInterface[] - Tax rates info
- group_id int - Group identifier
magento.cart: TaxDataGrandTotalRatesInterface
Interface GrandTotalRatesInterface
Fields
- percent string - Tax percentage value
- title string - Rate title
magento.cart: TemandoShippingDataCollectionPointQuoteCollectionPointInterface
Temando Quote Collection Point Interface – Checkout/Quoting
Fields
- entity_id int -
- collection_point_id string -
- recipient_address_id int -
- name string -
- country string -
- region string -
- postcode string -
- city string -
- street string[] -
- opening_hours string[] -
- shipping_experiences string[] -
- selected boolean -
magento.cart: TemandoShippingDataCollectionPointSearchRequestInterface
Temando Collection Point Search Request Interface
Fields
- shipping_address_id int -
- country_id string -
- postcode string -
- pending boolean -
Array types
magento.cart: CheckoutAgreementsDataAgreementInterfaceArr
CheckoutAgreementsDataAgreementInterfaceArr
magento.cart: TemandoShippingDataCollectionPointQuoteCollectionPointInterfaceArr
TemandoShippingDataCollectionPointQuoteCollectionPointInterfaceArr
magento.cart: QuoteDataShippingMethodInterfaceArr
QuoteDataShippingMethodInterfaceArr
magento.cart: QuoteDataCartItemInterfaceArr
QuoteDataCartItemInterfaceArr
magento.cart: QuoteDataPaymentMethodInterfaceArr
QuoteDataPaymentMethodInterfaceArr
magento.cart: ErrorErrors
ErrorErrors
Errors list
magento.cart: ErrorParameters
ErrorParameters
Error parameters list