Tire Guru
Default module

Repair Order

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

Get Fees and Discounts

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

Get Fees and Discounts › 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.

  • filter[shop_id]string

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

Get Fees and Discounts › 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 Fees and Discounts › Responses

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

Get Repair Orders

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

This endpoint provides a comprehensive set of parameters to tailor your query. You can filter repair orders based on various criteria such as repair order id, customer id, writer, customer, vehicle id, vehicle info, customer address, customer phone number, customer city, customer state, vehicle vin and repair order type. Additionally, you can include related data such as inspections, customers, repair order inspection header, vehicles, account payments, labor, complaints, discount reasons, parts, sublet, recommend, recommended labor, recommended part, recommended sublet, part inventory, part sales and account payment part sales. The pagination options allow you to manage the number of items returned per page, facilitating smooth navigation through the repair order data.

Get Repair Orders › query Parameters

  • with_detailsboolean

    Include extra details in the response. This will add complaints, parts, sublet and labor details to every repair order.

    Include extra details in the response. This will add complaints, parts, sublet and labor details to every repair order.

    Example: true
  • sortstring

    Sort by column, can be DESC or ASC. For DESC append a - next to the sort column. Eg: -status_date. Sortable field: date_closed.

    Sort by column, can be DESC or ASC. For DESC append a - next to the sort column. Eg: -status_date. Sortable field: customer_id, customer, vin and status_date.

    Example: null
  • repair_order_idinteger

    Filter by repair order id.

    Filter by repair order id.

    Example: null
  • repair_order_typestring · enum

    Filter by repair order type. Defaults to "repair_order"

    Enum values:
    quote
    repair_order
    invoice
  • repair_order_numberstring

    Filter by the repair order number.

  • filter[customer_id]string

    Filter by repair order customer id.

    Filter by repair order customer id.

    Example: null
  • filter[vehicle_id]string

    Filter by repair order vehicle id.

  • filter[vin]string

    Filter by repair order vehicle vin number.

    Filter by repair order vehicle vin number.

    Example: null
  • filter[source]string · enum

    Filter by the source that created the order

    Enum values:
    website
    tirelink
    call_center
  • filter[updated_date]string

    Filter by last update date.

  • filter[shop_id]string

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

  • status_date_minstring

    Filter by minimum status date.

    Filter by minimum status date.

    Example: null
  • status_date_maxstring

    Filter by maximum status date.

    Filter by maximum status date.

    Example: null
  • pagestring

    Page number to return.

    Page number to return.

    Example: 1
  • pageSizestring

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

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

    Example: null

Get Repair Orders › 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 Repair Orders › Responses

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

Create Repair Order

POST
https://api.prod.tireguru.net
/api/v1/repair_orders

This endpoint provides a way to create a repair order

Create Repair Order › 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.

Create Repair Order › Request Body

  • shop_idnumber · required
  • customerobject · required

    Only provide this field if not providing a customer_id. This data will create a temporary customer and ignore the the customer_id field.

  • customer_idnumber
  • vehicle_idnumber
  • vehicleobject

    Only provide this field if not providing a vehicle_id. This data will create a temporary vehicle and ingore the vehicle_id field.

  • writerstring
    Example: John Doe
  • written_bystring
  • purchase_order_numberstring
  • commentsstring
    Example: Check for oil leak
  • sourcestring
  • reference_sourcestring
  • tread_depth_lrstring

    /32

    Example: 15
  • tread_depth_rfstring

    /32

    Example: 15
  • tread_depth_lfstring

    /32

    Example: 15
  • tread_depth_rrstring

    /32

    Example: 15
  • miles_instring
    Example: 45000
  • miles_outstring
    Example: 45000
  • urlstring

    URL to external website relating to the work order

    Example: https://example.com
  • tax_level_idnumber
  • price_level_idnumber
  • typestring · enum
    Enum values:
    repair_order
    quote
  • datestring
    Example: 2024-07-09T08:35:25.394Z
  • ship_to_idnumber
  • statusstring
  • routestring

    The name of the route

  • route_stopstring

    The stop number for the route. Must provide route if providing stop

Create Repair Order › Responses

  • repair_order_idnumber · required
  • shop_idnumber · required
  • repair_order_typestring · enum · required
    Enum values:
    repair_order
    quote
    Example: repair_order
  • statusstring | null · required
    Example: In Progress
  • writerstring · required
    Example: John Doe
  • tax_ratestring · required
  • purchase_order_numberstring · required
    Example: 123
  • tracking_numberstring · required
  • reference_numberstring · required
  • miles_innumber · required
  • miles_outnumber · required
  • commentsstring · required
    Example: This is a test comment
  • parts_costnumber · required
  • vehicleobject | null · required
  • customerobject | null · required
  • totalobject · required
  • date_instring · required
    Example: 2024-07-09T08:35:25.394Z
  • date_finalrequired
  • date_closedrequired
  • final_daterequired
  • status_daterequired
  • timestampstring · required
    Example: 2024-07-09T08:35:25.394Z
  • routestring
  • fees_discountsarray | null

    Only returned if 'with_details' in request is true

  • itemsarray | null

    Only returned if 'with_details' in request is true

Get Complaint Categories

GET
https://api.prod.tireguru.net
/api/v1/repair_orders/complaint_categories

Get Complaint Categories › query Parameters

  • pagestring

    Page number to return

  • pageSizestring

    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.

Get Complaint Categories › 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 Complaint Categories › Responses

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

Get Parts

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

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

Get Parts › query Parameters

  • sortstring

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

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

    Example: null
  • part_idinteger

    Filter by part id.

    Filter by part id.

    Example: null
  • filter[repair_order_id]integer

    Filter by repair order.

    Filter by repair order.

    Example: null
  • filter[part_number]string

    Filter by part number.

    Filter by part number.

    Example: null
  • filter[part_description]string

    Filter by part description.

    Filter by part description.

    Example: null
  • filter[part_code]string

    Filter by part code.

    Filter by part code.

    Example: null
  • filter[part_category]string

    Filter by part category.

    Filter by part category.

    Example: null
  • filter[sales_person]string

    Filter by sales person.

    Filter by sales person.

    Example: null
  • filter[shop_id]string

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

  • pagestring

    Page number to return.

    Page number to return.

    Example: 1
  • pageSizestring

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

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

    Example: null

Get Parts › 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 › Responses

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

Get Recommended Repairs

GET
https://api.prod.tireguru.net
/api/v1/repair_orders/recommended_repairs

Get Recommended Repairs › query Parameters

  • sortstring

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

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

    Example: null
  • filter[repair_order_id]integer

    Filter by repair order id.

    Filter by repair order id.

    Example: null
  • filter[updated_date]string

    Filter by last update date.

  • filter[vehicle_id]string
  • pagestring

    Page number to return.

    Page number to return.

    Example: 1
  • pageSizestring

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

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

    Example: null
  • filter[shop_id]string

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

Get Recommended Repairs › 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 Recommended Repairs › Responses

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

Update Repair Order

PUT
https://api.prod.tireguru.net
/api/v1/repair_orders/{id}

Update an existing Repair Order from here.

Update Repair Order › path Parameters

  • idstring · required

Update Repair Order › 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 Repair Order › Request Body

  • shop_idnumber · required
  • customerobject · required

    Only provide this field if not providing a customer_id. This data will create a temporary customer and ignore the the customer_id field.

  • customer_idnumber
  • vehicle_idnumber
  • vehicleobject

    Only provide this field if not providing a vehicle_id. This data will create a temporary vehicle and ingore the vehicle_id field.

  • writerstring
    Example: John Doe
  • written_bystring
  • purchase_order_numberstring
  • commentsstring
    Example: Check for oil leak
  • sourcestring
  • reference_sourcestring
  • tread_depth_lrstring

    /32

    Example: 15
  • tread_depth_rfstring

    /32

    Example: 15
  • tread_depth_lfstring

    /32

    Example: 15
  • tread_depth_rrstring

    /32

    Example: 15
  • miles_instring
    Example: 45000
  • miles_outstring
    Example: 45000
  • urlstring

    URL to external website relating to the work order

    Example: https://example.com
  • tax_level_idnumber
  • price_level_idnumber
  • typestring · enum
    Enum values:
    repair_order
    quote
  • datestring
    Example: 2024-07-09T08:35:25.394Z
  • ship_to_idnumber
  • statusstring
  • routestring

    The name of the route

  • route_stopstring

    The stop number for the route. Must provide route if providing stop

Update Repair Order › Responses

  • repair_order_idnumber · required
  • shop_idnumber · required
  • repair_order_typestring · enum · required
    Enum values:
    repair_order
    quote
    Example: repair_order
  • statusstring | null · required
    Example: In Progress
  • writerstring · required
    Example: John Doe
  • tax_ratestring · required
  • purchase_order_numberstring · required
    Example: 123
  • tracking_numberstring · required
  • reference_numberstring · required
  • miles_innumber · required
  • miles_outnumber · required
  • commentsstring · required
    Example: This is a test comment
  • parts_costnumber · required
  • vehicleobject | null · required
  • customerobject | null · required
  • totalobject · required
  • date_instring · required
    Example: 2024-07-09T08:35:25.394Z
  • date_finalrequired
  • date_closedrequired
  • final_daterequired
  • status_daterequired
  • timestampstring · required
    Example: 2024-07-09T08:35:25.394Z
  • routestring
  • fees_discountsarray | null

    Only returned if 'with_details' in request is true

  • itemsarray | null

    Only returned if 'with_details' in request is true

Add Fee or Discount to Repair Order

POST
https://api.prod.tireguru.net
/api/v1/repair_orders/{repair_order}/add_fee

Add Fee or Discount to Repair Order › path Parameters

  • repair_orderstring · required

Add Fee or Discount to Repair Order › 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.

Add Fee or Discount to Repair Order › Request Body

  • idnumber · required
  • quantitynumber · required
    Example: 1
  • pricenumber · required

    Price each - represents quantity of 1

    Example: 25
  • taxnumber · required

    Tax each - represents quantity of 1

    Example: 1

Add Fee or Discount to Repair Order › Responses

  • part_idnumber · required
  • item_idnumber · required
  • shop_idnumber · required
  • complaint_idnumber · required
  • repair_order_idnumber · required
  • canned_job_idrequired
  • partobject · required
  • total_pricenumber · required
  • part_order_numberstring · required
  • total_costnumber · required
  • binstring | null · required
  • taxnumber · required
  • order_statusstring | null · enum · required
    Enum values:
    received
    partially_received
    pending
  • sales_personstring · required
  • sales1string | null · required
  • sales2string | null · required
  • tech1string | null · required
  • tech2string | null · required
  • datestring · required
  • timestampstring · required

Add Labor

POST
https://api.prod.tireguru.net
/api/v1/repair_orders/{repair_order}/add_labor

This endpoint provides a way to add labor to a repair order.

Add Labor › path Parameters

  • repair_orderstring · required

Add Labor › 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.

Add Labor › Request Body

  • shop_idnumber · required
  • labor_idnumber · required
  • complaint_idnumber · required
  • rate_labelstring · required
    Example: Mount and Balance
  • labor_hoursnumber · required
    Example: 3
  • labornumber · required

    Total dollars for labor for each hour. Should represent a quantity of 1

    Example: 150
  • tech1string · required
    Example: John Doe
  • tech2string · required
  • sales1string · required
  • sales2string · required
  • sales_personstring · required
  • labor_statusstring · enum · required
    Enum values:
    not_started
    in_progress
    completed
    Example: not_started

Add Labor › Responses

  • labor_idnumber · required
  • item_idnumber · required
  • shop_idnumber · required
  • repair_order_idnumber · required
  • complaint_idnumber · required
  • canned_jobs_idnumber · required
  • rate_labelstring · required
    Example: Mount and Balance
  • hourly_ratestring · required
  • labor_hoursnumber · required
    Example: 3
  • labornumber · required

    Total dollars for labor for each hour. Should represent a quantity of 1

    Example: 150
  • technicianstring · required
    Example: John Doe
  • line_totalnumber · required
  • sales1string · required
    Example: John Doe
  • sales2string · required
  • tech1string · required
  • tech2string · required
  • labor_statusstring · enum · required
    Enum values:
    not_started
    in_progress
    completed
    Example: not_started
  • timestampstring · required
    Example: 2024-07-09T08:35:25.394Z
  • date_donestring · required

Add Part

POST
https://api.prod.tireguru.net
/api/v1/repair_orders/{repair_order}/add_part

This endpoint provides a way to add parts to a repair order.

Add Part › path Parameters

  • repair_orderstring · required

Add 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.

Add Part › Request Body

  • shop_idnumber · required
  • part_idnumber · required
  • quantitynumber · required
    Example: 3
  • complaint_idnumber
  • costnumber

    Dollar amount of cost for each. Cost should be for quantity of 1

    Example: 5.21
  • codestring

    Code to show in part number within RO

    Example: C125E
  • binstring
  • taxnumber

    Dollar amount of tax for each. Tax should be for quantity of 1

    Example: 1.15
  • fetnumber

    Dollar amount of FET for each. FET should be for quantity of 1

    Example: 2.22
  • partsnumber

    Dollar amount of parts for each. Parts should be for quantity of 1

    Example: 45.15
  • labornumber

    Dollar amount of labor for each. Labor should be for quantity of 1

    Example: 22.87
  • part_statusstring · enum
    Enum values:
    not_started
    in_progress
    completed
    Example: not_started
  • brandstring
  • descriptionstring
  • statusstring · enum
    Enum values:
    approved
    pending
    declined

Add Part › Responses

  • part_idnumber · required
  • item_idnumber · required
  • shop_idnumber · required
  • complaint_idnumber · required
  • repair_order_idnumber · required
  • canned_job_idrequired
  • partobject · required
  • total_pricenumber · required
  • part_order_numberstring · required
  • total_costnumber · required
  • binstring | null · required
  • taxnumber · required
  • order_statusstring | null · enum · required
    Enum values:
    received
    partially_received
    pending
  • sales_personstring · required
  • sales1string | null · required
  • sales2string | null · required
  • tech1string | null · required
  • tech2string | null · required
  • datestring · required
  • timestampstring · required

Add Sublet

POST
https://api.prod.tireguru.net
/api/v1/repair_orders/{repair_order}/add_sublet

This endpoint provides a way to add sublet to a repair order.

Add Sublet › path Parameters

  • repair_orderstring · required

Add Sublet › 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.

Add Sublet › Request Body

  • shop_idnumber · required
  • descriptionstring · required
    Example: Sublet Labor
  • pricenumber · required
    Example: 89.55
  • costnumber · required
    Example: 67.44
  • complaint_id

    Unique identifier of the complaint

  • doneboolean

    Defaults to false

Add Sublet › Responses

  • sublet_idnumber · required
  • item_idnumber · required
  • shop_idnumber · required

    Unique identifier of the shop

  • repair_order_idnumber · required

    Unique identifier of the repair order

  • sublet_descriptionstring · required
    Example: Sublet Labor
  • sublet_pricenumber · required
    Example: 89.55
  • sublet_costnumber · required
    Example: 67.44
  • sublet_invoice_numberstring · required
    Example: 12345
  • sublet_supplierstring · required
    Example: John's Tire Store
  • part_order_numberstring · required
    Example: 165135
  • is_taxableboolean · required
  • timestampstring · required

Update Labor

PUT
https://api.prod.tireguru.net
/api/v1/repair_orders/{repair_order}/labor/{labor_LaborID}

Update and existing Labor.

Update Labor › path Parameters

  • repair_orderstring · required
  • labor_LaborIDstring · required

Update Labor › 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 Labor › Request Body

  • labor_idnumber · required
  • item_idnumber · required
  • shop_idnumber · required
  • repair_order_idnumber · required
  • complaint_idnumber · required
  • canned_jobs_idnumber · required
  • rate_labelstring · required
    Example: Mount and Balance
  • hourly_ratestring · required
  • labor_hoursnumber · required
    Example: 3
  • labornumber · required

    Total dollars for labor for each hour. Should represent a quantity of 1

    Example: 150
  • technicianstring · required
    Example: John Doe
  • line_totalnumber · required
  • sales1string · required
    Example: John Doe
  • sales2string · required
  • tech1string · required
  • tech2string · required
  • labor_statusstring · enum · required
    Enum values:
    not_started
    in_progress
    completed
    Example: not_started
  • timestampstring · required
    Example: 2024-07-09T08:35:25.394Z
  • date_donestring · required

Update Labor › Responses

  • labor_idstring · required
  • item_idnumber · required
  • shop_idnumber · required
  • repair_order_idnumber · required
  • complaint_idnumber · required
  • canned_jobs_idnumber · required
  • rate_labelstring · required
    Example: Mount and Balance
  • hourly_ratestring · required
  • labor_hoursnumber · required
    Example: 3
  • labornumber · required

    Total dollars for labor for each hour. Should represent a quantity of 1

    Example: 150
  • technicianstring · required
    Example: John Doe
  • line_totalnumber · required
  • sales1string · required
    Example: John Doe
  • sales2string · required
  • tech1string · required
  • tech2string · required
  • labor_statusstring · enum · required
    Enum values:
    not_started
    in_progress
    completed
    Example: not_started
  • timestampstring · required

    Time added to order

    Example: 2024-07-09T08:35:25.394Z
  • date_donestring · required

Update Part

PUT
https://api.prod.tireguru.net
/api/v1/repair_orders/{repair_order}/part/{part_PartID}

Update and existing Part.

Update Part › path Parameters

  • repair_orderstring · required
  • part_PartIDstring · required

Update 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 Part › Request Body

  • shop_idnumber · required
  • part_idnumber · required
  • quantitynumber · required
    Example: 3
  • complaint_idnumber
  • costnumber

    Dollar amount of cost for each. Cost should be for quantity of 1

    Example: 5.21
  • codestring

    Code to show in part number within RO

    Example: C125E
  • binstring
  • taxnumber

    Dollar amount of tax for each. Tax should be for quantity of 1

    Example: 1.15
  • fetnumber

    Dollar amount of FET for each. FET should be for quantity of 1

    Example: 2.22
  • partsnumber

    Dollar amount of parts for each. Parts should be for quantity of 1

    Example: 45.15
  • labornumber

    Dollar amount of labor for each. Labor should be for quantity of 1

    Example: 22.87
  • part_statusstring · enum
    Enum values:
    not_started
    in_progress
    completed
    Example: not_started
  • brandstring
  • descriptionstring
  • statusstring · enum
    Enum values:
    approved
    pending
    declined

Update Part › Responses

  • part_idnumber · required
  • item_idnumber · required
  • shop_idnumber · required
  • complaint_idnumber · required
  • repair_order_idnumber · required
  • canned_job_idrequired
  • partobject · required
  • total_pricenumber · required
  • part_order_numberstring · required
  • total_costnumber · required
  • binstring | null · required
  • taxnumber · required
  • order_statusstring | null · enum · required
    Enum values:
    received
    partially_received
    pending
  • sales_personstring · required
  • sales1string | null · required
  • sales2string | null · required
  • tech1string | null · required
  • tech2string | null · required
  • datestring · required
  • timestampstring · required

Update Sublet

PUT
https://api.prod.tireguru.net
/api/v1/repair_orders/{repair_order}/sublet/{sublet_SubLetID}

Update and existing Sublet.

Update Sublet › path Parameters

  • repair_orderstring · required
  • sublet_SubLetIDstring · required

Update Sublet › 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 Sublet › Request Body

  • sublet_idnumber · required
  • item_idnumber · required
  • shop_idnumber · required
  • repair_order_idnumber · required
  • sublet_descriptionstring · required
    Example: Sublet Labor
  • sublet_pricenumber · required
    Example: 89.55
  • sublet_costnumber · required
    Example: 67.44
  • sublet_invoice_numberstring · required
    Example: 12345
  • sublet_supplierstring · required
    Example: John's Tire Store
  • part_order_numberstring · required
    Example: 165135
  • is_taxableboolean · required
  • timestampstring · required

Update Sublet › Responses

  • sublet_idstring · required
  • item_idnumber · required
  • shop_idnumber · required

    Unique identifier of the shop

  • repair_order_idnumber · required

    Unique identifier of the repair order

  • sublet_descriptionstring · required
    Example: Sublet Labor
  • sublet_pricenumber · required
    Example: 89.55
  • sublet_costnumber · required
    Example: 67.44
  • sublet_invoice_numberstring · required
    Example: 12345
  • sublet_supplierstring · required
    Example: John's Tire Store
  • part_order_numberstring · required
    Example: 165135
  • is_taxableboolean · required
  • timestampstring · required
InventoryInspections