Adobe self-service APIs
Introduction
This article highlights Appxite offerings in regard to Abobe APIs. Accessing these and executing is a self-service process which in nearly all cases can be processed by Partners themselves.
Appxite APIs will help you manage orders and subscriptions data, get seamlessly migrate your Adobe customers to VIP MP, synchronize migrated customers into platform and move customers between different partners, i.e. from one VIP MP to another VIP MP.
In this article:
- Getting Access
- Customer and Order Management Endpoints
- Migrate Customer to VIP MP
- Move Customers Between Partners
Getting Access
If the partner does not yet have the necessary API access, it can be obtained as described in guide below:
AppXite Platform API Access
From this point the APIs can be executed from this resource:
Developer Portal - Adobe
Customer and Order Management Endpoints
Retrieve Customer Account
Retrieves comprehensive account information and profile details for a specified customer.
Get Customer Purchase Requests
Fetches all purchase requests initiated by a specific customer that are pending or in progress.
Get Customer Purchase Requests
Fetch Order Details
Returns detailed information about a specific order including items, status, and transaction history.
Get Partner Order Notifications
Retrieves pending order notifications and alerts for a specific reseller partner.
Get Partner Order Notifications
Retrieve Subscription Details
Fetches comprehensive details about a specific customer subscription including billing and status information.
List Customer Subscriptions
Returns all active and inactive subscriptions associated with a specific customer account.
Search Order History
Enables searching through a customer's complete order history with filtering and pagination options.
Update Customer Profile
Modifies specific fields in a customer's profile information such as contact details or preferences.
Update Customer Profile
Important notes related with update customer profile:
-
Field Requirements and Restrictions
Non-editable fields like companyName, country, and region must be included in requests and match their original values exactly. Any mismatch will result in an error response. -
Contact Management
When adding new contacts through this API, they automatically receive admin privileges for the customer's account. However, removing contacts from the API request does not revoke their admin status. To fully remove admin access, customer administrators must use the Adobe Admin Console directly.
Additionally, existing contact names cannot be modified through this API. Name changes must be handled by customer admins within the Admin Console. -
Market Segment Updates
Customer market segments can only be changed via the Update Customer API when the customer has no active subscriptions. Before making this change, ensure the reseller is enabled for the target market segment. -
External Reference ID
The customer's externalReferenceId can now be updated through the Update Customer API.
Update Cart Level
Based on the provided list of Adobe orderItems with respective quantities, returns updated offer price level keys.
Migrate Customers to VIP MP
Validate whether Customer is Eligible for Migration
Validate whether a customer organization is eligible for migrating to Adobe VIP MP using this resource:
Validate Customer for Migration
Migrate Customer to VIP MP
Migrate customer organization to Adobe VIP MP using this resource:
Migrate Customer to VIP MP
Synchronize the Customer and their Subscriptions to the Platform
Synchronize customer subscriptions from Adobe to selected customer organization on the Platform using this resource:
Sync Customer Adobe Subscriptions
Retrieve Migration Status
Retrieve information for Adobe VIPMP customer migration status using this resource:
Get Migration Status
Move Customers Between Partners
Customers can opt to switch to a different Adobe reseller and continue to manage their subscriptions and new orders with the new reseller. Reseller change is a customer-initiated process where a customer administrator generates the approval code in Adobe Admin Console to allow a new reseller to perform the change. After that, all customer subscription data is synchronized to a new reseller in the AppXite platform.
The reseller change is ineligible if:
- a customer has open or complete orders in the cancellation window
- a customer ERPID already has an active Adobe tenant in the AppXite platform.
Validate whether Customer is Eligible for Reseller Change
Validate whether a customer organization is eligible for reseller change using this resource:
Reseller Change Validation
Change from one VIP MP to another VIP MP
Move customers between different partners, i.e. from one VIP MP to another VIP MP, using this resource:
Reseller Actual Change
Retrieve Reseller Status Change
Retrieve resellers change status, using this resource:
Get Reseller Change Status
Limitations
The functionalities mentioned above can be carried out only by executing the API calls and as of R168 are not part of AppXite Platform UI.
In case you encounter any issues, please reach out to us to AppXite Support Team.
Summary
Once customer has been migrated to VIP MP, synchronization to the platform can be started. Some of the functionalities and not inclusive are:
- Create organization and tenant
- Synchronize and co-term subscriptions based on based on customer's Adobe account
- Apply the right discounts based on customer's Adobe account.
Add comment
Please sign in to leave a comment.