Module magento.async.customer
ballerinax/magento.async.customer Ballerina library
1.3.1
Overview
This is a generated connector for Magento REST Asynchronous API v2.2 OpenAPI specification.
The Magento Asynchronous Customer REST API service enables applications to build and manage the Magento e-commerce platform.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Obtain tokens by following this guide
Clients
magento.async.customer: Client
Isolated
This is a generated connector for Magento REST Asynchronous API v2.2 OpenAPI specification. The Magento Asynchronous Customer REST API service enables applications to build and manage the Magento e-commerce platform.
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
amazonPaymentAddressManagementV1GetBillingAddressPut
Isolated FunctionRemote Function
function amazonPaymentAddressManagementV1GetBillingAddressPut(string amazonOrderReferenceId, AmazonbillingaddressAmazonorderreferenceidBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|erroramazon-billing-address/{amazonOrderReferenceId}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
amazonPaymentAddressManagementV1GetShippingAddressPut
Isolated FunctionRemote Function
function amazonPaymentAddressManagementV1GetShippingAddressPut(string amazonOrderReferenceId, AmazonshippingaddressAmazonorderreferenceidBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|erroramazon-shipping-address/{amazonOrderReferenceId}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
amazonPaymentOrderInformationManagementV1RemoveOrderReferenceDelete
Isolated FunctionRemote Function
function amazonPaymentOrderInformationManagementV1RemoveOrderReferenceDelete() returns Response|erroramazon/order-ref
giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPost
Isolated FunctionRemote Function
function giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPost(string cartId, CartidGiftcardsBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorcarts/guest-carts/{cartId}/giftCards
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
giftCardAccountGuestGiftCardAccountManagementV1DeleteByQuoteIdDelete
Isolated FunctionRemote Function
function giftCardAccountGuestGiftCardAccountManagementV1DeleteByQuoteIdDelete(string cartId, string giftCardCode) returns AsynchronousOperationsDataAsyncResponseInterface|errorcarts/guest-carts/{cartId}/giftCards/{giftCardCode}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteCartRepositoryV1SavePut
Isolated FunctionRemote Function
function quoteCartRepositoryV1SavePut(CartsMineBody payload) returns Response|errorcarts/mine
Parameters
- payload CartsMineBody -
customerBalanceBalanceManagementV1ApplyPost
Isolated FunctionRemote Function
function customerBalanceBalanceManagementV1ApplyPost() returns AsynchronousOperationsDataAsyncResponseInterface|errorcarts/mine/balance/apply
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteCartTotalManagementV1CollectTotalsPut
Isolated FunctionRemote Function
function quoteCartTotalManagementV1CollectTotalsPut(MineCollecttotalsBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorcarts/mine/collect-totals
Parameters
- payload MineCollecttotalsBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost
Isolated FunctionRemote Function
function checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost(MinePaymentinformationBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorcarts/mine/payment-information
Parameters
- payload MinePaymentinformationBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
checkoutPaymentInformationManagementV1SavePaymentInformationPost
Isolated FunctionRemote Function
function checkoutPaymentInformationManagementV1SavePaymentInformationPost(MineSetpaymentinformationBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorcarts/mine/set-payment-information
Parameters
- payload MineSetpaymentinformationBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
customerAccountManagementV1CreateAccountPost
Isolated FunctionRemote Function
function customerAccountManagementV1CreateAccountPost(V1CustomersBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorcustomers
Parameters
- payload V1CustomersBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
customerAccountManagementV1IsEmailAvailablePost
Isolated FunctionRemote Function
function customerAccountManagementV1IsEmailAvailablePost(CustomersIsemailavailableBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorcustomers/isEmailAvailable
Parameters
- payload CustomersIsemailavailableBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
customerAccountManagementV1ActivateByIdPut
Isolated FunctionRemote Function
function customerAccountManagementV1ActivateByIdPut(MeActivateBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorcustomers/me/activate
Parameters
- payload MeActivateBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
customerAccountManagementV1ChangePasswordByIdPut
Isolated FunctionRemote Function
function customerAccountManagementV1ChangePasswordByIdPut(MePasswordBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorcustomers/me/password
Parameters
- payload MePasswordBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
customerAccountManagementV1InitiatePasswordResetPut
Isolated FunctionRemote Function
function customerAccountManagementV1InitiatePasswordResetPut(CustomersPasswordBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorcustomers/password
Parameters
- payload CustomersPasswordBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
customerAccountManagementV1ResetPasswordPost
Isolated FunctionRemote Function
function customerAccountManagementV1ResetPasswordPost(CustomersResetpasswordBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorcustomers/resetPassword
Parameters
- payload CustomersResetpasswordBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
giftRegistryShippingMethodManagementV1EstimateByRegistryIdPost
Isolated FunctionRemote Function
function giftRegistryShippingMethodManagementV1EstimateByRegistryIdPost(MineEstimateshippingmethodsBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorgiftregistry/mine/estimate-shipping-methods
Parameters
- payload MineEstimateshippingmethodsBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestCartManagementV1CreateEmptyCartPost
Isolated FunctionRemote Function
function quoteGuestCartManagementV1CreateEmptyCartPost() returns AsynchronousOperationsDataAsyncResponseInterface|errorguest-carts
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestCartManagementV1AssignCustomerPut
Isolated FunctionRemote Function
function quoteGuestCartManagementV1AssignCustomerPut(string cartId, GuestcartsCartidBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorguest-carts/{cartId}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestBillingAddressManagementV1AssignPost
Isolated FunctionRemote Function
function quoteGuestBillingAddressManagementV1AssignPost(string cartId, CartidBillingaddressBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorguest-carts/{cartId}/billing-address
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestCartTotalManagementV1CollectTotalsPut
Isolated FunctionRemote Function
function quoteGuestCartTotalManagementV1CollectTotalsPut(string cartId, CartidCollecttotalsBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorguest-carts/{cartId}/collect-totals
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestCouponManagementV1RemoveDelete
Isolated FunctionRemote Function
function quoteGuestCouponManagementV1RemoveDelete(string cartId) returns AsynchronousOperationsDataAsyncResponseInterface|errorguest-carts/{cartId}/coupons
Parameters
- cartId string - The cart ID.
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestCouponManagementV1SetPut
Isolated FunctionRemote Function
function quoteGuestCouponManagementV1SetPut(string cartId, string couponCode) returns AsynchronousOperationsDataAsyncResponseInterface|errorguest-carts/{cartId}/coupons/{couponCode}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost
Isolated FunctionRemote Function
function quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost(string cartId, CartidEstimateshippingmethodsBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorguest-carts/{cartId}/estimate-shipping-methods
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
giftMessageGuestCartRepositoryV1SavePost
Isolated FunctionRemote Function
function giftMessageGuestCartRepositoryV1SavePost(string cartId, CartidGiftmessageBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorguest-carts/{cartId}/gift-message
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
giftMessageGuestItemRepositoryV1SavePost
Isolated FunctionRemote Function
function giftMessageGuestItemRepositoryV1SavePost(string cartId, int itemId, GiftmessageItemidBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorguest-carts/{cartId}/gift-message/{itemId}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestCartItemRepositoryV1SavePost
Isolated FunctionRemote Function
function quoteGuestCartItemRepositoryV1SavePost(string cartId, CartidItemsBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorguest-carts/{cartId}/items
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestCartItemRepositoryV1SavePut
Isolated FunctionRemote Function
function quoteGuestCartItemRepositoryV1SavePut(string cartId, string itemId, ItemsItemidBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorguest-carts/{cartId}/items/{itemId}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestCartItemRepositoryV1DeleteByIdDelete
Isolated FunctionRemote Function
function quoteGuestCartItemRepositoryV1DeleteByIdDelete(string cartId, int itemId) returns AsynchronousOperationsDataAsyncResponseInterface|errorguest-carts/{cartId}/items/{itemId}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestCartManagementV1PlaceOrderPut
Isolated FunctionRemote Function
function quoteGuestCartManagementV1PlaceOrderPut(string cartId, CartidOrderBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorguest-carts/{cartId}/order
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost
Isolated FunctionRemote Function
function checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost(string cartId, CartidPaymentinformationBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorguest-carts/{cartId}/payment-information
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestPaymentMethodManagementV1SetPut
Isolated FunctionRemote Function
function quoteGuestPaymentMethodManagementV1SetPut(string cartId, CartidSelectedpaymentmethodBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorguest-carts/{cartId}/selected-payment-method
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost
Isolated FunctionRemote Function
function checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost(string cartId, CartidSetpaymentinformationBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorguest-carts/{cartId}/set-payment-information
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
checkoutGuestShippingInformationManagementV1SaveAddressInformationPost
Isolated FunctionRemote Function
function checkoutGuestShippingInformationManagementV1SaveAddressInformationPost(string cartId, CartidShippinginformationBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorguest-carts/{cartId}/shipping-information
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
checkoutGuestTotalsInformationManagementV1CalculatePost
Isolated FunctionRemote Function
function checkoutGuestTotalsInformationManagementV1CalculatePost(string cartId, CartidTotalsinformationBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorguest-carts/{cartId}/totals-information
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPost
Isolated FunctionRemote Function
function giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPost(string cartId, CartidEstimateshippingmethodsBody2 payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorguest-giftregistry/{cartId}/estimate-shipping-methods
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
integrationAdminTokenServiceV1CreateAdminAccessTokenPost
Isolated FunctionRemote Function
function integrationAdminTokenServiceV1CreateAdminAccessTokenPost(AdminTokenBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorintegration/admin/token
Parameters
- payload AdminTokenBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost
Isolated FunctionRemote Function
function integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost(CustomerTokenBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorintegration/customer/token
Parameters
- payload CustomerTokenBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuoteBillingAddressManagementV1AssignPost
Isolated FunctionRemote Function
function negotiableQuoteBillingAddressManagementV1AssignPost(int cartId, CartidBillingaddressBody2 payload) returns AsynchronousOperationsDataAsyncResponseInterface|errornegotiable-carts/{cartId}/billing-address
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuoteCouponManagementV1RemoveDelete
Isolated FunctionRemote Function
function negotiableQuoteCouponManagementV1RemoveDelete(int cartId) returns AsynchronousOperationsDataAsyncResponseInterface|errornegotiable-carts/{cartId}/coupons
Parameters
- cartId int - The cart ID.
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuoteCouponManagementV1SetPut
Isolated FunctionRemote Function
function negotiableQuoteCouponManagementV1SetPut(int cartId, string couponCode) returns AsynchronousOperationsDataAsyncResponseInterface|errornegotiable-carts/{cartId}/coupons/{couponCode}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuoteShipmentEstimationV1EstimateByExtendedAddressPost
Isolated FunctionRemote Function
function negotiableQuoteShipmentEstimationV1EstimateByExtendedAddressPost(string cartId, CartidEstimateshippingmethodsBody4 payload) returns AsynchronousOperationsDataAsyncResponseInterface|errornegotiable-carts/{cartId}/estimate-shipping-methods
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuoteShippingMethodManagementV1EstimateByAddressIdPost
Isolated FunctionRemote Function
function negotiableQuoteShippingMethodManagementV1EstimateByAddressIdPost(int cartId, CartidEstimateshippingmethodsbyaddressidBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errornegotiable-carts/{cartId}/estimate-shipping-methods-by-address-id
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuoteGiftCardAccountManagementV1SaveByQuoteIdPost
Isolated FunctionRemote Function
function negotiableQuoteGiftCardAccountManagementV1SaveByQuoteIdPost(int cartId, CartidGiftcardsBody2 payload) returns AsynchronousOperationsDataAsyncResponseInterface|errornegotiable-carts/{cartId}/giftCards
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuoteGiftCardAccountManagementV1DeleteByQuoteIdDelete
Isolated FunctionRemote Function
function negotiableQuoteGiftCardAccountManagementV1DeleteByQuoteIdDelete(int cartId, string giftCardCode) returns AsynchronousOperationsDataAsyncResponseInterface|errornegotiable-carts/{cartId}/giftCards/{giftCardCode}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuotePaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost
Isolated FunctionRemote Function
function negotiableQuotePaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost(int cartId, CartidPaymentinformationBody2 payload) returns AsynchronousOperationsDataAsyncResponseInterface|errornegotiable-carts/{cartId}/payment-information
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuotePaymentInformationManagementV1SavePaymentInformationPost
Isolated FunctionRemote Function
function negotiableQuotePaymentInformationManagementV1SavePaymentInformationPost(int cartId, CartidSetpaymentinformationBody2 payload) returns AsynchronousOperationsDataAsyncResponseInterface|errornegotiable-carts/{cartId}/set-payment-information
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuoteShippingInformationManagementV1SaveAddressInformationPost
Isolated FunctionRemote Function
function negotiableQuoteShippingInformationManagementV1SaveAddressInformationPost(int cartId, CartidShippinginformationBody2 payload) returns AsynchronousOperationsDataAsyncResponseInterface|errornegotiable-carts/{cartId}/shipping-information
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
requisitionListRequisitionListRepositoryV1SavePost
Isolated FunctionRemote Function
function requisitionListRequisitionListRepositoryV1SavePost(V1RequisitionListsBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorrequisition_lists
Parameters
- payload V1RequisitionListsBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
rewardRewardManagementV1SetPost
Isolated FunctionRemote Function
function rewardRewardManagementV1SetPost() returns AsynchronousOperationsDataAsyncResponseInterface|errorreward/mine/use-reward
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
vertexAddressValidationAddressManagementV1GetValidAddressPost
Isolated FunctionRemote Function
function vertexAddressValidationAddressManagementV1GetValidAddressPost(VertexaddressvalidationVertexaddressBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorvertex-address-validation/vertex-address
Parameters
- payload VertexaddressvalidationVertexaddressBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
worldpayGuestPaymentInformationManagementProxyV1SavePaymentInformationAndPlaceOrderPost
Isolated FunctionRemote Function
function worldpayGuestPaymentInformationManagementProxyV1SavePaymentInformationAndPlaceOrderPost(string cartId, CartidPaymentinformationBody4 payload) returns AsynchronousOperationsDataAsyncResponseInterface|errorworldpay-guest-carts/{cartId}/payment-information
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
Records
magento.async.customer: AdminTokenBody
Fields
- username string -
- password string -
magento.async.customer: AdminTokenBody1
Fields
- username string -
- password string -
magento.async.customer: AmazonbillingaddressAmazonorderreferenceidBody
Fields
- addressConsentToken string -
magento.async.customer: AmazonbillingaddressAmazonorderreferenceidBody1
Fields
- addressConsentToken string -
magento.async.customer: AmazonPaymentDataQuoteLinkInterface
Fields
- id string -
- amazon_order_reference_id string - Amazon order reference id
- quote_id int - Quote id
- sandbox_simulation_reference string - Sandbox simulation reference
- confirmed boolean - Quote confirmed with amazon
magento.async.customer: AmazonshippingaddressAmazonorderreferenceidBody
Fields
- addressConsentToken string -
magento.async.customer: AmazonshippingaddressAmazonorderreferenceidBody1
Fields
- addressConsentToken string -
magento.async.customer: AsynchronousOperationsDataAsyncResponseExtensionInterface
ExtensionInterface class for @see \Magento\AsynchronousOperations\Api\Data\AsyncResponseInterface
magento.async.customer: AsynchronousOperationsDataAsyncResponseInterface
Interface AsyncResponseInterface Temporary data object to give response from webapi async router
Fields
- bulk_uuid string - Bulk Uuid.
- request_items AsynchronousOperationsDataItemStatusInterface[] - The list of request items with status data.
- errors boolean - There errors during processing bulk
- extension_attributes AsynchronousOperationsDataAsyncResponseExtensionInterface? - ExtensionInterface class for @see \Magento\AsynchronousOperations\Api\Data\AsyncResponseInterface
magento.async.customer: AsynchronousOperationsDataItemStatusInterface
ItemStatusInterface interface Temporary object with status of requested item. Indicate if entity param was Accepted|Rejected to bulk schedule
Fields
- id int - Entity Id.
- data_hash string - md5 hash of entity params array.
- status string - accepted|rejected
- error_message string? - Error information.
- error_code int? - Error code.
magento.async.customer: BundleDataBundleOptionExtensionInterface
ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface
magento.async.customer: 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.async.customer: CartidBillingaddressBody
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
- useForShipping boolean? -
magento.async.customer: CartidBillingaddressBody1
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
- useForShipping boolean? -
magento.async.customer: CartidBillingaddressBody2
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
- useForShipping boolean? -
magento.async.customer: CartidBillingaddressBody3
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
- useForShipping boolean? -
magento.async.customer: CartidCollecttotalsBody
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- shippingCarrierCode string? - The carrier code.
- shippingMethodCode string? - The shipping method code.
- additionalData QuoteDataTotalsAdditionalDataInterface? - Additional data for totals collection.
magento.async.customer: CartidCollecttotalsBody1
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- shippingCarrierCode string? - The carrier code.
- shippingMethodCode string? - The shipping method code.
- additionalData QuoteDataTotalsAdditionalDataInterface? - Additional data for totals collection.
magento.async.customer: CartidEstimateshippingmethodsBody
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
magento.async.customer: CartidEstimateshippingmethodsBody1
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
magento.async.customer: CartidEstimateshippingmethodsBody2
Fields
- registryId int - The estimate registry id
magento.async.customer: CartidEstimateshippingmethodsBody3
Fields
- registryId int - The estimate registry id
magento.async.customer: CartidEstimateshippingmethodsBody4
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
magento.async.customer: CartidEstimateshippingmethodsBody5
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
magento.async.customer: CartidEstimateshippingmethodsbyaddressidBody
Fields
- addressId int - The estimate address id
magento.async.customer: CartidEstimateshippingmethodsbyaddressidBody1
Fields
- addressId int - The estimate address id
magento.async.customer: CartidGiftcardsBody
Fields
- giftCardAccountData GiftCardAccountDataGiftCardAccountInterface - Gift Card Account data
magento.async.customer: CartidGiftcardsBody1
Fields
- giftCardAccountData GiftCardAccountDataGiftCardAccountInterface - Gift Card Account data
magento.async.customer: CartidGiftcardsBody2
Fields
- giftCardAccountData GiftCardAccountDataGiftCardAccountInterface - Gift Card Account data
magento.async.customer: CartidGiftcardsBody3
Fields
- giftCardAccountData GiftCardAccountDataGiftCardAccountInterface - Gift Card Account data
magento.async.customer: CartidGiftmessageBody
Fields
- giftMessage GiftMessageDataMessageInterface - Interface MessageInterface
magento.async.customer: CartidGiftmessageBody1
Fields
- giftMessage GiftMessageDataMessageInterface - Interface MessageInterface
magento.async.customer: CartidItemsBody
Fields
- cartItem QuoteDataCartItemInterface - Interface CartItemInterface
magento.async.customer: CartidItemsBody1
Fields
- cartItem QuoteDataCartItemInterface - Interface CartItemInterface
magento.async.customer: CartidOrderBody
Fields
- paymentMethod QuoteDataPaymentInterface? - Interface PaymentInterface
magento.async.customer: CartidOrderBody1
Fields
- paymentMethod QuoteDataPaymentInterface? - Interface PaymentInterface
magento.async.customer: CartidPaymentinformationBody
Fields
- email string -
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidPaymentinformationBody1
Fields
- email string -
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidPaymentinformationBody2
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidPaymentinformationBody3
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidPaymentinformationBody4
Fields
- email string -
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidPaymentinformationBody5
Fields
- email string -
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidSelectedpaymentmethodBody
Fields
- method QuoteDataPaymentInterface - Interface PaymentInterface
magento.async.customer: CartidSelectedpaymentmethodBody1
Fields
- method QuoteDataPaymentInterface - Interface PaymentInterface
magento.async.customer: CartidSetpaymentinformationBody
Fields
- email string -
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidSetpaymentinformationBody1
Fields
- email string -
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidSetpaymentinformationBody2
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidSetpaymentinformationBody3
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidShippinginformationBody
Fields
- addressInformation CheckoutDataShippingInformationInterface - Interface ShippingInformationInterface
magento.async.customer: CartidShippinginformationBody1
Fields
- addressInformation CheckoutDataShippingInformationInterface - Interface ShippingInformationInterface
magento.async.customer: CartidShippinginformationBody2
Fields
- addressInformation CheckoutDataShippingInformationInterface - Interface ShippingInformationInterface
magento.async.customer: CartidShippinginformationBody3
Fields
- addressInformation CheckoutDataShippingInformationInterface - Interface ShippingInformationInterface
magento.async.customer: CartidTotalsinformationBody
Fields
- addressInformation CheckoutDataTotalsInformationInterface - Interface TotalsInformationInterface
magento.async.customer: CartidTotalsinformationBody1
Fields
- addressInformation CheckoutDataTotalsInformationInterface - Interface TotalsInformationInterface
magento.async.customer: CartsMineBody
Fields
- quote QuoteDataCartInterface - Interface CartInterface
magento.async.customer: CartsMineBody1
Fields
- quote QuoteDataCartInterface - Interface CartInterface
magento.async.customer: CatalogDataCustomOptionExtensionInterface
ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface
Fields
- file_info FrameworkDataImageContentInterface? - Image Content data interface
magento.async.customer: 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.async.customer: CheckoutDataShippingInformationExtensionInterface
ExtensionInterface class for @see \Magento\Checkout\Api\Data\ShippingInformationInterface
magento.async.customer: 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.async.customer: CheckoutDataTotalsInformationExtensionInterface
ExtensionInterface class for @see \Magento\Checkout\Api\Data\TotalsInformationInterface
magento.async.customer: 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.async.customer: 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.async.customer: CompanyDataCompanyCustomerExtensionInterface
ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyCustomerInterface
magento.async.customer: 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.async.customer: ConfigurableProductDataConfigurableItemOptionValueExtensionInterface
ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface
magento.async.customer: 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.async.customer: 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.async.customer: CustomerDataAddressExtensionInterface
ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface
magento.async.customer: 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.async.customer: 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.async.customer: 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.async.customer: CustomerDataRegionExtensionInterface
ExtensionInterface class for @see \Magento\Customer\Api\Data\RegionInterface
magento.async.customer: 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.async.customer: CustomersIsemailavailableBody
Fields
- customerEmail string -
- websiteId int? - If not set, will use the current websiteId
magento.async.customer: CustomersIsemailavailableBody1
Fields
- customerEmail string -
- websiteId int? - If not set, will use the current websiteId
magento.async.customer: CustomersPasswordBody
Fields
- email string -
- template string -
- websiteId int? -
magento.async.customer: CustomersPasswordBody1
Fields
- email string -
- template string -
- websiteId int? -
magento.async.customer: CustomersResetpasswordBody
Fields
- email string - If empty value given then the customer will be matched by the RP token.
- resetToken string -
- newPassword string -
magento.async.customer: CustomersResetpasswordBody1
Fields
- email string - If empty value given then the customer will be matched by the RP token.
- resetToken string -
- newPassword string -
magento.async.customer: CustomerTokenBody
Fields
- username string -
- password string -
magento.async.customer: CustomerTokenBody1
Fields
- username string -
- password string -
magento.async.customer: DownloadableDataDownloadableOptionInterface
Downloadable Option
Fields
- downloadable_links int[] - The list of downloadable links
magento.async.customer: ErrorErrorsItem
Error details
Fields
- message string? - Error message
- parameters ErrorParameters? - Error parameters list
magento.async.customer: ErrorParametersItem
Error parameters item
Fields
- resources string? - ACL resource
- fieldName string? - Missing or invalid field name
- fieldValue string? - Incorrect field value
magento.async.customer: ErrorResponse
Fields
- message string - Error message
- errors ErrorErrors? - Errors list
- code int? - Error code
- parameters ErrorParameters? - Error parameters list
- trace string? - Stack trace
magento.async.customer: FrameworkAttributeInterface
Interface for custom attribute value.
Fields
- attribute_code string - Attribute code
- value string - Attribute value
magento.async.customer: FrameworkDataImageContentInterface
Image Content data interface
Fields
- base64_encoded_data string - Media data (base64 encoded content)
- 'type string - MIME type
- name string - Image name
magento.async.customer: GiftCardAccountDataGiftCardAccountExtensionInterface
ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface
magento.async.customer: 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.async.customer: GiftCardDataGiftCardOptionExtensionInterface
ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface
Fields
- giftcard_created_codes string[]? -
magento.async.customer: 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.async.customer: 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.async.customer: 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.async.customer: GiftmessageItemidBody
Fields
- giftMessage GiftMessageDataMessageInterface - Interface MessageInterface
magento.async.customer: GiftmessageItemidBody1
Fields
- giftMessage GiftMessageDataMessageInterface - Interface MessageInterface
magento.async.customer: GuestcartsCartidBody
Fields
- customerId int - The customer ID.
- storeId int -
magento.async.customer: GuestcartsCartidBody1
Fields
- customerId int - The customer ID.
- storeId int -
magento.async.customer: ItemsItemidBody
Fields
- cartItem QuoteDataCartItemInterface - Interface CartItemInterface
magento.async.customer: ItemsItemidBody1
Fields
- cartItem QuoteDataCartItemInterface - Interface CartItemInterface
magento.async.customer: MeActivateBody
Fields
- confirmationKey string -
magento.async.customer: MeActivateBody1
Fields
- confirmationKey string -
magento.async.customer: MePasswordBody
Fields
- currentPassword string -
- newPassword string -
magento.async.customer: MePasswordBody1
Fields
- currentPassword string -
- newPassword string -
magento.async.customer: 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.async.customer: 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.async.customer: MineEstimateshippingmethodsBody
Fields
- registryId int - The estimate registry id
magento.async.customer: MineEstimateshippingmethodsBody1
Fields
- registryId int - The estimate registry id
magento.async.customer: MinePaymentinformationBody
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: MinePaymentinformationBody1
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: MineSetpaymentinformationBody
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: MineSetpaymentinformationBody1
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: NegotiableQuoteDataNegotiableQuoteExtensionInterface
ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteInterface
magento.async.customer: 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.async.customer: NegotiableQuoteDataNegotiableQuoteItemExtensionInterface
ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemInterface
magento.async.customer: 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.async.customer: 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.async.customer: QuoteDataAddressExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface
Fields
- discounts SalesRuleDataRuleDiscountInterface[]? -
- gift_registry_id int? -
magento.async.customer: 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.async.customer: QuoteDataCartExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\CartInterface
Fields
- shipping_assignments QuoteDataShippingAssignmentInterface[]? -
- negotiable_quote NegotiableQuoteDataNegotiableQuoteInterface? - Interface NegotiableQuoteInterface
- amazon_order_reference_id AmazonPaymentDataQuoteLinkInterface? -
magento.async.customer: 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.async.customer: QuoteDataCartItemExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface
Fields
- discounts SalesRuleDataRuleDiscountInterface[]? -
- negotiable_quote_item NegotiableQuoteDataNegotiableQuoteItemInterface? - Interface CompanyQuoteConfigInterface
magento.async.customer: 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.async.customer: QuoteDataCurrencyExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\CurrencyInterface
magento.async.customer: 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.async.customer: QuoteDataPaymentExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\PaymentInterface
Fields
- agreement_ids string[]? -
magento.async.customer: 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.async.customer: 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.async.customer: QuoteDataProductOptionInterface
Product option interface
Fields
- extension_attributes QuoteDataProductOptionExtensionInterface? - ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface
magento.async.customer: QuoteDataShippingAssignmentExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingAssignmentInterface
magento.async.customer: QuoteDataShippingAssignmentInterface
Interface ShippingAssignmentInterface
Fields
- shipping QuoteDataShippingInterface - Interface ShippingInterface
- items QuoteDataCartItemInterface[] -
- extension_attributes QuoteDataShippingAssignmentExtensionInterface? - ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingAssignmentInterface
magento.async.customer: QuoteDataShippingExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingInterface
magento.async.customer: 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.async.customer: QuoteDataTotalsAdditionalDataExtensionInterface
ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsAdditionalDataInterface
Fields
- gift_messages GiftMessageDataMessageInterface[]? -
magento.async.customer: 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.async.customer: RequisitionListDataRequisitionListExtensionInterface
ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListInterface
magento.async.customer: RequisitionListDataRequisitionListInterface
Interface RequisitionListInterface
Fields
- id int - Requisition List ID
- customer_id int - Customer ID
- name string - Requisition List Name
- updated_at string - Requisition List Update Time
- description string - Requisition List Description
- items RequisitionListDataRequisitionListItemInterface[] - Requisition List Items
- extension_attributes RequisitionListDataRequisitionListExtensionInterface? - ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListInterface
magento.async.customer: RequisitionListDataRequisitionListItemExtensionInterface
ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListItemInterface
magento.async.customer: RequisitionListDataRequisitionListItemInterface
Interface RequisitionListItemInterface
Fields
- id int - Requisition List ID.
- sku int - Product SKU.
- requisition_list_id int - Requisition List ID.
- qty decimal - Product Qty.
- options string[] - Requisition list item options.
- store_id int - Store ID.
- added_at string - Added_at value.
- extension_attributes RequisitionListDataRequisitionListItemExtensionInterface? - ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListItemInterface
magento.async.customer: SalesRuleDataDiscountDataInterface
Discount Data Interface
Fields
- amount decimal - Amount
- base_amount decimal - Base Amount
- original_amount decimal - Original Amount
- base_original_amount decimal - Base Original Amount
magento.async.customer: SalesRuleDataRuleDiscountInterface
Rule discount Interface
Fields
- discount_data SalesRuleDataDiscountDataInterface - Discount Data Interface
- rule_label string - Rule Label
- rule_id int - Rule ID
magento.async.customer: V1CustomersBody
Fields
- customer CustomerDataCustomerInterface - Customer interface.
- password string? -
- redirectUrl string? -
magento.async.customer: V1CustomersBody1
Fields
- customer CustomerDataCustomerInterface - Customer interface.
- password string? -
- redirectUrl string? -
magento.async.customer: V1RequisitionListsBody
Fields
- requisitionList RequisitionListDataRequisitionListInterface - Interface RequisitionListInterface
magento.async.customer: V1RequisitionListsBody1
Fields
- requisitionList RequisitionListDataRequisitionListInterface - Interface RequisitionListInterface
magento.async.customer: VertexaddressvalidationVertexaddressBody
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
magento.async.customer: VertexaddressvalidationVertexaddressBody1
Fields
- address QuoteDataAddressInterface - Interface AddressInterface