NEW API Management Portal

October 25,2021

Karmak has a new and improved APIM Portal with easier to use authentication and real time documentation to reduce errors.

All new APIs will be published within APIM.

If you are new to Unity and Karmak APIs, please head to portal.karmak.io to learn more.

The Part Search Helper APIs provide information and details to successfully submit a parts order

NOTE: Requires Fusion version 3.60.10



Available Payment Methods


Provides a list of available payment methods to submit with a Parts Sales Order.

1 submitted field: “customerID”

Fields

Field Name Size Description
ID   ID Associated with the Payment Method
Method 30 Payment Method must match a payment method setup on the business system.
Description   Description assoicated with the Payment Method stored within Fusion

REQUEST POST URL

.../unityapi/AvailablePaymentMethods

Sample Request

{
	"customerID": "8827892",
	"locationID": "1"
}

 

Sample Response

[
	{
		"ID": "01",
		"Method": "Credit Card",
		"Description": "Business Credit CARD"
	},
	{
		"ID": "02",
		"Method": "Credit Card",
		"Description": "Personal Credit card - VISA"
	},
	{
		"ID": "03",
		"Method": "Credit Card",
		"Description": "Personal Credit card - MC"
	},
	{
		"ID": "04",
		"Method": "Store Credit"
		"Description": ""
	},
	{
		"ID": "05",
		"Method": "CASH"
		"Description": "Cash On Devlivery"
	},
]

  ————————-

Pickup / Delivery Methods


Provides a list of available valid pick up and delivery methods by Branch location to submit with a Parts Sales Order.

POST endpoint to look up and return a list of the delivery methods for parts by branchID

Field Field Type Description
ID String This is the Branch ID that will be looked up

REQUEST POST URL

.../unityapi/PickupDelivery

Sample Request

{
	"branchID": "1234"
}

 

Sample Response

[
	{
		"criteria": {
			"branchID": "1234"
		},
	"deliveryMethods": [
		{
			"deliveryMethod": "PickUp"
		},
		{
			"deliveryMethod": "Delivery to Shop"
		},
		{
			"deliveryMethod": "Pick Up main Branch"
		},
		{
			"deliveryMethod": "Delivery to Remote"
		},
	]

	}
]

Department Lookup


This is the GET Endpoint to look up and return a list of the Department IDs by Branch(Location) ID.

Field Field Type Description
BranchID Integer The id of the location you’d like to find departments for.

REQUEST POST URL

.../unityapi/Departments?BranchID=x

RESPONSE

{
    "Departments": [
        {
            "Name": "Admin",
            "Type": "Accounting",
            "ID": 0
        },
        {
            "Name": "Body Shop",
            "Type": "Service",
            "ID": 0
        },
        {
            "Name": "Bus",
            "Type": "Sales",
            "ID": 0
        },
        {
            "Name": "Equipment",
            "Type": "Parts",
            "ID": 0
        },
    ],
    "Messages": [
        "Success!"
    ]
}

Available Miscellaneous Charge Type


This allows a consumer to look up the Available Misc Charge Types for the customer to ensure parts orders are submitted correctly.

1 submitted field: “customerID”

Fields

Field Name Size Description
ID   ID Associated with the Charge Type
ChargeType string Charge Type name : This is submitted with the Parts Order being created
Description string Description of the Charge Type

Sample Request

{
     "customerID": "8827892"
}

Sample Response

[
  {
    "ID": "01",
    "Status": "EHC",
    "Description": "EHC",
  },
  {
    "ID": "03",
    "Status": "CORE"
    "Description": "CORE part Charge",
  },
]

Available Parts Sales Order Status

This allows a consumer to look up the Available Parts Sales Order Status for the customer to ensure parts order are submitted correctly.

1 submitted field: “customerID”

REQUEST POST URL

.../AvailablePaymentMethods

Fields

Field Name Size Description
ID   ID Associated with the Order Status
Status string: 30 Order Status Description / name : This is submitted with the Parts Order being created

Sample Request

{
     "customerID": "8827892"
}

Sample Response

[
  {
    "ID": "01",
    "Status": "Voided",
  },
  {
    "ID": "02",
    "Status": "Sold"
  },
  {
    "ID": "03",
    "Status": "UNavailable"
  },
]