GET v1/Branches/{id}
Get a Branch.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
BranchName | Description | Type | Additional information |
---|---|---|---|
BranchType |
Branch Type |
string |
Max length: 250 |
StockControlOptions |
Stock control options. |
string |
None. |
TaxStatus |
Tax Status |
string |
None. |
AccountNumber |
string |
None. |
|
BranchLocations |
Branch Locations. |
Collection of BranchLocation |
None. |
Id |
The unique Cin7 Id. |
integer |
None. |
CreatedDate |
Created Date |
date |
None. |
ModifiedDate |
Modified Date |
date |
None. |
IsActive |
Is Active |
boolean |
None. |
Company |
Company |
string |
Max length: 250 |
FirstName |
First Name |
string |
Max length: 250 |
LastName |
Last Name |
string |
Max length: 250 |
JobTitle |
Job Title |
string |
Max length: 250 |
A unique email address |
string |
None. |
|
Website |
Website |
string |
Max length: 50 |
Phone |
Phone |
string |
Max length: 50 |
Fax |
Fax |
string |
Max length: 50 |
Mobile |
Mobile |
string |
Max length: 50 |
Address1 |
Address 1 |
string |
Max length: 50 |
Address2 |
Address 2 |
string |
Max length: 50 |
City |
City |
string |
Max length: 50 |
State |
State |
string |
Max length: 50 |
PostCode |
Post Code |
string |
Max length: 50 |
Country |
Country |
string |
Max length: 50 |
PostalAddress1 |
Billing/Postal Address 1 |
string |
Max length: 50 |
PostalAddress2 |
Billing/Postal Address 2 |
string |
Max length: 50 |
PostalCity |
Billing/Postal City |
string |
Max length: 50 |
PostalPostCode |
Billing/Postal Post Code |
string |
Max length: 50 |
PostalState |
Billing/Postal State |
string |
Max length: 50 |
PostalCountry |
Billing/Postal Country |
string |
Max length: 50 |
Notes |
Notes |
string |
Max length: 250 |
IntegrationRef |
Integration reference. |
string |
None. |
CustomFields |
Custom fields. |
Dictionary of string [key] and Object [value] |
None. |
SecondaryContacts |
Secondary Contacts |
Collection of SubContact |
None. |
Response Formats
application/json, text/json
{ "id": 1, "createdDate": "2024-11-16T13:41:56.1638179Z", "modifiedDate": "2024-11-16T13:41:56.1638179Z", "isActive": true, "company": "Branch 1", "firstName": "J", "lastName": "D", "jobTitle": "Manager", "email": "j@acmecorpation.com", "website": "www.acmecorpation.com", "phone": "(000) 123-4567", "fax": "(000) 123-4567", "mobile": "(000) 123-4567", "address1": "1600 Amphitheatre Pkwy", "address2": null, "city": "Mountain View", "state": "CA", "postCode": "94043", "country": "USA", "postalAddress1": "Postal Address Line 1", "postalAddress2": "Postal Address Line 2", "postalCity": "Postal City", "postalPostCode": "Postal Code", "postalState": "State", "postalCountry": "Country", "notes": "Sample client contact.", "integrationRef": "MY-INTEGRATION-REF", "customFields": null, "secondaryContacts": [ { "id": 1, "company": null, "firstName": "Bob", "lastName": "Joans", "jobTitle": "Freelance Consultant", "email": "bob@acmecorpation.com", "mobile": null, "phone": null } ], "branchType": null, "stockControlOptions": null, "taxStatus": null, "accountNumber": null, "branchLocations": [ { "zone": "Location 1", "bins": [ "Bin1", "Bin2" ] }, { "zone": "Location 2", "bins": [ "Bin1", "Bin2", "Bin3" ] } ] }