Vendor

Returns vendors

This call returns a list of vendors.

Securitybearer
Responses
get/api/v1/vendors
Request samples 
Response samples 
application/json
[
  • {
    }
]
Creates a new vendor.  Names and descriptions may be duplicated.
Securitybearer 
Request 
Request Body schema: 
The vendor to be created


name
required
string  non-empty 
The name of the vendor.


 
description
string or null
The description of the vendor.


 
address1
string or null
The street address (e.g., 123 Main St).


 
address2
string or null
The secondary address info (suite, apartment, PO box numbers etc.).


 
city
string or null
The city.


 
state
string or null  <= 2 characters 
The state abbreviation.


 
zip
string or null
The zip code.


 
country
string or null
The country.


 
phoneNumber
string or null
The phone number. Can include numbers, symbols and whitespace.


 
Responses 
post/api/v1/vendors
Request samples 
{
  • "name": "Whole Foods",
  • "description": "Berry Chantilly Cake store",
  • "address1": "456 3rd Ave",
  • "address2": "",
  • "city": "Houston",
  • "state": "TX",
  • "zip": "77063-8767",
  • "country": "USA"
}
Response samples 
application/json
{
  • "id": "10b98b7e-5015-4b7e-a1a6-56166dbcbd37",
  • "name": "HEB",
  • "description": "Texas-based grocery chain",
  • "address1": "123 Main St",
  • "address2": "Suite 120",
  • "city": "Sugar Land",
  • "state": "TX",
  • "zip": "77478-8765",
  • "country": "USA"
}
Returns a list of vendors, respecting the isDeleted and modifiedSince parameters.
Securitybearer 
Request 
query Parameters
isDeleted
boolean
 
modifiedSince
string <date-time> 
 
Responses 
get/api/v2/vendors
Request samples 
Response samples 
application/json
[
  • {
    }
]
Updates a vendor
This call updates an existing vendor by its id.


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The id of the existing vendor


 
Request Body schema: 
The vendor details to be updated


name
required
string  non-empty 
The name of the vendor.


 
description
string or null
The description of the vendor.


 
address1
string or null
The street address (e.g., 123 Main St).


 
address2
string or null
The secondary address info (suite, apartment, PO box numbers etc.).


 
city
string or null
The city.


 
state
string or null  <= 2 characters 
The state abbreviation.


 
zip
string or null
The zip code.


 
country
string or null
The country.


 
phoneNumber
string or null
The phone number. Can include numbers, symbols and whitespace.


 
Responses 
put/api/v1/vendors/{id}
Request samples 
{
  • "name": "Whole Foods",
  • "description": "Berry Chantilly Cake store",
  • "address1": "456 3rd Ave",
  • "address2": "",
  • "city": "Houston",
  • "state": "TX",
  • "zip": "77063-8767",
  • "country": "USA"
}
Response samples 
application/json
{
  • "id": "10b98b7e-5015-4b7e-a1a6-56166dbcbd37",
  • "name": "HEB",
  • "description": "Texas-based grocery chain",
  • "address1": "123 Main St",
  • "address2": "Suite 120",
  • "city": "Sugar Land",
  • "state": "TX",
  • "zip": "77478-8765",
  • "country": "USA"
}
Deletes a vendor by its id.
Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The vendor id


 
Responses 
204
No Content


400
Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


delete/api/v1/vendors/{id}
Request samples