The Branches API allows users to Get and Update Branch records in Fusion

Overview

The Branches API in Karmak Unity will allow 3rd Parties to Get and Update information about Branches setup in the Fusion Business System.

GET

https://api.karmak.io/api/unity/{version}/unityapi/Branch/{branchcode}

PUT

https://api.karmak.io/api/unity/{version}/unityapi/Branch/Update

Specifications

GET

  • The Branch Code must be passed in as part of the URL to get information about a specific Branch.
  • The GET returns the same information that can be included in the PUT Request.

PUT

  • The PUT method will be used to update Branch Records in Fusion.
  • Only one Branch record will be allowed in a single request call.
  • Only fields that are expected to be updated should be passed in outside of the required fields.
  • In order to update an existing Branch record the user will be required to send in the Branch Identity section of the request to find an existing Branch. If an existing Branch is not found no update will be performed.
  • A response will be provided with a message section that will outline a success or any issues that prevented the Branch from being updated.
  • The Fusion Username used in the Unity API call will be used as the Last Update User of the Branch created.
  • The Date and Time the Unity API call was made will be used as the Last Update of the Branch created.

Request Fields

Field Field Type Required Length PUT Business Rules and Defaults  
Branch Identity Node     This section will be required when updating a Branch as it will be used to look up the existing Banch in Fusion.  
BranchCode string Yes 10 This is the Branch that is being looked up to perform an update to.  
           
Main Body Node        
Name string   100 This is the Name of the Branch that the looked up value will be updated to.  
NumericValue integer   2 This is the Numeric Value of the Branch that the looked up value will be updated to.  
Division string   10 This is the Division of the Branch that the looked up value will be updated to.  
CustomerBaseBranch string   10 This is the Customer Base Branch of the Branch that the looked up value will be updated to.  
OfficePhone string   30 This is the Office Phone of the Branch that the looked up value will be updated to.  
ShopPhone string   30 This is the Shop Phone of the Branch that the looked up value will be updated to.  
PartsPhone string   30 This is the Parts Phone of the Branch that the looked up value will be updated to.  
Fax string   30 This is the Fax of the Branch that the looked up value will be updated to.  
Email Email   100 This is the Email Address of the Branch that the looked up value will be updated to. This must be a valid Email Address  
WebAddress string   100 This is the Web Address of the Branch that the looked up value will be updated to.  
BillToAddress1 string   100 This is the Bill To Address 1 of the Branch that the looked up value will be updated to.  
BillToAddress2 string   100 This is the Bill To Address 2 of the Branch that the looked up value will be updated to.  
BillToCity string   100 This is the Bill To City of the Branch that the looked up value will be updated to.  
BillToRegion string   6 This is the Bill To Region of the Branch that the looked up value will be updated to. This must match a valid Region setup in Fusion.  
BillToPostalCode string   15 This is the Bill To Postal Code of the Branch that the looked up value will be updated to.  
BillToCounty string   35 This is the Bill To County of the Branch that the looked up value will be updated to.  
BillToCountry string   35 This is the Bill To Country of the Branch that the looked up value will be updated to.  
ShipToAddress1 string   100 This is the Ship To Address 1 of the Branch that the looked up value will be updated to.  
ShipToAddress2 string   100 This is the Ship To Address 2 of the Branch that the looked up value will be updated to.  
ShipToCity string   100 This is the Ship To City of the Branch that the looked up value will be updated to.  
ShipToRegion string   6 This is the Ship To Region of the Branch that the looked up value will be updated to. This must match a valid Region setup in Fusion.  
ShipToPostalCode string   15 This is the Ship To Postal Code of the Branch that the looked up value will be updated to.  
ShipToCounty string   35 This is the Ship To County of the Branch that the looked up value will be updated to.  
ShipToCountry string   35 This is the Ship To Country of the Branch that the looked up value will be updated to.  
RemitToAddress1 string   100 This is the Remit To Address 1 of the Branch that the looked up value will be updated to.  
RemitToAddress2 string   100 This is the Remit To Address 2 of the Branch that the looked up value will be updated to.  
RemitToCity string   100 This is the Remit To City of the Branch that the looked up value will be updated to.  
RemitToRegion string   6 This is the Remit To Region of the Branch that the looked up value will be updated to. This must match a valid Region setup in Fusion.  
RemitToPostalCode string   15 This is the Remit To Postal Code of the Branch that the looked up value will be updated to.  
RemitToCounty string   35 This is the Remit To County of the Branch that the looked up value will be updated to.  
RemitToCountry string   35 This is the Remit To Country of the Branch that the looked up value will be updated to.  
TimeZone string   5 This is the Time Zode code of the Branch; EST, CST, etc… This must match a valid Time Zone code option in Fusion.  

PUT Request

{
       
       	"Identity":
       	{
       		"BranchCode":"10"
       	
       	},
       	"Name":"Springfield"
  
    }

PUT Response

{
    "Status": "Branch updated.",
    "Message": null
}

GET Request

https://api.karmak.io/api/unity/{version}/unityapi/Branch/Cocoa

GET Response

{
    "Identity": null,
    "BranchCode": "Cocoa",
    "Name": "Cocoa Beach",
    "NumericValue": "23",
    "Division": "Future1",
    "CustomerBaseBranch": "01",
    "OfficePhone": "358-365-5712",
    "ShopPhone": "111-222-4444",
    "PartsPhone": "888-556-1234",
    "Fax": "123-123-1234",
    "Email": "Cocoa@test.com",
    "WebAddress": "www.Cocoa.com",
    "BillToAddress1": "One Cocoa Drive",
    "BillToAddress2": "PO Box 100",
    "BillToCity": "Cocoa Beach",
    "BillToRegion": "FL",
    "BillToPostalCode": "10101",
    "BillToCounty": "Brevard",
    "BillToCountry": "US",
    "ShipToAddress1": "One Cocoa Drive",
    "ShipToAddress2": "PO Box 100",
    "ShipToCity": "Cocoa Beach",
    "ShipToRegion": "FL",
    "ShipToPostalCode": "10101",
    "ShipToCounty": "Brevard",
    "ShipToCountry": "US",
    "RemitToAddress1": "One Cocoa Drive",
    "RemitToAddress2": "PO Box 100",
    "RemitToCity": "Cocoa Beach",
    "RemitToRegion": "FL",
    "RemitToPostalCode": "10101",
    "RemitToCounty": "Brevard",
    "RemitToCountry": "US",
    "TimeZone": "PST"
}