Tire Guru
Default module

Customer

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

Get Customers

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

This endpoint provides a comprehensive set of parameters to tailor your query. You can filter customers based on first name, last name, address, home phone, and active status. Additionally, you can include related data such as vehicles, repair orders, part sales, schedules, expenses, and account payments. The pagination options allow you to manage the number of items returned per page, facilitating smooth navigation through the customer data.

Get Customers › query Parameters

  • with_detailsboolean

    Include extra details in the response. This will add vehicles, repair orders, part sales, schedule, expenses, account payments and account payment part sales to every customer.

    Include extra details in the response. This will add vehicles, repair orders, part sales, schedule, expenses, account payments and account payment part sales to every customer.

    Example: null
  • sortstring

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

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

    Example: null
  • customer_idinteger

    Filter by customer id.

    Filter by customer id.

    Example: 661
  • filter[first_name]string

    Filter by customer first name.

    Filter by customer first name.

    Example: null
  • filter[last_name]string

    Filter by customer last name.

    Filter by customer last name.

    Example: null
  • filter[address]string

    Filter by customer address.

    Filter by customer address.

    Example: null
  • filter[phone]string

    Filter by customer phone.

    Filter by customer phone.

    Example: null
  • 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.

  • 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 Customers › 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 Customers › Responses

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

Create Customer

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

You can create a new Customer from here.

Create Customer › 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 Customer › Request Body

  • shop_idnumber · required
  • business_namestring · required
    Example: John's Plumbing
  • first_namestring · required
    Example: John
  • last_namestring · required
    Example: Doe
  • addressstring · required
    Example: 123 w 123 n
  • citystring · required
    Example: Logan
  • statestring · required
    Example: Utah
  • zipstring · required
  • home_phonestring
    Example: 1234567899
  • work_phonestring
    Example: 1234567899
  • cell_phonestring
    Example: 1234567899
  • faxstring
    Example: 1234567899
  • emailstring | null
  • commentsstring
    Example: Likes us to call him when vehicle is done
  • cell_providerstring
    Example: Verizon
  • activeboolean
    Default: true
  • credit_limitnumber
    Example: 500
  • extensionnumber
    Example: 123
  • customer_typestring
    Example: Retail
  • customer_pay_typestring

    Name of customer's terms

  • customer_numberstring
    Example: 456

Create Customer › Responses

  • customer_idnumber
  • shop_idnumber
  • business_namestring
    Example: John's Plumbing
  • first_namestring
    Example: John
  • last_namestring
    Example: Doe
  • addressstring
    Example: 123 w 123 n
  • citystring
    Example: Logan
  • statestring
    Example: Utah
  • zipstring
  • phoneobject
  • emailstring | null
  • allow_marketingboolean
  • commentsstring
    Example: Likes us to call him when vehicle is done
  • cell_providerstring
    Example: Verizon
  • activeboolean
    Default: true
  • tax_exemptboolean

    Does the customer have a tax exempt certificate on file?

    Default: false
  • credit_limitnumber
    Example: 500
  • extensionstring
  • customer_typestring
    Example: Retail
  • termsstring
  • customer_numberstring
    Example: 456
  • customer_pay_typestring

    The customers Terms

  • timestampstring

    The created at time

  • home_phonestring · deprecated · required

    This field is deprecated. Please use fields under the phone object

  • cell_phonestring · deprecated · required

    This field is deprecated. Please use fields under the phone object

  • work_phonestring · deprecated · required

    This field is deprecated. Please use fields under the phone object

  • faxstring · deprecated · required

    This field is deprecated. Please use fields under the phone object

Update Customer

PUT
https://api.prod.tireguru.net
/api/v1/customers/{CustomerID}

Update an existing Customer from here.

Update Customer › path Parameters

  • CustomerIDstring · required

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

  • customer_idnumber
  • shop_idnumber
  • business_namestring
    Example: John's Plumbing
  • first_namestring
    Example: John
  • last_namestring
    Example: Doe
  • addressstring
    Example: 123 w 123 n
  • citystring
    Example: Logan
  • statestring
    Example: Utah
  • zipstring
  • phoneobject
  • emailstring | null
  • allow_marketingboolean
  • commentsstring
    Example: Likes us to call him when vehicle is done
  • cell_providerstring
    Example: Verizon
  • activeboolean
    Default: true
  • tax_exemptboolean

    Does the customer have a tax exempt certificate on file?

    Default: false
  • credit_limitnumber
    Example: 500
  • extensionstring
  • customer_typestring
    Example: Retail
  • termsstring
  • customer_numberstring
    Example: 456
  • customer_pay_typestring

    The customers Terms

  • timestampstring

    The created at time

  • home_phonestring · deprecated · required

    This field is deprecated. Please use fields under the phone object

  • cell_phonestring · deprecated · required

    This field is deprecated. Please use fields under the phone object

  • work_phonestring · deprecated · required

    This field is deprecated. Please use fields under the phone object

  • faxstring · deprecated · required

    This field is deprecated. Please use fields under the phone object

