Sections

• Overview
• API Usage
• Errors

Endpoints

Calls to the API must be for genuine use and responses from the API must not be stored for the purpose of creating an offline copy of the information stored. Failure to comply with this requirement will infringe the API License.

Business Unit API Calls

Create Business Unit

POST /business-units

Purpose

To create a business unit under your API account.

Inputs

• legalName - The business unit's legal name.
• reportName - Used on any reports we generate for you.

Example Request

POST /business-units HTTP/1.1
Content-Type: application/json

{
    "legalName": "Amce Traders Inc.",
    "reportName": "Amce Traders"
}

Output

A unique business unit ID. You will need this ID whenever you create a store within this business unit. The response headers will return status code "201 Created".

In the event of an error the id will not be returned. Instead, a JSON object containing an errors array will be returned. For details on the errors array please read the Errors page.

Example Response

Response on Success:

HTTP/1.1 201 Created
Content-Type: application/json

{
    "id": 68,
    "legalName": "Amce Traders Inc.",
    "reportName": "Amce Traders",
    "status": "activated"
}

Response on Error:

HTTP/1.1 400 Human readable error message
Content-Type: application/json

{
    "errors":
    [
        {
            "id": n,
            "message": "Human readable message"
        }
    ]
}