Skip to content
API reference
/
/
Get items

Overview

The AutoLeap API uses the REST standard, which means you interact with it by making requests over HTTP.

A request usually includes:

  • An HTTP method (like GET or POST)
  • A path (the address of the resource)
  • Optional headers and parameters (in the path, query string, or request body)

When you send a request, the API responds with:

  • A status code (to indicate success or failure)
  • Response headers
  • Sometimes a response body with useful data

The API reference describes the method, path, and parameters for each endpoint, and includes sample requests and responses you can use as a guide.

Languages
Servers
Production
https://partnerapi.myautoleap.com/v2/

Authentication

Authenticate with the AutoLeap Partner API to obtain access tokens.
All other endpoints require a valid access token.

Operations

Profile

Retrieve partner profile details, including the companies and accounts you are authorized to access.

Operations

Customers

Retrieve and manage customer records for a given company.
Useful for syncing customer information across systems.

Operations

Vehicles

Retrieve and manage vehicles associated with customers.
Supports bulk creation and individual vehicle lookups.

Operations

Items

Access and manage items (parts, tires, labor, etc.) available within a company.
Includes bulk creation and detailed item retrieval.

Operations

Get items

Request

Security
BearerAuth
Query
companyIdstring
typestring

Search by item type. Accepts "part", "tire", "labor", "fee" and "discount"

itemNumberstring

Search by Part Number. Applicable to Parts and Tires only

updatedDateStartstring(date-time)
updatedDateEndstring(date-time)
sizeinteger
Default 100
pageinteger
Default 1
curl -i -X GET \
  'https://partnerapi.myautoleap.com/v2/items?companyId=string&type=string&itemNumber=string&updatedDateStart=2019-08-24T14%3A15%3A22Z&updatedDateEnd=2019-08-24T14%3A15%3A22Z&size=100&page=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Items list

Bodyapplication/json
contentArray of objects(Item)
pageableobject(Pageable)
totalPagesinteger
totalCountinteger
lastboolean
sizeinteger
numberinteger
firstboolean
sortobject(Sort)
numberOfElementsinteger
emptyboolean
Response
application/json
{
  "content": [
    { … },
    { … }
  ],
  "pageable": {
    "sort": { … },
    "offset": 0,
    "pageSize": 100,
    "pageNumber": 1,
    "paged": true,
    "unpaged": false
  },
  "totalPages": 1,
  "totalCount": 2,
  "last": true,
  "size": 100,
  "number": 1,
  "first": true,
  "sort": {
    "unsorted": true,
    "sorted": false,
    "empty": false
  },
  "numberOfElements": 2,
  "empty": false
}

Archive items (bulk) — set status to Inactive

Request

Security
BearerAuth
Bodyapplication/json
companyIdstring
itemsArray of objects
curl -i -X PATCH \
  https://partnerapi.myautoleap.com/v2/items \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "companyId": "string",
    "items": [
      {
        "itemId": "string"
      }
    ]
  }'

Responses

Archive result

Bodyapplication/json
successboolean
Example: true
messagestring
Example: "Request completed successfully"
dataobject
Example: {}
Response
application/json
{
  "success": true,
  "message": "Request completed successfully",
  "data": {}
}

Get item by id

Request

Security
BearerAuth
Path
itemIdstringrequired
curl -i -X GET \
  'https://partnerapi.myautoleap.com/v2/items/{itemId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Item detail

Bodyapplication/json
itemIdstring
companyIdstringrequired
itemTypestringrequired
Enum"part""labor""tire""fee""discount"
itemNamestringrequired
itemNameFRstring or null
itemNumberstringrequired
categorystring or null
subCategorystring or null
subSubCategorystring or null
descriptionstring or null
descriptionFRstring or null
displayQuantityOnROboolean
displayDescriptionOnROboolean
statusstringrequired
Enum"Active""Inactive"
taxablebooleanrequired
commissionableboolean
internalNotesstring or null
salesCodeNamestring or null
salesCodestring or null
detailsPartDetails (object) or TireDetails (object) or LaborDetails (object) or DiscountDetails (object) or FeeDetails (object)

Structure depends on itemType:

  • part → PartDetails
  • tire → TireDetails
  • labor → LaborDetails
  • discount → DiscountDetails
  • fee → FeeDetails
One of:

Structure depends on itemType:

  • part → PartDetails
  • tire → TireDetails
  • labor → LaborDetails
  • discount → DiscountDetails
  • fee → FeeDetails
Response
application/json
{
  "itemId": "string",
  "companyId": "string",
  "itemType": "part",
  "itemName": "string",
  "itemNameFR": "string",
  "itemNumber": "string",
  "category": "string",
  "subCategory": "string",
  "subSubCategory": "string",
  "description": "string",
  "descriptionFR": "string",
  "displayQuantityOnRO": true,
  "displayDescriptionOnRO": true,
  "status": "Active",
  "taxable": true,
  "commissionable": true,
  "internalNotes": "string",
  "salesCodeName": "string",
  "salesCode": "string",
  "details": {
    "defaultQuantity": 0,
    "costPerUnit": 0.1,
    "hasCore": true,
    "coreCost": 0.1,
    "totalCost": 0.1,
    "pricePerUnit": 0.1,
    "pricingMatrix": "string",
    "totalPrice": 0.1,
    "isStockItem": true,
    "supplier": "string",
    "brand": "string",
    "productLine": "string",
    "warrantyEligible": true,
    "warrantyName": "string",
    "associatedFeesName": [ … ]
  }
}

Inventory Levels

View and update inventory levels for items across one or more locations.

Operations

Item Pricing

Retrieve and update pricing information for items.
Useful for keeping partner systems in sync with AutoLeap’s catalog pricing.

Operations

Appointments

Create and retrieve customer appointment requests across locations.
Enables seamless scheduling and booking integrations.

Operations

Repair Orders

Retrieve detailed information about repair orders (ROs).
Supports fetching all orders or a specific order by RO number.

Operations

Payments

Access payment details linked to repair orders.
Useful for reconciling transactions and financial reporting.

Operations

Technician Timesheets

Retrieve detailed timesheet logs for technicians within a company and an optional location, filtered by a date range.

Operations