Update Customer › Responses

  • customer_idnumber
  • shop_idnumber
  • business_namestring
    Example: John's Plumbing
  • first_namestring
    Example: John
  • last_namestring
    Example: Doe
  • addressstring
    Example: 123 w 123 n
  • citystring
    Example: Logan
  • statestring
    Example: Utah
  • zipstring
  • phoneobject
  • emailstring | null
  • allow_marketingboolean
  • commentsstring
    Example: Likes us to call him when vehicle is done
  • cell_providerstring
    Example: Verizon
  • activeboolean
    Default: true
  • tax_exemptboolean

    Does the customer have a tax exempt certificate on file?

    Default: false
  • credit_limitnumber
    Example: 500
  • extensionstring
  • customer_typestring
    Example: Retail
  • termsstring
  • customer_numberstring
    Example: 456
  • customer_pay_typestring

    The customers Terms

  • timestampstring

    The created at time

  • home_phonestring · deprecated · required

    This field is deprecated. Please use fields under the phone object

  • cell_phonestring · deprecated · required

    This field is deprecated. Please use fields under the phone object

  • work_phonestring · deprecated · required

    This field is deprecated. Please use fields under the phone object

  • faxstring · deprecated · required

    This field is deprecated. Please use fields under the phone object

Get Customer Ship Tos

GET
https://api.prod.tireguru.net
/api/v1/customers/{customer_id}/ship_tos

Get Customer Ship Tos › path Parameters

  • customer_idstring · required

Get Customer Ship Tos › query Parameters

  • pagenumber

    Page number to return

  • pageSizenumber

    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: number, name.

  • filter[shop_id]string

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

Get Customer Ship Tos › 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 Customer Ship Tos › Responses

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

Create Customer Ship To

POST
https://api.prod.tireguru.net
/api/v1/customers/{customer_id}/ship_tos

Create Customer Ship To › path Parameters

  • customer_idstring · required

Create Customer Ship To › 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 Customer Ship To › Request Body

  • numberstring · required

    The number assigned to the ship to

  • namestring · required
    Example: John's Plumbing
  • addressstring · required
    Example: 123 w 123 n
  • citystring · required
    Example: Logan
  • statestring · required
    Example: Utah
  • zipstring · required
  • emailstring | null · required
  • work_phonestring · required
    Example: 1234567899
  • faxstring · required
    Example: 1234567899
  • home_phonestring · required
    Example: 1234567899
  • cell_phonestring · required
    Example: 1234567899

Create Customer Ship To › Responses

  • numberstring · required

    The number assigned to the ship to

  • namestring · required
    Example: John's Plumbing
  • addressstring · required
    Example: 123 w 123 n
  • citystring · required
    Example: Logan
  • statestring · required
    Example: Utah
  • zipstring · required
  • emailstring | null · required
  • work_phonestring · required
    Example: 1234567899
  • faxstring · required
    Example: 1234567899
  • home_phonestring · required
    Example: 1234567899
  • cell_phonestring · required
    Example: 1234567899
  • idnumber · required
  • customer_idnumber · required

Update Customer Ship To

PUT
https://api.prod.tireguru.net
/api/v1/customers/{customer_id}/ship_tos/{ship_to_id}

Update Customer Ship To › path Parameters

  • customer_idstring · required
  • ship_to_idstring · required

Update Customer Ship To › 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 Customer Ship To › Responses

  • numberstring · required

    The number assigned to the ship to

  • namestring · required
    Example: John's Plumbing
  • addressstring · required
    Example: 123 w 123 n
  • citystring · required
    Example: Logan
  • statestring · required
    Example: Utah
  • zipstring · required
  • emailstring | null · required
  • work_phonestring · required
    Example: 1234567899
  • faxstring · required
    Example: 1234567899
  • home_phonestring · required
    Example: 1234567899
  • cell_phonestring · required
    Example: 1234567899
  • idnumber · required
  • customer_idnumber · required

Get Customer Accounts Receivable

GET
https://api.prod.tireguru.net
/api/v1/customers/{customer_id}/accounts_receivable

This endpoint is in development and not yet available in production.

Get Customer Accounts Receivable › path Parameters

  • customer_idstring · required

Get Customer Accounts Receivable › query Parameters

  • filter[paid]boolean
  • filter[ar_date_start]string
  • filter[ar_date_end]string
  • filter[ar_due_date_start]string
  • filter[ar_due_date_end]string
  • filter[payment_date_start]string
  • filter[payment_date_end]string
  • filter[ar_actual_date_start]string
  • filter[ar_actual_date_end]string
  • filter[reference]string
  • filter[repair_order_id]string
  • filter[shop_id]string

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

  • sortstring · enum
    Enum values:
    reference
    due_date
    date
    actual_date

Get Customer Accounts Receivable › 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 Customer Accounts Receivable › Responses

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