AutoPower API Documentation

AutoPower API Documentation

API Access Requirements

To enable access to our API, the following steps must be completed:
  1. Submit Static IP Address: Provide the static IP address of the server that will be initiating API requests. This is required for security and whitelisting purposes.
  2. Port Assignment: Once the IP address is received and verified, a dedicated port number will be assigned to your server for API communication.
  3. API Key: You will also be given an API Key.
Note: Ensure the submitted IP is publicly routable and consistently used for all requests. Changes to the IP will require reauthorization.

API Calls


DESCRIPTION
CALL:
Info
Replace 5013 with the port number designated to you.
PARAMETERS:
WEBSVC.IM.PART.SEARCH(IN.CRITERIA, IN.SHOW.ZERO.QOH.TF, IN.SHOW.ZERO.WEIGHT.TF, IN.MAX.WEIGHT, IN.CUST.ID)
IN.CRITERIA (STRING): Term used to define search criteria.
IN.SHOW.ZERO.QOH.TF (BOOLEAN): Show parts even if you don't have them in stock.
IN.SHOW.ZERO.WEIGHT.TF (BOOLEAN): Show parts even if weight data is 0 or null.
IN.MAX.WEIGHT (INTEGER): Excludes parts greater than or equal to this amount (Pounds).
IN.CUST.ID (STRING): Enter the Customer ID if available; otherwise, use "RETAIL" as the default.
RETURN SUCCESS:
{
   "success":"true",
   "parts":[
      {
         "id":"ACE08-00688",
         "vendor":"ACE",
         "partnumber":"08-00688",
         "description":"UNDER HOOD LIGHT BAR",
         "minimumquantity":"",
         "uom":"EA",
         "quantityavailable":"0",
         "weight":"12.3",
         "partprice":"$50.00",
         "coreprice":"$10.00",
         "interchange":"ACE08-00699"
      }
   ]
}
RETURN FAIL:
{
   "success":false,
   "error":{
      "code":"102",
      "message":"SEARCH CRITERIA IS EMPTY!"
   }
}

KEYWORD
DESCRIPTION
EXPLANATION:
success 
Indicates whether the call was successful.

id
Unique identifier for the part, composed of the vendor and part number.

vendor
The supplier or manufacturer of the part.

partnumber
The specific number assigned to identify the part.

description
A brief summary of the part's features or purpose.

minimumquantity
The minimum number of units that must be ordered.

uom
Unit of Measure. The unit in which the part is sold (e.g., Each, Box).

quantityavailable
The current number of units in stock.

weight
This is how much the product weighs in pounds.

partprice
The price of the part, excluding any core charge.

coreprice
The additional cost for the part’s core, if applicable.

 interchange
 A replacement component that can be used in place of an original part.
Notes
Multiple parts are separated by ;

Customer Listing


DESCRIPTION
CALL:
Info
Replace 5013 with the port number designated to you.
PARAMETERS:
WEBSVC.KEYWORD(KEY)
KEY (STRING): CUSTOMER LISTING: For customer listing the keyword should be CUST-MAST 
RETURN SUCCESS:
{
   "success":"true",
   "customer":[
      {
          id":"2626",
         "status":"Active",
         "name":"COAL PRODUCTS, INC.",
         "address":"P.O. BOX 100 RT. 120",
         "address2":"",
         "city":"ALISTERVILLE",
         "state":"PA",
         "zip":"17049",
         "phone":"717-123-4567",
         "fax":"717-321-9877", 
         "email":"fake.email@gmail.com",
         "shiptoid":"2626",
         "shiptoname":"COAL PRODUCTS, INC.",
         "shiptoaddress":"1234 KING DR.",
         "shiptoaddress2":"SUITE 200",
         "shiptocity":"ALISTERVILLE",
         "shiptostate":"PA",
         "shiptozip":"17049",
         "shiptophone":"717-123-4567",
         "shiptofax":"717-111-4222",
         "shiptoemail":"tracking.info@gmail.com",
         "billtoid":"2626",
         "billtoname":"COAL PRODUCTS, INC.",
         "billtoaddress":"P.O. BOX 100 RT. 1",
         "billtoaddress2":"",
         "billtocity":"ALISTERVILLE",
         "billtostate":"PA",
         "billtozip":"17049",
         "billtophone":"717-123-4567",
         "billtofax":"717-122-3222",
         "billtoemail":"invoices@gmail.com",
         "taxexempt":"Yes",
         "creditlimit":"$500.00",
         "arbalance":"$0.00",
         "credithold":"No"
      }
   ]
}
RETURN FAIL:
{
   "success":false,
   "error":{
      "code":"101",
      "message":"CUST-MAST IS MISSING!"
   }
}

KEYWORD
DESCRIPTION
EXPLANATION:
success 
Indicates whether the call was successful.

id
Unique identifier for customer.

status
This field returns the customer's current status (Active or Inactive).

name
The name of the customer.
This is the account’s default mailing address for advertisements, coupons, and other promotional materials.

address
Address Line 1.

address2
Address Line 2.

city
The name of the city.

state
The name of the state.

zipThe zip code.

phoneThe phone number to reach customer.

 fax The fax line for the customer.

 email
 The email address for the customer
This address is identified as the official shipping destination for all orders.

 shiptoid
