GET v1/BranchTransfers/{id}

Get a Branch Transfer

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

BranchTransfer

Name	Description	Type	Additional 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	date	None.
ReceivedDate	Received Date	date	None.
Stage	Stage	string	None.
CustomFields	Custom Fields	Dictionary of string [key] and Object [value]	None.
LineItems		Collection of BranchTransferItem	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "createdDate": "2025-01-16T21:14:02.3715753+13:00",
  "modifiedDate": "2025-01-16T21:14:02.3715753+13: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": "2025-01-16T21:14:02.3715753+13:00",
  "dispatchedDate": "2025-01-16T21:14:02.3715753+13:00",
  "receivedDate": "2025-01-16T21:14:02.3715753+13:00",
  "stage": "sample string 15",
  "customFields": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "lineItems": [
    {
      "createdDate": "2025-01-16T21:14:02.3715753+13: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": 1.0,
      "id": 1,
      "qtyTransferred": 1,
      "unitCost": 2.0,
      "sizes": [
        {
          "name": "sample string 1",
          "code": "sample string 2",
          "barcode": "sample string 3",
          "qty": 4.0
        },
        {
          "name": "sample string 1",
          "code": "sample string 2",
          "barcode": "sample string 3",
          "qty": 4.0
        }
      ]
    },
    {
      "createdDate": "2025-01-16T21:14:02.3715753+13: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": 1.0,
      "id": 1,
      "qtyTransferred": 1,
      "unitCost": 2.0,
      "sizes": [
        {
          "name": "sample string 1",
          "code": "sample string 2",
          "barcode": "sample string 3",
          "qty": 4.0
        },
        {
          "name": "sample string 1",
          "code": "sample string 2",
          "barcode": "sample string 3",
          "qty": 4.0
        }
      ]
    }
  ]
}