Tire Guru
Default module

Inventory

Endpoint:https://api.prod.tireguru.net

Get Bins

GET
https://api.prod.tireguru.net
/api/v1/inventory/bins

Get Bins › query Parameters

  • bin_idinteger
  • filter[search]string

    Matches code or description

  • pageinteger

    Page number to return

  • pageSizeinteger

    Number of items to return in a page. Defaults to 10

  • sortstring

    Sort by column, can be DESC or ASC. For DESC append a - next to the sort column. Available fields: code, description, max_quantity.

  • shop_idstring

    Primary key of the shop. If not provided, all locations within the company will be included.

Get Bins › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Bins › Responses

  • dataobject[] · required
  • linksobject · required
  • metaobject · required

Get Manufacturers

GET
https://api.prod.tireguru.net
/api/v1/inventory/manufacturers

Get Manufacturers › query Parameters

  • manufacturer_idinteger
  • filter[name]string
  • filter[active]boolean

    Defaults to true

  • pageinteger

    Page number to return.

  • pageSizeinteger

    Number of items to return in a page. Defaults to 10

  • sortstring

    Sort by column, can be DESC or ASC. For DESC append a - next to the sort column. Available fields: name

Get Manufacturers › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Manufacturers › Responses

  • dataobject[] · required
  • linksobject · required
  • metaobject · required

Get Groups

GET
https://api.prod.tireguru.net
/api/v1/inventory/manufacturers/{manufacturer_id}/groups

Get Groups › path Parameters

  • manufacturer_idstring · required

Get Groups › query Parameters

  • group_idinteger
  • filter[description]string
  • pageinteger

    Page number to return.

  • pageSizeinteger

    Number of items to return in a page. Defaults to 10.

  • sortstring

    Sort by column, can be DESC or ASC. For DESC append a - next to the sort column. Available fields: description.

Get Groups › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Groups › Responses

  • dataobject[] · required
  • linksobject · required
  • metaobject · required

Get Parts Inventories

GET
https://api.prod.tireguru.net
/api/v1/parts

This endpoint provides a practical set of parameters to tailor your query. You can filter inventory based on part number, part description, part supplier, part price, part cost and part category. The pagination options allow you to manage the number of items returned per page, facilitating smooth navigation through the inventory data.

Get Parts Inventories › query Parameters

  • shop_idstring · required

    Primary key of the shop

  • sortstring · enum

    Sort by column, can be DESC or ASC. For DESC append a - next to the sort column. Eg: -part_number. Sortable field: part.number, part.category and part.size, part.rawsize, part.price, part.cost, part.brand, net_on_hand.

    Sort by column, can be DESC or ASC. For DESC append a - next to the sort column. Eg: -part_number. Sortable field: part_number, category and timestamp.

    Enum values:
    part_number
    size
    description
    brand
    quantity
    price
    Example: null
  • part_idinteger

    Filter by part id.

    Filter by part id.

    Example: null
  • filter[part_number]string

    Filter by part number.

    Filter by part number.

    Example: null
  • filter[description]string

    Filter by part description.

    Filter by part description.

    Example: null
  • filter[item_type]string

    Filter by part type (tire, wheel, part, labor, other).

    Filter by part supplier.

    Example: null
  • filter[inventory_type]string

    Filter by inventory type.

    Filter by part price.

    Example: null
  • filter[brand]string

    Filter by part brand or manufacturer.

  • filter[style]string

    Filter by part style or group. Brand is required when searching by style.

  • filter[size]string

    Filter by part size.

    Page number to return.

    Example: 1
  • filter[rawsize]number

    Filter by part rawsize.

  • filter[in_stock_only]string[]

    Filter by in stock only.

  • filter[speed_ratings][]string[]

    Filter by list of speed ratings (only available when item_type is tire).

  • filter[section_widths][]string[]

    Filter by list of section widths (only available when item_type is tire).

  • filter[aspect_ratios][]string[]

    Filter by list of aspect ratios (only available when item_type is tire).

  • filter[rim_diameters][]string[]

    Filter by list of rim diameters (only available when item_type is tire or wheel).

  • filter[finishes][]string[]

    Filter by list of finishes (only available when item_type is wheel).

  • filter[bolt_patterns][]string[]

    Filter by list of bolt patterns (only available when item_type is wheel).

  • filter[bolt_pattern_lugs][]string[]

    Filter by list of bolt pattern lugs (only available when item_type is wheel).

  • filter[bolt_pattern_diameters][]string[]

    Filter by list of bolt pattern diameters (only available when item_type is wheel).

  • filter[offsets][]string[]

    Filter by list of offsets (only available when item_type is wheel).

  • filter[show_in]string · enum

    Filter by availability (defaults to 'all')

    Enum values:
    location
    available
    all
  • filter[minimum_quantity]number

    Filter by a minimum on hand quantity

  • filter[maximum_quantity]number

    Filter by a maximum on hand quantity

  • filter[customer_id]number

    Filter by a specific customer ID

  • filter[price_level_id]number

    Filter to show a specific price (defaults to location's default price level)

  • filter[load_index]string
  • filter[sidewall]string
  • filter[ply]string
  • custom[*]string

    Any custom inventory fields can be searched by using custom and adding the name of the custom field. The name of the custom field should be url encoded when sent in params (e.g. custom[Tube%20Size] instead of custom[Tube Size]

  • pagenumber

    Page number to return.

  • pageSizenumber

    Number of items to return in a page. Defaults to 10.

Get Parts Inventories › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Parts Inventories › Responses

  • dataobject[] · required
  • linksobject · required
  • metaobject · required

Get Custom Fields

GET
https://api.prod.tireguru.net
/api/v1/inventory/custom_fields

Get Custom Fields › query Parameters

  • pageinteger

    Page number to return.

  • pageSizeinteger

    Number of items to return in a page. Defaults to 10

  • sortstring

    Sort by column, can be DESC or ASC. For DESC append a - next to the sort column. Available fields: name, field_id

Get Custom Fields › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Custom Fields › Responses

  • linksobject · required
  • metaobject · required
  • dataobject[] · required

Update Custom Fields on Part

PUT
https://api.prod.tireguru.net
/api/v1/inventory/items/{item_id}/custom_fields

Update Custom Fields on Part › path Parameters

  • item_idstring · required

Update Custom Fields on Part › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update Custom Fields on Part › Request Body

  • idnumber · required

    Custom Field primary key from get parts endpoint

  • valuestring · required

Update Custom Fields on Part › Responses

  • successboolean · required
EmployeeRepair Order