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

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"
}