Module magento.address
ballerinax/magento.address Ballerina library
Overview
The Magento REST API v2.2 connector(https://devdocs.magento.com/guides/v2.4/rest/bk-rest.html) OpenAPI specification.
The Magento B2B Rest API service enables applications to build and manage a customized commerce store.
Key Features
- Programmatic access to create and manage resources via REST API
- Secure authentication with API key or OAuth support
- Seamless integration with REST API endpoints
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Obtain tokens by following this guide
Clients
magento.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 (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - 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|errorUpdate 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|errorUpdate 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|erroranalytics/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: ClientHttp1Settings
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.address: ConnectionConfig
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.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
magento.address: ProxyConfig
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
Array types
magento.address: ErrorErrors
ErrorErrors
Errors list
magento.address: ErrorParameters
ErrorParameters
Error parameters list