magento.address
Module magento.address
API
ballerinax/magento.address Ballerina library
Overview
This is a generated connector for Magento REST API v2.2 OpenAPI specification.
The Magento B2B Rest API service enables applications to build and manage a customized commerce store.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Obtain tokens by following this guide
Clients
magento.address: Client
This is a generated connector for Magento REST API v2.2 OpenAPI specification. The Magento B2B Rest API service enables applications to build and manage a customized commerce store.
Constructor
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Follow this guide and obtain tokens.
init (ClientConfig clientConfig, string serviceUrl)
- clientConfig ClientConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
customerAddressDeleteByIdV1
Delete customer address by ID.
Parameters
- addressId int - Address ID
updateAmazonPaymentAddressV1
function updateAmazonPaymentAddressV1(string amazonOrderReferenceId, AmazonbillingaddressAmazonorderreferenceidBody payload) returns string|error
Update Amazon-billing-address by ID
Parameters
- amazonOrderReferenceId string - Amazon order reference ID
- payload AmazonbillingaddressAmazonorderreferenceidBody - Address Consent Token
updateAmazonPaymentShippingAddress
function updateAmazonPaymentShippingAddress(string amazonOrderReferenceId, AmazonshippingaddressAmazonorderreferenceidBody payload) returns string|error
Update amazon-shipping-address by reference ID
Parameters
- amazonOrderReferenceId string - Amazon Order Reference ID
- payload AmazonshippingaddressAmazonorderreferenceidBody - Address consent token
deleteAmazonPaymentOrderReferenceV1
amazon/order-ref
getAnalyticsLinkV1
function getAnalyticsLinkV1() returns AnalyticsDataLinkInterface|error
analytics/link
Return Type
- AnalyticsDataLinkInterface|error - 200 Success.
Records
magento.address: AmazonbillingaddressAmazonorderreferenceidBody
Address Consent Token
Fields
- addressConsentToken string - Address Consent Token
magento.address: AmazonbillingaddressAmazonorderreferenceidBody1
Address Consent Token(XML)
Fields
- addressConsentToken string - Address Consent Token
magento.address: AmazonshippingaddressAmazonorderreferenceidBody
Address Consent Token (JSON)
Fields
- addressConsentToken string - Address Consent Token
magento.address: AmazonshippingaddressAmazonorderreferenceidBody1
Address Consent Token (XML)
Fields
- addressConsentToken string - Address Consent Token
magento.address: AnalyticsDataLinkInterface
Interface LinkInterface Represents link with collected data and initialized vector for decryption.
Fields
- url string - URL
- initialization_vector string - initialization vector
magento.address: ClientConfig
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 string(default "1.1") - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - 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
- followRedirects FollowRedirects?(default ()) - Configurations associated with Redirection
- poolConfig PoolConfiguration?(default ()) - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig?(default ()) - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig?(default ()) - Configurations associated with retrying
- cookieConfig CookieConfig?(default ()) - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket?(default ()) - SSL/TLS-related options
magento.address: ErrorErrorsItem
Error details
Fields
- message string? - Error message
- parameters ErrorParameters? - Error parameters list
magento.address: ErrorParametersItem
Error parameters item
Fields
- resources string? - ACL resource
- fieldName string? - Missing or invalid field name
- fieldValue string? - Incorrect field value
magento.address: ErrorResponse
Fields
- message string - Error message
- errors ErrorErrors? - Errors list
- code int? - Error code
- parameters ErrorParameters? - Error parameters list
- trace string? - Stack trace
Import
import ballerinax/magento.address;
Metadata
Released date: over 2 years ago
Version: 1.0.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.0.0
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Commerce/eCommerce
Cost/Paid
Contributors
Dependencies