B2B: The ID of the account items should be shipped to. 
NOTE: This is the ID you will use when looking up previous orders.

 shiptoname


 shiptoaddress


 shiptoaddress2


 shiptocity


 shiptostate


 shiptozip


 shiptophone


 shiptofax


 shiptoemail

This is the billing address where invoices should be sent.

 billtoid
B2B: The ID of the account the items should be billed to.

 billtoname


 billtoaddress


 billtoaddress2


 billtocity


 billtostate


 billtozip


 billtophone


 billtofax


 billtoemail


 taxexemptSpecifies if the customer is exempt from sales tax.

 creditlimitThe credit limit represents the maximum outstanding balance a customer is allowed before additional purchases or services are restricted.

 arbalance
The AR balance is the total amount a customer currently owes.

 credithold
 B2B: Customers with a credit hold status may not submit or process parts orders.

Get Invoice History


DESCRIPTION
CALL:
Info
Replace 5013 with the port number designated to you.
PARAMETERS:
WEBSVC.GET.INVOICE.HISTORY(IN.CUST.ID)
IN.CUST.ID (STRING): Enter the Customer ID if available; otherwise, use "RETAIL" as the default.
RETURN SUCCESS:
{
   "success":"true",
   "invoices":[
      {
         "id":"320714",
         "invoicenum":"W1*366260",
         "invdate":"08/23/18",
         "invoiceamount":"$-180.00",
         "terms":"A",
         "tracking":"ADSLKFJALSKDFJ"
      }    
   ]
}
RETURN FAIL:
{
   "success":false,
   "error":{
      "code":"101",
      "message":"CUSTOMER ID IS MISSING"
   }
}

KEYWORD
DESCRIPTION
EXPLANATION:
success 
Indicates whether the call was successful.

id
Unique identifier for the invoice.

invoicenum
The number you will need to retrieve an invoice.

invdate
The date of invoice.

invoiceamount
The invoice amount.

terms
What terms were applied to the customer on the invoice.

 tracking Tracking # for order.

Get Invoice


DESCRIPTION
CALL:
Info
Replace 5013 with the port number designated to you.
PARAMETERS:
WEBSVC.GET.INVOICE(IN.INVOICE.NUM)
IN.INVOICE.NUM (STRING): Invoice number retrieved from GET.INVOICE.HISTORY
RETURN SUCCESS:
{
   "success":"true",
   "file":[
      {
         "url":"http://weburl.pdf"
      }    
   ]
}
RETURN FAIL:
{
   "success":false,
   "error":{
      "code":"101",
      "message":"CANT FIND INVOICE."
   }
}

KEYWORD
DESCRIPTION
EXPLANATION:
success 
Indicates whether the call was successful.

id
Unique identifier for the invoice.

invoicenum
The number you will need to retrieve an invoice.

invdate
The date of invoice.

invoiceamount
The invoice amount.

terms
What terms were applied to the customer on the invoice.

Place Order


DESCRIPTION
CALL:
Info
Replace 5013 with the port number designated to you.
PARAMETERS:
WEBSVC.IM.ORDER(IN.JSON.DATA)
IN.JSON.DATA (JSON): 
{
   "ACCOUNT":"RETAIL",
   "WAREHOUSE":"1",
   "DELIVERY_METHOD":"UPS GROUND",
   "SHIPTO_CUSTOMER":"RAY MILTON",
   "SHIPTO_ADDRESS1":"4333 PRINCE ALBERT DRIVE",
   "SHIPTO_CITY":"Orlando",
   "SHIPTO_STATE":"FL",
   "SHIPTO_ZIP":"32825",
   "LINECODE1":"AIM",
   "PARTNO1":"55034",
   "PARTQTY1":"1",
   "LINECODE2":"DEX",
   "PARTNO2":"017-186-25",
   "PARTQTY2":"2",
   "LINECODE3":"BTC",
   "PARTNO3":"CLR17185196",
   "PARTQTY3":"1"
}
RETURN SUCCESS:
{
   "success":"true",
   "order":[
      {
         "state":"Ordered",
         "branch":"W1",
         "orderno":"124124",
         "orderdate":"02/26/2024"
      }    
   ]
}
RETURN FAIL:
{
   "success":false,
   "error":{
      "code":"102",
      "message":"Account: 12345 is Over Credit Limit."
   }
}

KEYWORD
DESCRIPTION
EXPLANATION:
success 
Indicates whether the call was successful.

state
Status of order.

branch
Warehouse order is shipping from.

orderno
The order number.

orderdate
The date of order.

terms
What terms were applied to the customer on the invoice.

Error Codes

Error Code: 101

MESSAGE: 
Critical file is missing on the server.
SOLUTION: 
Contact AutoPower and inform them of the error number and message.

Error Code: 102

MESSAGE: Input parameter is missing or incorrect.
SOLUTION: Make sure you validate user input.

Error Code: 103

MESSAGE: Unable to connect to server.
SOLUTION: AutoPower will need to resolve why it can't connect to the database.

Error Code: 104

MESSAGE: 
Not an authorized API call.
SOLUTION: Check the spelling of your API call.

Error Code: 401

MESSAGE: Missing API Key.
SOLUTION: Make sure the API key is included in the header of every request.

Error Code: 402

MESSAGE: Incorrect API Key.
SOLUTION: Confirm with AutoPower you are utilizing the correct key.