GET v1/BranchTransfers?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Branch Transfers.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
fields

A comma-separated list of field names

string

None.

where

A where clause

string

None.

order

An order by clause

string

None.

page

The page number (default: 1)

integer

Default value is 1

rows

Rows per page (default: 50, maximum: 250)

integer

Default value is 50

Body Parameters

None.

Response Information

Resource Description

Collection of BranchTransfer
NameDescriptionTypeAdditional information
Id

The unique Cin7 Id.

integer

None.

CreatedDate

Order created date

date

None.

ModifiedDate

Order last modified date

date

None.

CreatedBy

The ID for the User who created the Transaction.

integer

None.

ProcessedBy

The ID for the User who processed the Transaction.

integer

None.

ApprovedBy

The ID of the User who approved the Branch Transfer.

integer

None.

IsApproved

Is Approved (default: true)

boolean

None.

Reference

A unique reference.

string

Max length: 20

BranchEmail

Branch email

string

Max length: 250

DeliveryInstructions

Delivery instructions e.g. Leave at the door, ​beware the dog.

string

Max length: 2000

InternalComments

Internal comment

string

None.

ProductTotal

Product Total

decimal number

None.

FirstName

Contact first name

string

Max length: 250

LastName

Contact last name

string

Max length: 250

Company

Contact company

string

Max length: 250

Email

Contact email address, could be different from MemberEmail assigned to the order

string

Max length: 250

Phone

Contact phone

string

Max length: 50

Mobile

Contact mobile

string

Max length: 50

Fax

Contact fax

string

Max length: 50

ProjectName

Project Name

string

None.

TrackingCode

Shipping tracking code

string

Max length: 50

Source

The source of the Transaction.

string

None.

SourceBranchId

Source Branch ID

integer

None.

DestinationBranchId

Destination Branch ID

integer

None.

ApprovalDate

Approval Date

date

None.

DispatchedDate

Dispatched Date; this field is readonly, Branch Transfers must be dispatched and completed in Cin7.

date

None.

ReceivedDate

Received Date; this field is readonly, Branch Transfers must be dispatched and completed in Cin7.

date

None.

LineItems

Collection of BranchTransferItem

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "createdDate": "2021-05-09T10:20:03.0706456+12:00",
    "modifiedDate": "2021-05-09T10:20:03.0706456+12:00",
    "createdBy": 1,
    "processedBy": 1,
    "approvedBy": 1,
    "isApproved": true,
    "reference": "sample string 1",
    "branchEmail": "sample string 2",
    "deliveryInstructions": "sample string 3",
    "internalComments": "sample string 4",
    "productTotal": 1.0,
    "firstName": "sample string 5",
    "lastName": "sample string 6",
    "company": "sample string 7",
    "email": "sample string 8",
    "phone": "sample string 9",
    "mobile": "sample string 10",
    "fax": "sample string 11",
    "projectName": "sample string 12",
    "trackingCode": "sample string 13",
    "source": "sample string 14",
    "sourceBranchId": 1,
    "destinationBranchId": 1,
    "approvalDate": "2021-05-09T10:20:03.0706456+12:00",
    "dispatchedDate": "2021-05-09T10:20:03.0706456+12:00",
    "receivedDate": "2021-05-09T10:20:03.0706456+12:00",
    "lineItems": [
      {
        "createdDate": "2021-05-09T10:20:03.0706456+12:00",
        "transactionId": 5,
        "parentId": 1,
        "productId": 6,
        "productOptionId": 7,
        "integrationRef": "sample string 8",
        "sort": 9,
        "code": "sample string 10",
        "name": "sample string 11",
        "option1": "sample string 12",
        "option2": "sample string 13",
        "option3": "sample string 14",
        "qty": 15.0,
        "id": 1,
        "qtyTransferred": 1,
        "unitCost": 2.0
      },
      {
        "createdDate": "2021-05-09T10:20:03.0706456+12:00",
        "transactionId": 5,
        "parentId": 1,
        "productId": 6,
        "productOptionId": 7,
        "integrationRef": "sample string 8",
        "sort": 9,
        "code": "sample string 10",
        "name": "sample string 11",
        "option1": "sample string 12",
        "option2": "sample string 13",
        "option3": "sample string 14",
        "qty": 15.0,
        "id": 1,
        "qtyTransferred": 1,
        "unitCost": 2.0
      }
    ]
  },
  {
    "id": 1,
    "createdDate": "2021-05-09T10:20:03.0706456+12:00",
    "modifiedDate": "2021-05-09T10:20:03.0706456+12:00",
    "createdBy": 1,
    "processedBy": 1,
    "approvedBy": 1,
    "isApproved": true,
    "reference": "sample string 1",
    "branchEmail": "sample string 2",
    "deliveryInstructions": "sample string 3",
    "internalComments": "sample string 4",
    "productTotal": 1.0,
    "firstName": "sample string 5",
    "lastName": "sample string 6",
    "company": "sample string 7",
    "email": "sample string 8",
    "phone": "sample string 9",
    "mobile": "sample string 10",
    "fax": "sample string 11",
    "projectName": "sample string 12",
    "trackingCode": "sample string 13",
    "source": "sample string 14",
    "sourceBranchId": 1,
    "destinationBranchId": 1,
    "approvalDate": "2021-05-09T10:20:03.0706456+12:00",
    "dispatchedDate": "2021-05-09T10:20:03.0706456+12:00",
    "receivedDate": "2021-05-09T10:20:03.0706456+12:00",
    "lineItems": [
      {
        "createdDate": "2021-05-09T10:20:03.0706456+12:00",
        "transactionId": 5,
        "parentId": 1,
        "productId": 6,
        "productOptionId": 7,
        "integrationRef": "sample string 8",
        "sort": 9,
        "code": "sample string 10",
        "name": "sample string 11",
        "option1": "sample string 12",
        "option2": "sample string 13",
        "option3": "sample string 14",
        "qty": 15.0,
        "id": 1,
        "qtyTransferred": 1,
        "unitCost": 2.0
      },
      {
        "createdDate": "2021-05-09T10:20:03.0706456+12:00",
        "transactionId": 5,
        "parentId": 1,
        "productId": 6,
        "productOptionId": 7,
        "integrationRef": "sample string 8",
        "sort": 9,
        "code": "sample string 10",
        "name": "sample string 11",
        "option1": "sample string 12",
        "option2": "sample string 13",
        "option3": "sample string 14",
        "qty": 15.0,
        "id": 1,
        "qtyTransferred": 1,
        "unitCost": 2.0
      }
    ]
  }
]