Sign in

v1

latestOpenAPI 3.0.02026-07-14242833.3 KB
BranchController

Get a specific branch given its unique Object ID (OID)

get/v2/customer/{shortName}/branch/branches/{branchID}

Path parameters

shortNamestring required

The unique client short-name

branchIDstring required

The unique ID of the Branch

Response

OK

Address1string

Branch address line 1.

Address2string

Branch address line 2.

Address3string

Branch address line 3.

Address4string

Branch address line 4.

CompanyNamestring

The relevant company name, if not the one specified on the branch then the one on company.

Countystring

County

EMailAddressstring

Branch email address.

ETagstring

A unique identifier defining the object and change revision.

FaxPhonestring

Branch fax phone number.

LandPhonestring

Branch land phone number.

Namestring

The branch name.

OIDstring

The unique Object ID (OID).

Postcodestring

Branch address postcode.

WebAddressstring

Branch web address.