magento.async.customer
Module magento.async.customer
API
Definitions
![](https://bcentral-dev-packageicons.azureedge.net/images/ballerinax_magento.async.customer_1.3.1.png)
ballerinax/magento.async.customer Ballerina library
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![](/images/permalink.svg)
magento.async.customer: Client![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
function amazonPaymentAddressManagementV1GetBillingAddressPut(string amazonOrderReferenceId, AmazonbillingaddressAmazonorderreferenceidBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
amazon-billing-address/{amazonOrderReferenceId}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
amazonPaymentAddressManagementV1GetShippingAddressPut![](/images/permalink.svg)
function amazonPaymentAddressManagementV1GetShippingAddressPut(string amazonOrderReferenceId, AmazonshippingaddressAmazonorderreferenceidBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
amazon-shipping-address/{amazonOrderReferenceId}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
amazonPaymentOrderInformationManagementV1RemoveOrderReferenceDelete![](/images/permalink.svg)
function amazonPaymentOrderInformationManagementV1RemoveOrderReferenceDelete() returns Response|error
amazon/order-ref
giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPost![](/images/permalink.svg)
function giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPost(string cartId, CartidGiftcardsBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
carts/guest-carts/{cartId}/giftCards
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
giftCardAccountGuestGiftCardAccountManagementV1DeleteByQuoteIdDelete![](/images/permalink.svg)
function giftCardAccountGuestGiftCardAccountManagementV1DeleteByQuoteIdDelete(string cartId, string giftCardCode) returns AsynchronousOperationsDataAsyncResponseInterface|error
carts/guest-carts/{cartId}/giftCards/{giftCardCode}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteCartRepositoryV1SavePut![](/images/permalink.svg)
function quoteCartRepositoryV1SavePut(CartsMineBody payload) returns Response|error
carts/mine
Parameters
- payload CartsMineBody -
customerBalanceBalanceManagementV1ApplyPost![](/images/permalink.svg)
function customerBalanceBalanceManagementV1ApplyPost() returns AsynchronousOperationsDataAsyncResponseInterface|error
carts/mine/balance/apply
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteCartTotalManagementV1CollectTotalsPut![](/images/permalink.svg)
function quoteCartTotalManagementV1CollectTotalsPut(MineCollecttotalsBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
carts/mine/collect-totals
Parameters
- payload MineCollecttotalsBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost![](/images/permalink.svg)
function checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost(MinePaymentinformationBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
carts/mine/payment-information
Parameters
- payload MinePaymentinformationBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
checkoutPaymentInformationManagementV1SavePaymentInformationPost![](/images/permalink.svg)
function checkoutPaymentInformationManagementV1SavePaymentInformationPost(MineSetpaymentinformationBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
carts/mine/set-payment-information
Parameters
- payload MineSetpaymentinformationBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
customerAccountManagementV1CreateAccountPost![](/images/permalink.svg)
function customerAccountManagementV1CreateAccountPost(V1CustomersBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
customers
Parameters
- payload V1CustomersBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
customerAccountManagementV1IsEmailAvailablePost![](/images/permalink.svg)
function customerAccountManagementV1IsEmailAvailablePost(CustomersIsemailavailableBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
customers/isEmailAvailable
Parameters
- payload CustomersIsemailavailableBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
customerAccountManagementV1ActivateByIdPut![](/images/permalink.svg)
function customerAccountManagementV1ActivateByIdPut(MeActivateBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
customers/me/activate
Parameters
- payload MeActivateBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
customerAccountManagementV1ChangePasswordByIdPut![](/images/permalink.svg)
function customerAccountManagementV1ChangePasswordByIdPut(MePasswordBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
customers/me/password
Parameters
- payload MePasswordBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
customerAccountManagementV1InitiatePasswordResetPut![](/images/permalink.svg)
function customerAccountManagementV1InitiatePasswordResetPut(CustomersPasswordBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
customers/password
Parameters
- payload CustomersPasswordBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
customerAccountManagementV1ResetPasswordPost![](/images/permalink.svg)
function customerAccountManagementV1ResetPasswordPost(CustomersResetpasswordBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
customers/resetPassword
Parameters
- payload CustomersResetpasswordBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
giftRegistryShippingMethodManagementV1EstimateByRegistryIdPost![](/images/permalink.svg)
function giftRegistryShippingMethodManagementV1EstimateByRegistryIdPost(MineEstimateshippingmethodsBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
giftregistry/mine/estimate-shipping-methods
Parameters
- payload MineEstimateshippingmethodsBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestCartManagementV1CreateEmptyCartPost![](/images/permalink.svg)
function quoteGuestCartManagementV1CreateEmptyCartPost() returns AsynchronousOperationsDataAsyncResponseInterface|error
guest-carts
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestCartManagementV1AssignCustomerPut![](/images/permalink.svg)
function quoteGuestCartManagementV1AssignCustomerPut(string cartId, GuestcartsCartidBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
guest-carts/{cartId}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestBillingAddressManagementV1AssignPost![](/images/permalink.svg)
function quoteGuestBillingAddressManagementV1AssignPost(string cartId, CartidBillingaddressBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
guest-carts/{cartId}/billing-address
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestCartTotalManagementV1CollectTotalsPut![](/images/permalink.svg)
function quoteGuestCartTotalManagementV1CollectTotalsPut(string cartId, CartidCollecttotalsBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
guest-carts/{cartId}/collect-totals
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestCouponManagementV1RemoveDelete![](/images/permalink.svg)
function quoteGuestCouponManagementV1RemoveDelete(string cartId) returns AsynchronousOperationsDataAsyncResponseInterface|error
guest-carts/{cartId}/coupons
Parameters
- cartId string - The cart ID.
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestCouponManagementV1SetPut![](/images/permalink.svg)
function quoteGuestCouponManagementV1SetPut(string cartId, string couponCode) returns AsynchronousOperationsDataAsyncResponseInterface|error
guest-carts/{cartId}/coupons/{couponCode}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost![](/images/permalink.svg)
function quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost(string cartId, CartidEstimateshippingmethodsBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
guest-carts/{cartId}/estimate-shipping-methods
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
giftMessageGuestCartRepositoryV1SavePost![](/images/permalink.svg)
function giftMessageGuestCartRepositoryV1SavePost(string cartId, CartidGiftmessageBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
guest-carts/{cartId}/gift-message
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
giftMessageGuestItemRepositoryV1SavePost![](/images/permalink.svg)
function giftMessageGuestItemRepositoryV1SavePost(string cartId, int itemId, GiftmessageItemidBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
guest-carts/{cartId}/gift-message/{itemId}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestCartItemRepositoryV1SavePost![](/images/permalink.svg)
function quoteGuestCartItemRepositoryV1SavePost(string cartId, CartidItemsBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
guest-carts/{cartId}/items
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestCartItemRepositoryV1SavePut![](/images/permalink.svg)
function quoteGuestCartItemRepositoryV1SavePut(string cartId, string itemId, ItemsItemidBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
guest-carts/{cartId}/items/{itemId}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestCartItemRepositoryV1DeleteByIdDelete![](/images/permalink.svg)
function quoteGuestCartItemRepositoryV1DeleteByIdDelete(string cartId, int itemId) returns AsynchronousOperationsDataAsyncResponseInterface|error
guest-carts/{cartId}/items/{itemId}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestCartManagementV1PlaceOrderPut![](/images/permalink.svg)
function quoteGuestCartManagementV1PlaceOrderPut(string cartId, CartidOrderBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
guest-carts/{cartId}/order
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost![](/images/permalink.svg)
function checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost(string cartId, CartidPaymentinformationBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
guest-carts/{cartId}/payment-information
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
quoteGuestPaymentMethodManagementV1SetPut![](/images/permalink.svg)
function quoteGuestPaymentMethodManagementV1SetPut(string cartId, CartidSelectedpaymentmethodBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
guest-carts/{cartId}/selected-payment-method
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost![](/images/permalink.svg)
function checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost(string cartId, CartidSetpaymentinformationBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
guest-carts/{cartId}/set-payment-information
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
checkoutGuestShippingInformationManagementV1SaveAddressInformationPost![](/images/permalink.svg)
function checkoutGuestShippingInformationManagementV1SaveAddressInformationPost(string cartId, CartidShippinginformationBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
guest-carts/{cartId}/shipping-information
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
checkoutGuestTotalsInformationManagementV1CalculatePost![](/images/permalink.svg)
function checkoutGuestTotalsInformationManagementV1CalculatePost(string cartId, CartidTotalsinformationBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
guest-carts/{cartId}/totals-information
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPost![](/images/permalink.svg)
function giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPost(string cartId, CartidEstimateshippingmethodsBody2 payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
guest-giftregistry/{cartId}/estimate-shipping-methods
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
integrationAdminTokenServiceV1CreateAdminAccessTokenPost![](/images/permalink.svg)
function integrationAdminTokenServiceV1CreateAdminAccessTokenPost(AdminTokenBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
integration/admin/token
Parameters
- payload AdminTokenBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost![](/images/permalink.svg)
function integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost(CustomerTokenBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
integration/customer/token
Parameters
- payload CustomerTokenBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuoteBillingAddressManagementV1AssignPost![](/images/permalink.svg)
function negotiableQuoteBillingAddressManagementV1AssignPost(int cartId, CartidBillingaddressBody2 payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
negotiable-carts/{cartId}/billing-address
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuoteCouponManagementV1RemoveDelete![](/images/permalink.svg)
function negotiableQuoteCouponManagementV1RemoveDelete(int cartId) returns AsynchronousOperationsDataAsyncResponseInterface|error
negotiable-carts/{cartId}/coupons
Parameters
- cartId int - The cart ID.
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuoteCouponManagementV1SetPut![](/images/permalink.svg)
function negotiableQuoteCouponManagementV1SetPut(int cartId, string couponCode) returns AsynchronousOperationsDataAsyncResponseInterface|error
negotiable-carts/{cartId}/coupons/{couponCode}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuoteShipmentEstimationV1EstimateByExtendedAddressPost![](/images/permalink.svg)
function negotiableQuoteShipmentEstimationV1EstimateByExtendedAddressPost(string cartId, CartidEstimateshippingmethodsBody4 payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
negotiable-carts/{cartId}/estimate-shipping-methods
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuoteShippingMethodManagementV1EstimateByAddressIdPost![](/images/permalink.svg)
function negotiableQuoteShippingMethodManagementV1EstimateByAddressIdPost(int cartId, CartidEstimateshippingmethodsbyaddressidBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuoteGiftCardAccountManagementV1SaveByQuoteIdPost![](/images/permalink.svg)
function negotiableQuoteGiftCardAccountManagementV1SaveByQuoteIdPost(int cartId, CartidGiftcardsBody2 payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
negotiable-carts/{cartId}/giftCards
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuoteGiftCardAccountManagementV1DeleteByQuoteIdDelete![](/images/permalink.svg)
function negotiableQuoteGiftCardAccountManagementV1DeleteByQuoteIdDelete(int cartId, string giftCardCode) returns AsynchronousOperationsDataAsyncResponseInterface|error
negotiable-carts/{cartId}/giftCards/{giftCardCode}
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuotePaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost![](/images/permalink.svg)
function negotiableQuotePaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost(int cartId, CartidPaymentinformationBody2 payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
negotiable-carts/{cartId}/payment-information
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuotePaymentInformationManagementV1SavePaymentInformationPost![](/images/permalink.svg)
function negotiableQuotePaymentInformationManagementV1SavePaymentInformationPost(int cartId, CartidSetpaymentinformationBody2 payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
negotiable-carts/{cartId}/set-payment-information
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
negotiableQuoteShippingInformationManagementV1SaveAddressInformationPost![](/images/permalink.svg)
function negotiableQuoteShippingInformationManagementV1SaveAddressInformationPost(int cartId, CartidShippinginformationBody2 payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
negotiable-carts/{cartId}/shipping-information
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
requisitionListRequisitionListRepositoryV1SavePost![](/images/permalink.svg)
function requisitionListRequisitionListRepositoryV1SavePost(V1RequisitionListsBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
requisition_lists
Parameters
- payload V1RequisitionListsBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
rewardRewardManagementV1SetPost![](/images/permalink.svg)
function rewardRewardManagementV1SetPost() returns AsynchronousOperationsDataAsyncResponseInterface|error
reward/mine/use-reward
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
vertexAddressValidationAddressManagementV1GetValidAddressPost![](/images/permalink.svg)
function vertexAddressValidationAddressManagementV1GetValidAddressPost(VertexaddressvalidationVertexaddressBody payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
vertex-address-validation/vertex-address
Parameters
- payload VertexaddressvalidationVertexaddressBody -
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
worldpayGuestPaymentInformationManagementProxyV1SavePaymentInformationAndPlaceOrderPost![](/images/permalink.svg)
function worldpayGuestPaymentInformationManagementProxyV1SavePaymentInformationAndPlaceOrderPost(string cartId, CartidPaymentinformationBody4 payload) returns AsynchronousOperationsDataAsyncResponseInterface|error
worldpay-guest-carts/{cartId}/payment-information
Return Type
- AsynchronousOperationsDataAsyncResponseInterface|error - 202 Accepted.
Records![](/images/permalink.svg)
magento.async.customer: AdminTokenBody![](/images/permalink.svg)
Fields
- username string -
- password string -
magento.async.customer: AdminTokenBody1![](/images/permalink.svg)
Fields
- username string -
- password string -
magento.async.customer: AmazonbillingaddressAmazonorderreferenceidBody![](/images/permalink.svg)
Fields
- addressConsentToken string -
magento.async.customer: AmazonbillingaddressAmazonorderreferenceidBody1![](/images/permalink.svg)
Fields
- addressConsentToken string -
magento.async.customer: AmazonPaymentDataQuoteLinkInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- addressConsentToken string -
magento.async.customer: AmazonshippingaddressAmazonorderreferenceidBody1![](/images/permalink.svg)
Fields
- addressConsentToken string -
magento.async.customer: AsynchronousOperationsDataAsyncResponseExtensionInterface![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\AsynchronousOperations\Api\Data\AsyncResponseInterface
magento.async.customer: AsynchronousOperationsDataAsyncResponseInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface
magento.async.customer: BundleDataBundleOptionInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
- useForShipping boolean? -
magento.async.customer: CartidBillingaddressBody1![](/images/permalink.svg)
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
- useForShipping boolean? -
magento.async.customer: CartidBillingaddressBody2![](/images/permalink.svg)
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
- useForShipping boolean? -
magento.async.customer: CartidBillingaddressBody3![](/images/permalink.svg)
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
- useForShipping boolean? -
magento.async.customer: CartidCollecttotalsBody![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
magento.async.customer: CartidEstimateshippingmethodsBody1![](/images/permalink.svg)
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
magento.async.customer: CartidEstimateshippingmethodsBody2![](/images/permalink.svg)
Fields
- registryId int - The estimate registry id
magento.async.customer: CartidEstimateshippingmethodsBody3![](/images/permalink.svg)
Fields
- registryId int - The estimate registry id
magento.async.customer: CartidEstimateshippingmethodsBody4![](/images/permalink.svg)
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
magento.async.customer: CartidEstimateshippingmethodsBody5![](/images/permalink.svg)
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
magento.async.customer: CartidEstimateshippingmethodsbyaddressidBody![](/images/permalink.svg)
Fields
- addressId int - The estimate address id
magento.async.customer: CartidEstimateshippingmethodsbyaddressidBody1![](/images/permalink.svg)
Fields
- addressId int - The estimate address id
magento.async.customer: CartidGiftcardsBody![](/images/permalink.svg)
Fields
- giftCardAccountData GiftCardAccountDataGiftCardAccountInterface - Gift Card Account data
magento.async.customer: CartidGiftcardsBody1![](/images/permalink.svg)
Fields
- giftCardAccountData GiftCardAccountDataGiftCardAccountInterface - Gift Card Account data
magento.async.customer: CartidGiftcardsBody2![](/images/permalink.svg)
Fields
- giftCardAccountData GiftCardAccountDataGiftCardAccountInterface - Gift Card Account data
magento.async.customer: CartidGiftcardsBody3![](/images/permalink.svg)
Fields
- giftCardAccountData GiftCardAccountDataGiftCardAccountInterface - Gift Card Account data
magento.async.customer: CartidGiftmessageBody![](/images/permalink.svg)
Fields
- giftMessage GiftMessageDataMessageInterface - Interface MessageInterface
magento.async.customer: CartidGiftmessageBody1![](/images/permalink.svg)
Fields
- giftMessage GiftMessageDataMessageInterface - Interface MessageInterface
magento.async.customer: CartidItemsBody![](/images/permalink.svg)
Fields
- cartItem QuoteDataCartItemInterface - Interface CartItemInterface
magento.async.customer: CartidItemsBody1![](/images/permalink.svg)
Fields
- cartItem QuoteDataCartItemInterface - Interface CartItemInterface
magento.async.customer: CartidOrderBody![](/images/permalink.svg)
Fields
- paymentMethod QuoteDataPaymentInterface? - Interface PaymentInterface
magento.async.customer: CartidOrderBody1![](/images/permalink.svg)
Fields
- paymentMethod QuoteDataPaymentInterface? - Interface PaymentInterface
magento.async.customer: CartidPaymentinformationBody![](/images/permalink.svg)
Fields
- email string -
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidPaymentinformationBody1![](/images/permalink.svg)
Fields
- email string -
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidPaymentinformationBody2![](/images/permalink.svg)
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidPaymentinformationBody3![](/images/permalink.svg)
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidPaymentinformationBody4![](/images/permalink.svg)
Fields
- email string -
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidPaymentinformationBody5![](/images/permalink.svg)
Fields
- email string -
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidSelectedpaymentmethodBody![](/images/permalink.svg)
Fields
- method QuoteDataPaymentInterface - Interface PaymentInterface
magento.async.customer: CartidSelectedpaymentmethodBody1![](/images/permalink.svg)
Fields
- method QuoteDataPaymentInterface - Interface PaymentInterface
magento.async.customer: CartidSetpaymentinformationBody![](/images/permalink.svg)
Fields
- email string -
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidSetpaymentinformationBody1![](/images/permalink.svg)
Fields
- email string -
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidSetpaymentinformationBody2![](/images/permalink.svg)
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidSetpaymentinformationBody3![](/images/permalink.svg)
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: CartidShippinginformationBody![](/images/permalink.svg)
Fields
- addressInformation CheckoutDataShippingInformationInterface - Interface ShippingInformationInterface
magento.async.customer: CartidShippinginformationBody1![](/images/permalink.svg)
Fields
- addressInformation CheckoutDataShippingInformationInterface - Interface ShippingInformationInterface
magento.async.customer: CartidShippinginformationBody2![](/images/permalink.svg)
Fields
- addressInformation CheckoutDataShippingInformationInterface - Interface ShippingInformationInterface
magento.async.customer: CartidShippinginformationBody3![](/images/permalink.svg)
Fields
- addressInformation CheckoutDataShippingInformationInterface - Interface ShippingInformationInterface
magento.async.customer: CartidTotalsinformationBody![](/images/permalink.svg)
Fields
- addressInformation CheckoutDataTotalsInformationInterface - Interface TotalsInformationInterface
magento.async.customer: CartidTotalsinformationBody1![](/images/permalink.svg)
Fields
- addressInformation CheckoutDataTotalsInformationInterface - Interface TotalsInformationInterface
magento.async.customer: CartsMineBody![](/images/permalink.svg)
Fields
- quote QuoteDataCartInterface - Interface CartInterface
magento.async.customer: CartsMineBody1![](/images/permalink.svg)
Fields
- quote QuoteDataCartInterface - Interface CartInterface
magento.async.customer: CatalogDataCustomOptionExtensionInterface![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface
Fields
- file_info FrameworkDataImageContentInterface? - Image Content data interface
magento.async.customer: CatalogDataCustomOptionInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\Checkout\Api\Data\ShippingInformationInterface
magento.async.customer: CheckoutDataShippingInformationInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\Checkout\Api\Data\TotalsInformationInterface
magento.async.customer: CheckoutDataTotalsInformationInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyCustomerInterface
magento.async.customer: CompanyDataCompanyCustomerInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface
magento.async.customer: ConfigurableProductDataConfigurableItemOptionValueInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
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-forwarded
header
- 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![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface
magento.async.customer: CustomerDataAddressInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\Customer\Api\Data\RegionInterface
magento.async.customer: CustomerDataRegionInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- customerEmail string -
- websiteId int? - If not set, will use the current websiteId
magento.async.customer: CustomersIsemailavailableBody1![](/images/permalink.svg)
Fields
- customerEmail string -
- websiteId int? - If not set, will use the current websiteId
magento.async.customer: CustomersPasswordBody![](/images/permalink.svg)
Fields
- email string -
- template string -
- websiteId int? -
magento.async.customer: CustomersPasswordBody1![](/images/permalink.svg)
Fields
- email string -
- template string -
- websiteId int? -
magento.async.customer: CustomersResetpasswordBody![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- username string -
- password string -
magento.async.customer: CustomerTokenBody1![](/images/permalink.svg)
Fields
- username string -
- password string -
magento.async.customer: DownloadableDataDownloadableOptionInterface![](/images/permalink.svg)
Downloadable Option
Fields
- downloadable_links int[] - The list of downloadable links
magento.async.customer: ErrorErrorsItem![](/images/permalink.svg)
Error details
Fields
- message string? - Error message
- parameters ErrorParameters? - Error parameters list
magento.async.customer: ErrorParametersItem![](/images/permalink.svg)
Error parameters item
Fields
- resources string? - ACL resource
- fieldName string? - Missing or invalid field name
- fieldValue string? - Incorrect field value
magento.async.customer: ErrorResponse![](/images/permalink.svg)
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![](/images/permalink.svg)
Interface for custom attribute value.
Fields
- attribute_code string - Attribute code
- value string - Attribute value
magento.async.customer: FrameworkDataImageContentInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface
magento.async.customer: GiftCardAccountDataGiftCardAccountInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface
Fields
- giftcard_created_codes string[]? -
magento.async.customer: GiftCardDataGiftCardOptionInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- giftMessage GiftMessageDataMessageInterface - Interface MessageInterface
magento.async.customer: GiftmessageItemidBody1![](/images/permalink.svg)
Fields
- giftMessage GiftMessageDataMessageInterface - Interface MessageInterface
magento.async.customer: GuestcartsCartidBody![](/images/permalink.svg)
Fields
- customerId int - The customer ID.
- storeId int -
magento.async.customer: GuestcartsCartidBody1![](/images/permalink.svg)
Fields
- customerId int - The customer ID.
- storeId int -
magento.async.customer: ItemsItemidBody![](/images/permalink.svg)
Fields
- cartItem QuoteDataCartItemInterface - Interface CartItemInterface
magento.async.customer: ItemsItemidBody1![](/images/permalink.svg)
Fields
- cartItem QuoteDataCartItemInterface - Interface CartItemInterface
magento.async.customer: MeActivateBody![](/images/permalink.svg)
Fields
- confirmationKey string -
magento.async.customer: MeActivateBody1![](/images/permalink.svg)
Fields
- confirmationKey string -
magento.async.customer: MePasswordBody![](/images/permalink.svg)
Fields
- currentPassword string -
- newPassword string -
magento.async.customer: MePasswordBody1![](/images/permalink.svg)
Fields
- currentPassword string -
- newPassword string -
magento.async.customer: MineCollecttotalsBody![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- registryId int - The estimate registry id
magento.async.customer: MineEstimateshippingmethodsBody1![](/images/permalink.svg)
Fields
- registryId int - The estimate registry id
magento.async.customer: MinePaymentinformationBody![](/images/permalink.svg)
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: MinePaymentinformationBody1![](/images/permalink.svg)
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: MineSetpaymentinformationBody![](/images/permalink.svg)
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: MineSetpaymentinformationBody1![](/images/permalink.svg)
Fields
- paymentMethod QuoteDataPaymentInterface - Interface PaymentInterface
- billingAddress QuoteDataAddressInterface? - Interface AddressInterface
magento.async.customer: NegotiableQuoteDataNegotiableQuoteExtensionInterface![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteInterface
magento.async.customer: NegotiableQuoteDataNegotiableQuoteInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemInterface
magento.async.customer: NegotiableQuoteDataNegotiableQuoteItemInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface
Fields
- discounts SalesRuleDataRuleDiscountInterface[]? -
- gift_registry_id int? -
magento.async.customer: QuoteDataAddressInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface
Fields
- discounts SalesRuleDataRuleDiscountInterface[]? -
- negotiable_quote_item NegotiableQuoteDataNegotiableQuoteItemInterface? - Interface CompanyQuoteConfigInterface
magento.async.customer: QuoteDataCartItemInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\Quote\Api\Data\CurrencyInterface
magento.async.customer: QuoteDataCurrencyInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\Quote\Api\Data\PaymentInterface
Fields
- agreement_ids string[]? -
magento.async.customer: QuoteDataPaymentInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
Product option interface
Fields
- extension_attributes QuoteDataProductOptionExtensionInterface? - ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface
magento.async.customer: QuoteDataShippingAssignmentExtensionInterface![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingAssignmentInterface
magento.async.customer: QuoteDataShippingAssignmentInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingInterface
magento.async.customer: QuoteDataShippingInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsAdditionalDataInterface
Fields
- gift_messages GiftMessageDataMessageInterface[]? -
magento.async.customer: QuoteDataTotalsAdditionalDataInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListInterface
magento.async.customer: RequisitionListDataRequisitionListInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListItemInterface
magento.async.customer: RequisitionListDataRequisitionListItemInterface![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
Rule discount Interface
Fields
- discount_data SalesRuleDataDiscountDataInterface - Discount Data Interface
- rule_label string - Rule Label
- rule_id int - Rule ID
magento.async.customer: V1CustomersBody![](/images/permalink.svg)
Fields
- customer CustomerDataCustomerInterface - Customer interface.
- password string? -
- redirectUrl string? -
magento.async.customer: V1CustomersBody1![](/images/permalink.svg)
Fields
- customer CustomerDataCustomerInterface - Customer interface.
- password string? -
- redirectUrl string? -
magento.async.customer: V1RequisitionListsBody![](/images/permalink.svg)
Fields
- requisitionList RequisitionListDataRequisitionListInterface - Interface RequisitionListInterface
magento.async.customer: V1RequisitionListsBody1![](/images/permalink.svg)
Fields
- requisitionList RequisitionListDataRequisitionListInterface - Interface RequisitionListInterface
magento.async.customer: VertexaddressvalidationVertexaddressBody![](/images/permalink.svg)
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
magento.async.customer: VertexaddressvalidationVertexaddressBody1![](/images/permalink.svg)
Fields
- address QuoteDataAddressInterface - Interface AddressInterface
Import
import ballerinax/magento.async.customer;
Metadata
Released date: about 1 year ago
Version: 1.3.1
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.4.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Commerce/eCommerce
Cost/Paid
Contributors
Dependencies