Introduction

Table of Contents

The UltraCart API is organized around REST and JSON. Our API uses cutting edge REST API functionality to deliver resource-oriented URLs that are efficient at exposing the maximum amount of functionality in an easy to use interface. Our APIs are all defined using the OpenAPI (Swagger) specification which allows us to provide generated client libraries and documentation that are always accurate and efficient to program against. Whenever possible, JSON is the format for the request and the response of our APIs and our client libraries convert the information into language specific objects.

Getting Started

• Read the topics listed above. They're all short. You'll save yourself much grief.
• Create an API Key by following the tutorial.
• Download and install your SDK of choice.
• Review the samples provided to jump start your project.
• If you get stuck...
  • Review the logs. Go to Home → Configuration → API Management and click the log button at the right of your api key.
  • Email support if you have questions or get stuck with the following:
    • The SDK you're using including version.
    • A stack trace or error message.
    • Your code, if at all possible. The more we can replicate, the better we can assist.
    • The data you're using. If you're operating on a particular Order or Customer, provide us that information.