Overview

To begin using the Intrakr API, it must be enabled through your account settings. Check the box that reads Enable API Access.

Screen_Shot_2013-05-19_at_6.12.31_PM.png

 

You will be shown your Account ID and API Key. At any time, you may click Generate New Key to create a new API Key associated with your account. By doing this, any scripts or utilities using the old API Key will no longer function.

Request Url

The request url for a request must match the following format:

https://app.intrakr.com/api/OBJECT/ACTION

Available Objects

Through the API, you can access the following objects. Within each object's article is a list of available actions.

Global

Accounts

Users

Products

Purchase Orders

Orders

Customers

Vendors

Content

Currently, the API accepts POST requests, where the body of the request is a valid JSON document.

Authentication

See API Authentication.

Response

Success

Upon a successful request, the response will have a 200 status code with a JSON object as its response.

Account Limit

If an account limit has been reached, a 202 status code will be returned with a description.

Namespace Conflict

If there is a namespace conflict (e.g., order number already exists), a 406 status code will be returned with a description.

Unauthorized

If the requestor doesn't have access to the API path requested, a 401 status code will be returned.

Input Errors

If the data provided to the API is incorrect, a 400 error will be returned and the problem described in the error message.

Forbidden

A 403 response will be returned if the specified request is forbidden by the server.

Server Error

If there is an unknown server error, a 500 status code will be returned.

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk