API reference / Vendors

Vendors API

7 endpoints. Scopes: Scalar360.vendors.READ, .CREATE, .UPDATE, .DELETE or .ALL. All calls need Authorization: Scalar360-oauthtoken <access_token> — see Authentication.

GET

List vendors

/api/v1/vendors

Scope: Scalar360.vendors.READ

Parameter	In	Type	Required
`status`	query	string	No
`search`	query	string	No
`q`	query	string	No
`page`	query	integer	No
`pageSize`	query	integer	No
`sortBy`	query	string	No
`sortDir`	query	string	No
`startDate`	query	string (date)	No
`endDate`	query	string (date)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/vendors" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Create vendor

/api/v1/vendors

Scope: Scalar360.vendors.CREATE

Body field	Type	Required	Notes
`name`	string	Yes	required, not blank, max length 200
`contactPerson`	string		max length 150
`email`	string		valid email
`phone`	string
`address`	string
`city`	string		max length 100
`state`	string		max length 100
`pin`	string		max length 10
`gstin`	string		max length 15
`pan`	string		max length 10
`paymentTerms`	string		max length 100
`creditDays`	integer
`notes`	string

Example request

curl -X POST "https://api.scalar360.com/api/v1/vendors" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'

GET

Get vendor

/api/v1/vendors/{id}

Scope: Scalar360.vendors.READ

Parameter	In	Type	Required
`id`	path	string (uuid)	Yes

Example request

curl -X GET "https://api.scalar360.com/api/v1/vendors/{id}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

PUT

Update vendor

/api/v1/vendors/{id}

Scope: Scalar360.vendors.UPDATE

Parameter	In	Type	Required
`id`	path	string (uuid)	Yes

Body field	Type	Required	Notes
`name`	string	Yes	required, not blank, max length 200
`contactPerson`	string		max length 150
`email`	string		valid email
`phone`	string
`address`	string
`city`	string		max length 100
`state`	string		max length 100
`pin`	string		max length 10
`gstin`	string		max length 15
`pan`	string		max length 10
`paymentTerms`	string		max length 100
`creditDays`	integer
`notes`	string

Example request

curl -X PUT "https://api.scalar360.com/api/v1/vendors/{id}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","contactPerson":"string","email":"string","phone":"string","address":"string","city":"string"}'

DELETE

Delete vendor

/api/v1/vendors/{id}

Scope: Scalar360.vendors.DELETE

Parameter	In	Type	Required
`id`	path	string (uuid)	Yes

Example request

curl -X DELETE "https://api.scalar360.com/api/v1/vendors/{id}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

PATCH

Activate vendor

/api/v1/vendors/{id}/activate

Scope: Scalar360.vendors.UPDATE

Parameter	In	Type	Required
`id`	path	string (uuid)	Yes

Example request

curl -X PATCH "https://api.scalar360.com/api/v1/vendors/{id}/activate" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

PATCH

Block vendor

/api/v1/vendors/{id}/block

Scope: Scalar360.vendors.UPDATE

Parameter	In	Type	Required
`id`	path	string (uuid)	Yes

Example request

curl -X PATCH "https://api.scalar360.com/api/v1/vendors/{id}/block" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"