Summary
The Organizations b2b provides an interface for creating and managing a organizations. Organizations are used for groups and reseller bookings.
Get Organizations
GET /v2/b2b/organization
Get the available organizations
Response:
A list of OrganizationVo
Get Organization
GET /v2/b2b/organization/{id}Gets a single organization by Id
Input
id: the organization id
Response:
An OrganizationVo object if successful
Example Response:
{
"id": 218347,
"name": "Zion Bikes",
"streetAddress1": "123 Blue Lines Way",
"streetAddress2": "",
"city": "Bellingham",
"state": "Washington",
"zipCode": "99383",
"country": "United States",
"createdAt": "2023-03-14T10:59:44-07:00",
"updatedAt": "2024-10-08T11:56:32-07:00",
"phoneNumber": "3335556775",
"companyUrl": "",
"orgSource": "ACME",
"integrationId": "ACS369077784",
"externalId": "0013u00001lhLGfAAM",
"externalImportId": "ACMEACS369077784",
"version": 2,
"externalVersion": 2,
"addressId": 17705346
}Create Organization
POST /v2/b2b/organization
Body:
A CreateOrganizationVo object
Response:
An OrganizationVo object if successful
Update Organization
PUT /v2/b2b/organization
Body:
An OrganizationVo object
Response:
An OrganizationVo object if successful
Objects
Create Organization Object
Field | Description | Required? |
|---|---|---|
| companyName | Name of the organization | yes |
| companyPhone | Phone number for the organization. | yes |
| billingAddress1 | Street address of the organization | yes |
| billingAddress2 | Second line of the street address of the organization | |
| billingCity | City of the organization | yes |
| billingState | State/province of the organization | yes |
| billingZip | Zip/postal code of the organization | yes |
| country | Country of the organization | yes |
| companyUrl | Website url of the organization | |
| contactFirstName | First name of the primary contact at the organization | yes- at least the primary contact is required |
| contactLastName | Last name of the primary contact at the organization | yes- at least the primary contact is required |
| contactEmail | Email address for the primary contact at the organization | yes- at least the primary contact is required |
| contactPhone | Phone number for the primary contact at the organization | yes- at least the primary contact is required |
| account.types | List of account types. |
Example Create Organization JSON
{ "companyName" : "Licks Ice Cream", "companyPhone" : "510.250.9740", "billingAddress1" : "2121 Yum St", "billingAddress2" : "Suite #28", "billingCity" : "Arcata", "billingState" : "CA", "billingZip" : "94301", "country" : "USA", "companyUrl" : "http://www.licks.edu", "contactFirstName" : "Rocky", "contactLastName" : "Road", "contactEmail" : "rocky.road@liks.com", "contactPhone" : "510.250.9740" } |