BranchTransfers

Update a list of Branch Transfers.

put/api/v1/BranchTransfers

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/BranchTransfers
  • Auth: none declared

Request body

idinteger nullable

The unique Cin7 Id.

createdDatestring date-time nullable

Order created date

modifiedDatestring date-time nullable

Order last modified date

createdByinteger nullable

The ID for the User who created the Transaction.

processedByinteger nullable

The ID for the User who processed the Transaction.

approvedByinteger nullable

The ID of the User who approved the Branch Transfer.

isApprovedboolean nullable

Is Approved (default: true)

referencestring nullable

A unique reference.

branchEmailstring email nullable

Branch email

deliveryInstructionsstring nullable

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

internalCommentsstring nullable

Internal comment

productTotalnumber double nullable

Product Total

firstNamestring nullable

Contact first name

lastNamestring nullable

Contact last name

companystring nullable

Contact company

emailstring email nullable

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

phonestring nullable

Contact phone

mobilestring nullable

Contact mobile

faxstring nullable

Contact fax

projectNamestring nullable

Project Name

trackingCodestring nullable

Shipping tracking code

sourcestring nullable

The source of the Transaction.

sourceBranchIdinteger nullable

Source Branch ID

destinationBranchIdinteger nullable

Destination Branch ID

approvalDatestring date-time nullable

Approval Date

dispatchedDatestring date-time nullable

Dispatched Date

receivedDatestring date-time nullable

Received Date

stagestring nullable

Stage

customFieldsobject nullable

Custom Fields

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.