This guide will walk through the steps needed to submit orders to UltraCart as a Channel Partner via REST API calls. This method is heavily used by Call Centers and Distribution websites.
The REST API does not accept credit card numbers or cvv numbers. If you are submitting orders with credit card payment information, you must use hosted fields to create tokens first. You may then include the card number and (optionally) the cvv number tokens. |
You must create an API key (Authorized Application).
You may do so here: Home → Configuration → Development (tab) → Authorized Applications / API Keys.
The API key must have Channel Partner permissions checked on that screen. Only those keys with Channel Partner permissions will display on the Channel Partner creation screen.
There is a one-to-one relationship between API Keys and Channel Partners. You must create a new API key for each Channel Partner.
For help creating an API Key, please see this related document: API Simple Key
With the UltraCart Merchant site, navigate to Home → Configuration → Custom Channel Partners
Click the New button to create a new channel partner.
Fill out all fields in the first section.
The Code field is a short alphanumeric code used to identify where the order originated.
The Name field is a human readable description of this channel partner.
The FTP password isn’t used by the REST API, but the same engine also powers our legacy methods and a check is done for it. It must be supplied.
Within the REST API section, select your API key that you created. If the list is empty, your key is most likely missing the channel partner read/write permission.
UltraCart provides the following language SDKs for accessing our API. You can access it directly using REST if you need an unsupported language.
Call the ChannelPartnerAPI.insertChannelPartnerOrder( )
See: https://www.ultracart.com/api/#Operation11
The api link above contains a complete example written in C#. (Most call centers use C#.)
https://secure.ultracart.com/merchant/configuration/apiManagementApp.do
Each API key has logging. Review the logs. Contact UltraCart is you have any problems. We support our REST API and SDKs via our free support and are eager to assist you with programming questions.
Documentation: https://www.ultracart.com/resources/api-and-webhooks.html