POST /rest/v1.0/vendors
Create a new Vendor associated with a specified Company.
Country and State codes
The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification.
See Working with Country Codes for additional information.
Servers
- https://api.procore.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Procore-Company-Id |
Integer | Yes |
Unique company identifier associated with the Procore User Account. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
run_configurable_validations |
Boolean | No |
If true, validations are run for the corresponding Configurable Field Set. Default value: false |
view |
String | No |
Specifies which view of the resource to return (which attributes should be present in the response). The default view is extended. Possible values:
|
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
vendor |
Object | Yes | |
vendor.mobile_phone |
String | No |
Mobile phone |
vendor.union_member |
Boolean | No |
Union member status |
vendor.origin_data |
String | No |
Origin Data |
vendor.city |
String | No |
City |
vendor.origin_code |
String | No |
Origin Code |
vendor.bidding |
Object | No |
Bidding statuses |
vendor.bidding.minority_business_enterprise |
Boolean | No |
Default value: false |
vendor.bidding.african_american_business |
Boolean | No |
Default value: false |
vendor.bidding.sdvo_business |
Boolean | No |
Default value: false |
vendor.bidding.hispanic_business |
Boolean | No |
Default value: false |
vendor.bidding.disadvantaged_business |
Boolean | No |
Default value: false |
vendor.bidding.womens_business |
Boolean | No |
Default value: false |
vendor.bidding.historically_underutilized_business |
Boolean | No |
Default value: false |
vendor.bidding.small_business |
Boolean | No |
Default value: false |
vendor.bidding.native_american_business |
Boolean | No |
Default value: false |
vendor.bidding.affirmative_action |
Boolean | No |
Default value: false |
vendor.bidding.certified_business_enterprise |
Boolean | No |
Default value: false |
vendor.bidding.asian_american_business |
Boolean | No |
Default value: false |
vendor.bidding.eight_a_business |
Boolean | No |
Default value: false |
vendor.authorized_bidder |
Boolean | No |
Authorized bidder status |
vendor.license_number |
String | No |
License number |
vendor.standard_cost_code_ids[] |
Array | No | |
vendor.zip |
String | No |
Zip code |
vendor.origin_id |
String | No |
Origin ID |
vendor.bidding_distribution_ids[] |
Array | No | |
vendor.business_phone |
String | No |
Business phone |
vendor.labor_union |
String | No |
Labor union |
vendor.vendor_group_id |
Integer | No |
Vendor Group ID |
vendor.parent_id |
Integer | No |
Parent Vendor ID. Cannot be the same as ID. Only two levels of hierarchy are supported (parent/child). |
vendor.email_address |
String | No |
Email address |
vendor.abbreviated_name |
String | No |
Abbreviated name |
vendor.non_union_prevailing_wage |
Boolean | No |
Non union prevailing wage status |
vendor.fax_number |
String | No |
Fax number |
vendor.is_active |
Boolean | No |
Active status |
vendor.prequalified |
Boolean | No |
Prequalified status Default value: false |
vendor.website |
String | No |
Website url |
vendor.primary_contact_id |
Integer | No |
Primary Contact ID |
vendor.country_code |
String | No |
Country code (ISO-3166 Alpha-2 format) |
vendor.trade_name |
String | No |
Vendor's Trade Name, also known as Doing Business As (DBA). |
vendor.name |
String | Yes |
Name |
vendor.notes |
String | No |
Notes (notes/keywords/tags) |
vendor.state_code |
String | No |
State code (ISO-3166 Alpha-2 format) |
vendor.trade_ids[] |
Array | No | |
vendor.address |
String | No |
Address |
company_id |
Integer | Yes |
Company ID |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.