Accounts

Schema

{
"id": [Required] The ID of the account to modify.
"name": The name of the account.
"filters": List of quick filters for the account.
"categories": List of product categories.
"admins": List of users to assign as admins to this account.
"company": {
  "name": The name of the company.
   "address": Company Address.
   "phone: Company phone.
   "email: Company email.
   "url: Company Url.
 }, "lastOrderNumber": Last order number that was used (as string). "lastPoNumber": Last PO number that was used (as string).

Modify

Used to modify an existing account. Only required field is id.

Notes

  • When setting a property that has a list or another object as its value (admins, vendors, customers, company), the entire value must be passed. For example, setting a company url only will set the company name, address, etc. to null.

Response

Upon a successful request, a 200 status code will be returned with the following JSON object in the response body:

{ "id": "ACCOUNT ID", "updated": true }

Example

Update the name and company information for an account.

POST

https://app.intrakr.com/api/accounts/modify

POST Data

{
"id": "51093df84623aef5ae25dd14",
"name": "ABC Widgets",
"company": {
"name": "ABC Widgets, LLC",
"address": "123 Widget Lane\nWidget, WA 12345",
"phone": "(123) 123-1234",
"email": "info@abcwidgets.com",
"url": "http://www.abcwidgets.com"
}
}

Get

Gets all data for a single account. Only required field is id.

Response

Upon a successful request, a 200 status code will be returned with a JSON object matching the schema described above. In addition, the property totalItems will be given with the total number of items in the account.

Example

Get all data for account 51093df84623aef5ae25dd14

POST

https://app.intrakr.com/api/accounts/get

POST Data

{ "id": "51093df84623aef5ae25dd14" }

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk