Vendors

Add

Adds a new vendor to the database.

POST

https://app.intrakr.com/api/vendors/add

POST Content

{
"cid": "Custom ID to assign to the vendor",
"name": [Required] "Name of the vendor",
"account" [Required] "Account ID to save the vendor under",
"address": String,
"phone": String
"email": String,
"url": String
"taxRate": Float

Response

{ "id": "The new Intrakr ID of the vendor created.",
"added": true

Modify

Modifies an existing vendor.

POST

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

POST Content

{
"id": "The Intrakr ID of the vendor to save",
"cid": "Custom ID to assign to the vendor",
"name": "Name of the vendor. Can not be blank if provided.",
"address": String,
"phone": String
"email": String,
"url": String
"taxRate": Float

Response

{ "id": "ID of the vendor that was updated.",
"updated": true

Remove

Removes an existing vendor.

POST

https://app.intrakr.com/api/vendor/remove

POST Content

{ "id": "The Intrakr ID of the vendor to remove" }

Response

{ "id": "ID of the vendor that was removed.",
"removed": true

Search

Searches for vendors in the given account.

POST

https://app.intrakr.com/api/vendors/search

POST Content

{ "account": "The ID of the account to get all vendors for",
  "search": Search string,
  "skip": The number of results to skip,
  "limit": The number of results to return.
  "sort": (String) The field to sort by.
} 

Response

{ "total": Total number of vendors that match the query.,
"vendors": Array of vendor objects.

Import

Imports vendors from a CSV file.

POST

https://app.intrakr.com/api/vendors/import

POST Content

{ "account": Account ID,
"del": The column delimiter,
"key": Array of what each column should match to for the vendor,
"file": Base64 encoded file contents, including a header } 

Response

{ "imported": true }

Example

{ account: "51093df84623aef5ae25dd14",
"del": ",",
"key": ["name","phone","address"],
"file": "data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAB/wAAAVcCAIAAAC+..."
}

 

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk