Branches

Create a list of Branches.

post/api/v1/Branches

Request

  • Base URL: https://api.cin7.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.cin7.com/api/v1/Branches
  • Auth: none declared

Request body

idinteger

The unique Cin7 Id.

createdDatestring date-time

Created Date

modifiedDatestring date-time

Modified Date

isActiveboolean nullable

Is Active. Defaults to true on create; left unchanged on update when omitted.

companystring nullable

Company

firstNamestring nullable

First Name

lastNamestring nullable

Last Name

jobTitlestring nullable

Job Title

emailstring email nullable

A unique email address

websitestring nullable

Website

phonestring nullable

Phone

faxstring nullable

Fax

mobilestring nullable

Mobile

address1string nullable

Address 1

address2string nullable

Address 2

citystring nullable

City

statestring nullable

State

postCodestring nullable

Post Code

countrystring nullable

Country

postalAddress1string nullable

Billing/Postal Address 1

postalAddress2string nullable

Billing/Postal Address 2

postalCitystring nullable

Billing/Postal City

postalPostCodestring nullable

Billing/Postal Post Code

postalStatestring nullable

Billing/Postal State

postalCountrystring nullable

Billing/Postal Country

notesstring nullable

Notes

integrationRefstring nullable

Integration reference.

customFieldsobject nullable

Custom fields.

branchTypestring nullable

Branch Type

stockControlOptionsstring nullable

Stock control options.

taxStatusstring nullable

Tax Status

accountNumberstring nullable

Response

OK

successboolean

​True if the record was successfully inserted or updated.

idinteger nullable

The record Id.

codestring nullable

The record code.

errorsstring[] nullable

A list of errors if the insert or update fails.

indexinteger

​The index at which the record was positioned in an insert or update.

Changes

No recorded changes to this operation across all 1 revision of this API.