POST v1/Branches

Create a list of Branches.

Request Information

URI Parameters

None.

Body Parameters

Collection of Branch
NameDescriptionTypeAdditional 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

Email

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.

Request Formats

application/json, text/json

Sample:
[
  {
    "id": 5,
    "createdDate": "2021-05-08T03:18:52.8053338+12:00",
    "modifiedDate": "2021-05-08T03:18:52.8053338+12:00",
    "isActive": true,
    "company": "sample string 9",
    "firstName": "sample string 10",
    "lastName": "sample string 11",
    "jobTitle": "sample string 12",
    "email": "sample string 13",
    "website": "sample string 14",
    "phone": "sample string 15",
    "fax": "sample string 16",
    "mobile": "sample string 17",
    "address1": "sample string 18",
    "address2": "sample string 19",
    "city": "sample string 20",
    "state": "sample string 21",
    "postCode": "sample string 22",
    "country": "sample string 23",
    "postalAddress1": "sample string 24",
    "postalAddress2": "sample string 25",
    "postalCity": "sample string 26",
    "postalPostCode": "sample string 27",
    "postalState": "sample string 28",
    "postalCountry": "sample string 29",
    "notes": "sample string 30",
    "integrationRef": "sample string 31",
    "customFields": {
      "sample string 1": {},
      "sample string 3": {}
    },
    "secondaryContacts": [
      {
        "id": 1,
        "company": "sample string 2",
        "firstName": "sample string 3",
        "lastName": "sample string 4",
        "jobTitle": "sample string 5",
        "email": "sample string 6",
        "mobile": "sample string 7",
        "phone": "sample string 8"
      },
      {
        "id": 1,
        "company": "sample string 2",
        "firstName": "sample string 3",
        "lastName": "sample string 4",
        "jobTitle": "sample string 5",
        "email": "sample string 6",
        "mobile": "sample string 7",
        "phone": "sample string 8"
      }
    ],
    "branchType": "sample string 1",
    "stockControlOptions": "sample string 2",
    "taxStatus": "sample string 3",
    "accountNumber": "sample string 4",
    "branchLocations": null
  },
  {
    "id": 5,
    "createdDate": "2021-05-08T03:18:52.8053338+12:00",
    "modifiedDate": "2021-05-08T03:18:52.8053338+12:00",
    "isActive": true,
    "company": "sample string 9",
    "firstName": "sample string 10",
    "lastName": "sample string 11",
    "jobTitle": "sample string 12",
    "email": "sample string 13",
    "website": "sample string 14",
    "phone": "sample string 15",
    "fax": "sample string 16",
    "mobile": "sample string 17",
    "address1": "sample string 18",
    "address2": "sample string 19",
    "city": "sample string 20",
    "state": "sample string 21",
    "postCode": "sample string 22",
    "country": "sample string 23",
    "postalAddress1": "sample string 24",
    "postalAddress2": "sample string 25",
    "postalCity": "sample string 26",
    "postalPostCode": "sample string 27",
    "postalState": "sample string 28",
    "postalCountry": "sample string 29",
    "notes": "sample string 30",
    "integrationRef": "sample string 31",
    "customFields": {
      "sample string 1": {},
      "sample string 3": {}
    },
    "secondaryContacts": [
      {
        "id": 1,
        "company": "sample string 2",
        "firstName": "sample string 3",
        "lastName": "sample string 4",
        "jobTitle": "sample string 5",
        "email": "sample string 6",
        "mobile": "sample string 7",
        "phone": "sample string 8"
      },
      {
        "id": 1,
        "company": "sample string 2",
        "firstName": "sample string 3",
        "lastName": "sample string 4",
        "jobTitle": "sample string 5",
        "email": "sample string 6",
        "mobile": "sample string 7",
        "phone": "sample string 8"
      }
    ],
    "branchType": "sample string 1",
    "stockControlOptions": "sample string 2",
    "taxStatus": "sample string 3",
    "accountNumber": "sample string 4",
    "branchLocations": null
  }
]

Response Information

Resource Description

Collection of BatchResultItem
NameDescriptionTypeAdditional information
Index

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

integer

None.

Success

​True if the record was successfully inserted or updated.

boolean

None.

Id

The record Id.

integer

None.

Code

The record code.

string

None.

Errors

A list of errors if the insert or update fails.

Collection of string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "index": 0,
    "success": true,
    "id": 1,
    "code": "SALE4-28",
    "errors": []
  },
  {
    "index": 1,
    "success": true,
    "id": 2,
    "code": "SALE5-29",
    "errors": []
  }
]