Default module

Supplier

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

Get Suppliers

GET

https://api.prod.tireguru.net

/api/v1/suppliers

This endpoint provides a comprehensive set of parameters to tailor your query. You can filter suppliers based on various criteria such as supplier name, supplier address, supplier city, supplier state, supplier zip, supplier phone, supplier fax, supplier contact, supplier email, account number and notes. The pagination options allow you to manage the number of items returned per page, facilitating smooth navigation through the supplier data.

Get Suppliers › query Parameters

sortstring
Sort by column, can be DESC or ASC. For DESC append a - next to the sort column. Eg: -supplier_name. Sortable field: supplier.name, supplier.city, account_number.
Sort by column, can be DESC or ASC. For DESC append a - next to the sort column. Eg: -supplier_name. Sortable field: supplier_name, supplier_address, supplier_City, supplier_state, supplier_zip, supplier_phone, supplier_fax, supplier_Contact, active, supplier_email, account_number and notes.
Example: null
supplier_idinteger
Filter by supplier id.
Filter by supplier id.
Example: null
filter[supplier_name]string
Filter by supplier name.
Filter by supplier name.
Example: null
filter[supplier_address]string
Filter by supplier address.
Filter by supplier address.
Example: null
filter[supplier_city]string
Filter by supplier city.
Filter by supplier city.
Example: null
filter[supplier_state]string
Filter by supplier state.
Filter by supplier state.
Example: null
filter[supplier_zip]string
Filter by supplier zip.
Filter by supplier zip.
Example: null
filter[supplier_phone]string
Filter by supplier phone number.
Filter by supplier phone number.
Example: null
filter[supplier_fax]string
Filter by supplier fax.
Filter by supplier fax.
Example: null
filter[supplier_contact]string
Filter by supplier contact.
Filter by supplier contact.
Example: null
filter[supplier_email]string
Filter by supplier email.
Filter by supplier email.
Example: null
filter[account_number]string
Filter by supplier account number.
Filter by supplier account number.
Example: null
filter[notes]string
Filter by supplier note.
Filter by supplier note.
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 Suppliers › 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 Suppliers › Responses

dataobject[] · required
linksobject · required
metaobject · required

Create Supplier

POST

https://api.prod.tireguru.net

/api/v1/suppliers

You can create a new Supplier from here.

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

shop_idnumber · required
supplier_namestring · required
Example: John's Plumbing
supplier_addressstring · required
Example: 123 w 123 n
supplier_citystring · required
Example: Logan
supplier_statestring · required
Example: Utah
supplier_zipstring · required
supplier_phonestring · required
Example: 1234567899
account_numberstring · required
The is the equivalent to Tire Guru's Vendor Number field
Example: LPS30

supplier_faxstring
Example: 1234567899
supplier_contactstring
Example: John Doe
supplier_emailstring | null
Example: [email protected]
urlstring | null
Example: localpartstore.com
termsstring
Example: Net 30
notesstring
Example: Phone number is John's cell

Create Supplier › Responses

supplier_idnumber · required
shop_idnumber · required
available_company_wideboolean · required
supplierobject · required
account_numberstring · required
The is the equivalent to Tire Guru's Vendor Number field
Example: LPS30
online_orderingboolean · required
timestamprequired

urlstring | null
Example: localpartstore.com
termsstring
Example: Net 30
notesstring
Example: Phone number is John's cell

Update Supplier

PUT

https://api.prod.tireguru.net

/api/v1/suppliers/{id}

Update an existing Supplier from here.

Update Supplier › path Parameters

idstring · required

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

shop_idnumber · required
supplier_namestring · required
Example: John's Plumbing
supplier_addressstring · required
Example: 123 w 123 n
supplier_citystring · required
Example: Logan
supplier_statestring · required
Example: Utah
supplier_zipstring · required
supplier_phonestring · required
Example: 1234567899
account_numberstring · required
The is the equivalent to Tire Guru's Vendor Number field
Example: LPS30

supplier_faxstring
Example: 1234567899
supplier_contactstring
Example: John Doe
supplier_emailstring | null
Example: [email protected]
urlstring | null
Example: localpartstore.com
termsstring
Example: Net 30
notesstring
Example: Phone number is John's cell

Update Supplier › Responses

supplier_idnumber · required
shop_idnumber · required
available_company_wideboolean · required
supplierobject · required
account_numberstring · required
The is the equivalent to Tire Guru's Vendor Number field
Example: LPS30
online_orderingboolean · required
timestamprequired

urlstring | null
Example: localpartstore.com
termsstring
Example: Net 30
notesstring
Example: Phone number is John's cell

Settings Vehicle