This guide explains how to integrate Mavenoid with Adobe Commerce using the REST V1 Search API endpoint with OAuth-based Authentication to retrieve and display customer order information.
Admin Access To Mavenoid: If you do not have admin permissions, please reach out to your Mavenoid representative.
OAuth Credentials: Refer to Adobe's guide on OAuth-based authentication for setup details.
Use the Custom JavaScript action to configure the integration.
Set Up Authentication:
Obtain oauth_consumer_key
, oauth_token
, and oauth_token_secret
from your Adobe Commerce setup. Use these values to create the OAuth Signature.
Create a Signature: The signature is generated by combining the HTTP method, base URL, and parameters into a base string, which is then hashed using a secret key. This process ensures secure communication with the API. For more details, refer to Create a signature.
Access the web APIs using the constructed signature and token values. For more details on accessing the web APIs, refer to Access the web APIs.
Retrieve Order Information:
Use the Adobe REST V1 Search API to query customer orders. An example API request would be:
GET /rest/V1/orders?searchCriteria[filter_groups][0][filters][0][field]=increment_id&searchCriteria[filter_groups][0][filters][0][value]=${order_number} HTTP/1.1
Host: magento.host
Authorization: OAuth oauth_consumer_key="{your_oauth_consumer_key}",
oauth_nonce="{your_oauth_nonce}",
oauth_signature_method="HMAC-SHA256",
oauth_signature="{your_oauth_signature}",
oauth_timestamp="{your_oauth_timestamp}",
oauth_token="{your_oauth_token}"
Content-Type: application/json