Inventory Tire

WIP: A summary needs to be written for Inventory Tire

GET/v3/inventory_tire/:id

Find Canned Service

Find one Canned Service by id

URL parameters

Name
id
Type
string Required
Description
the id for the object to retrieve

Produces

The response content type: application/json

`200` Response

Name
data
Type
object Required
Description
CannedService schema
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Properties for `data` object

Name
id
Type
string Required
Description
Name
meta
Type
object Required
Description
the metadata about the most recent change to the row
Name
metadata
Type
object
Description
metadata reserved for customers to control
Name
createdDate
Type
string Required
Description
Name
updatedDate
Type
string Required
Description
Name
locationId
Type
string Required
Description
Name
companyId
Type
string Required
Description
Name
inventoryTireTemplateId
Type
string Required
Description
/// This is explicitly not a foreign key to persist this connection for consumer processing after inventory tire template deletion
Name
name
Type
string Required
Description
Name
note
Type
string Required
Description
Name
pricingMatrixId
Type
string Required
Description
Name
pricingMatrixDate
Type
string Required
Description
datetime when pricingMatrixId was set, for determining if matrix has been changed
Name
discountCents
Type
integer Required
Description
Name
discountPercent
Type
number Required
Description
Name
discountValueType
Type
one of: Percent, FixedCents Required
Description
Name
minCriticalQuantity
Type
number Required
Description
Name
maxCriticalQuantity
Type
number Required
Description
Name
quantity
Type
number Required
Description
Name
onEstimateQuantity
Type
number Required
Description
Name
reservedQuantity
Type
number Required
Description
Name
availableQuantity
Type
number Required
Description
Name
reorderQuantity
Type
number Required
Description
Name
retailCostCents
Type
integer Required
Description
Name
wholesaleCostCents
Type
integer Required
Description
Name
suggestedRetailCostCents
Type
integer Required
Description
Name
hasSetRetailCost
Type
boolean Required
Description
used to determine whether we should push updates to suggested retail cost down to retailCostCents
Name
sizeFormat
Type
one of: Conventional, OffRoadSAE Required
Description
Name
size
Type
string Required
Description
Name
partNumber
Type
string Required
Description
Name
normalizedPartNumber
Type
string Required
Description
Name
sku
Type
string Required
Description
Name
normalizedSKU
Type
string Required
Description
Name
binLocation
Type
string Required
Description
Name
taxable
Type
boolean Required
Description
US specific
Name
taxableGST
Type
boolean Required
Description
CA specific
Name
taxableHST
Type
boolean Required
Description
CA specific
Name
taxablePST
Type
boolean Required
Description
CA specific
Name
showPartNumber
Type
boolean Required
Description
show number on estimate & invoice ///
Name
showPriceAndQuantity
Type
boolean Required
Description
show on estimates and invoices ///
Name
showNote
Type
boolean Required
Description
show note on estimates & invoices ///
Name
federalExciseTaxCents
Type
integer Required
Description
Name
wasteTireFeeCents
Type
integer Required
Description
Name
inventoryNumber
Type
string Required
Description
Name
tireModelId
Type
string Required
Description
Name
url
Type
string Required
Description
Name
userId
Type
string Required
Description
Name
categoryType
Type
string Required
Description
AT, XL ...
Name
loadRange
Type
string Required
Description
Name
serviceType
Type
string Required
Description
Name
construction
Type
string Required
Description
Name
isStudded
Type
boolean Required
Description
Name
isRunFlat
Type
boolean Required
Description
Name
sectionWidthUnit
Type
one of: mm, in Required
Description
Name
sectionWidthValue
Type
number Required
Description
Name
sidewallAspectValue
Type
number Required
Description
Name
wheelDiameterUnit
Type
one of: mm, in Required
Description
Name
wheelDiameterValue
Type
number Required
Description
Name
loadIndex
Type
integer Required
Description
Name
speedRating
Type
string Required
Description
Name
outerDiameterUnit
Type
one of: mm, in Required
Description
Name
outerDiameterValue
Type
number Required
Description
Name
treadDepthUnit
Type
one of: mm, in Required
Description
Name
treadDepthValue
Type
number Required
Description
Name
maxTirePressurePSI
Type
number Required
Description
Name
traction_UTQG
Type
string Required
Description
Name
temperature_UTQG
Type
string Required
Description
Name
treadWear_UTQG
Type
number Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been deleted
Name
deletedUserId
Type
string Required
Description
the user that deleted the record or null if not deleted
Name
deletedDate
Type
string Required
Description
the date that the record was deleted or null if not deleted
Name
deletedReason
Type
string Required
Description
the reason that the record was deleted
Name
markedForDeletion
Type
boolean Required
Description
if the record is pending deletion because of the template being deleted
Name
tireModel
Type
object
Description
TireModel schema

Properties for `meta` object

Name
userId
Type
string
Description
the user id that made the most recent change
Name
sessionId
Type
string
Description
the session id for the most recent change
Name
version
Type
number
Description
a monotonically increasing number for the most recent change

Properties for `tireModel` object

Name
id
Type
string Required
Description
Name
name
Type
string Required
Description
Name
seasonality
Type
one of: Summer, Winter, AllSeasons Required
Description
Name
brand
Type
object Required
Description
Brand schema
Name
category
Type
object Required
Description
Name
vendor
Type
object Required
Description
Vendor schema

Properties for `brand` object

Name
id
Type
string Required
Description
Name
name
Type
string Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been deleted

Properties for `category` object

Name
id
Type
string Required
Description
Name
name
Type
string Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been deleted
Name
parent
Type
object Required
Description
InventoryCategory schema

Properties for `parent` object

Name
id
Type
string Required
Description
Name
name
Type
string Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been deleted

Properties for `vendor` object

Name
id
Type
string Required
Description
Name
name
Type
string Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been deleted

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

GET

/v3/inventory_tire/:id

curl https://api.shopmonkey.cloud/v3/inventory_tire/:id \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "meta": {
      "userId": "userId",
      "sessionId": "sessionId",
      "version": 1
    },
    "createdDate": "createdDate",
    "updatedDate": null,
    "locationId": "locationId",
    "companyId": "companyId",
    "name": "name",
    "note": null,
    "pricingMatrixId": null,
    "pricingMatrixDate": null,
    "discountCents": 1,
    "discountPercent": 1,
    "discountValueType": "discountValueType",
    "quantity": 1,
    "retailCostCents": 1,
    "wholesaleCostCents": null,
    "sizeFormat": "sizeFormat",
    "size": null,
    "partNumber": null,
    "binLocation": null,
    "brandId": null,
    "model": null,
    "vendorId": null,
    "seasonality": null,
    "taxable": true,
    "showPartNumber": true,
    "showPriceAndQuantity": true,
    "showNote": true,
    "categoryId": null,
    "federalExciseTaxCents": 1,
    "wasteTireFeeCents": 1,
    "inventoryNumber": null,
    "categoryType": null,
    "loadRange": null,
    "serviceType": null,
    "construction": null,
    "isStudded": true,
    "isRunFlat": true,
    "sectionWidthUnit": "sectionWidthUnit",
    "sectionWidthValue": null,
    "sidewallAspectValue": null,
    "wheelDiameterUnit": "wheelDiameterUnit",
    "wheelDiameterValue": null,
    "loadIndex": null,
    "speedRating": null,
    "outerDiameterUnit": "outerDiameterUnit",
    "outerDiameterValue": null,
    "treadDepthUnit": "treadDepthUnit",
    "treadDepthValue": null,
    "maxTirePressurePSI": null,
    "traction_UTQG": null,
    "temperature_UTQG": null,
    "treadWear_UTQG": null,
    "deleted": true,
    "deletedUserId": null,
    "deletedDate": null,
    "deletedReason": null,
    "userId": null
  }
}

GET/v3/inventory_tire

List Canned Services

Find all Canned Services

Query String parameters

Name
ids
Type
array
Description
Name
limit
Type
number
Description
the limit on the number of records to return
Name
orderby
Type
string
Description
the order instructions for the result
Name
params
Type
string
Description
additional request specific params
Name
skip
Type
number
Description
the number of records to skip for a paginated result
Name
where
Type
string
Description
an object to use for filtering the results

Produces

The response content type: application/json

`200` Response

Name
data
Type
array Required
Description
an array of items
Name
meta
Type
object
Description
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Properties for `meta` object

Name
hasMore
Type
boolean Required
Description
if there are more records available
Name
total
Type
number Required
Description
the total number of records

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

GET

/v3/inventory_tire

curl https://api.shopmonkey.cloud/v3/inventory_tire \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "locationId": "locationId",
      "companyId": "companyId",
      "name": "name",
      "note": null,
      "pricingMatrixId": null,
      "pricingMatrixDate": null,
      "discountCents": 1,
      "discountPercent": 1,
      "discountValueType": "discountValueType",
      "quantity": 1,
      "retailCostCents": 1,
      "wholesaleCostCents": null,
      "sizeFormat": "sizeFormat",
      "size": null,
      "partNumber": null,
      "binLocation": null,
      "brandId": null,
      "model": null,
      "vendorId": null,
      "seasonality": null,
      "taxable": true,
      "showPartNumber": true,
      "showPriceAndQuantity": true,
      "showNote": true,
      "categoryId": null,
      "federalExciseTaxCents": 1,
      "wasteTireFeeCents": 1,
      "inventoryNumber": null,
      "categoryType": null,
      "loadRange": null,
      "serviceType": null,
      "construction": null,
      "isStudded": true,
      "isRunFlat": true,
      "sectionWidthUnit": "sectionWidthUnit",
      "sectionWidthValue": null,
      "sidewallAspectValue": null,
      "wheelDiameterUnit": "wheelDiameterUnit",
      "wheelDiameterValue": null,
      "loadIndex": null,
      "speedRating": null,
      "outerDiameterUnit": "outerDiameterUnit",
      "outerDiameterValue": null,
      "treadDepthUnit": "treadDepthUnit",
      "treadDepthValue": null,
      "maxTirePressurePSI": null,
      "traction_UTQG": null,
      "temperature_UTQG": null,
      "treadWear_UTQG": null,
      "deleted": true,
      "deletedUserId": null,
      "deletedDate": null,
      "deletedReason": null,
      "userId": null
    }
  ]
}

POST/v3/inventory_tire/search

Search Canned Service entities

Search for Canned Service Entries

Produces

The response content type: application/json

`200` Response

Name
data
Type
array Required
Description
an array of items
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST

/v3/inventory_tire/search

curl https://api.shopmonkey.cloud/v3/inventory_tire/search \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "locationId": "locationId",
      "companyId": "companyId",
      "inventoryTireTemplateId": null,
      "name": "name",
      "note": null,
      "pricingMatrixId": null,
      "pricingMatrixDate": null,
      "discountCents": 1,
      "discountPercent": 1,
      "discountValueType": "discountValueType",
      "minCriticalQuantity": null,
      "maxCriticalQuantity": null,
      "quantity": 1,
      "onEstimateQuantity": 1,
      "reservedQuantity": 1,
      "availableQuantity": 1,
      "reorderQuantity": 1,
      "retailCostCents": 1,
      "wholesaleCostCents": null,
      "sizeFormat": "sizeFormat",
      "size": null,
      "partNumber": null,
      "normalizedPartNumber": null,
      "sku": null,
      "normalizedSKU": null,
      "binLocation": null,
      "taxable": true,
      "taxableGST": true,
      "taxableHST": true,
      "taxablePST": true,
      "showPartNumber": true,
      "showPriceAndQuantity": true,
      "showNote": true,
      "federalExciseTaxCents": 1,
      "wasteTireFeeCents": 1,
      "inventoryNumber": null,
      "tireModelId": "tireModelId",
      "url": null,
      "userId": null,
      "categoryType": null,
      "loadRange": null,
      "serviceType": null,
      "construction": null,
      "isStudded": true,
      "isRunFlat": true,
      "sectionWidthUnit": "sectionWidthUnit",
      "sectionWidthValue": null,
      "sidewallAspectValue": null,
      "wheelDiameterUnit": "wheelDiameterUnit",
      "wheelDiameterValue": null,
      "loadIndex": null,
      "speedRating": null,
      "outerDiameterUnit": "outerDiameterUnit",
      "outerDiameterValue": null,
      "treadDepthUnit": "treadDepthUnit",
      "treadDepthValue": null,
      "maxTirePressurePSI": null,
      "traction_UTQG": null,
      "temperature_UTQG": null,
      "treadWear_UTQG": null,
      "deleted": true,
      "deletedUserId": null,
      "deletedDate": null,
      "deletedReason": null,
      "tireModel": {
        "id": "id",
        "name": "name",
        "seasonality": null,
        "brand": {
          "id": "id",
          "name": "name"
        },
        "category": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "vendor": {
          "id": "id",
          "name": "name"
        }
      }
    }
  ],
  "meta": {
    "totalCost": 1,
    "totalQuantity": 1,
    "totalValue": 1,
    "hasMore": true,
    "total": 1
  },
  "success": true
}

POST/v3/inventory_tire

Create Inventory Tire

Create one Inventory Tire

Body parameters

Consumes

The following content type is required: application/json

Name
name
Type
string
Description
Name
note
Type
string
Description
Name
pricingMatrixId
Type
string
Description
Name
discountCents
Type
integer
Description
Name
discountPercent
Type
number
Description
Name
discountValueType
Type
one of: Percent, FixedCents
Description
Name
minCriticalQuantity
Type
number
Description
Name
maxCriticalQuantity
Type
number
Description
Name
quantity
Type
number
Description
Name
retailCostCents
Type
integer
Description
Name
wholesaleCostCents
Type
integer
Description
Name
suggestedRetailCostCents
Type
integer
Description
Name
sizeFormat
Type
one of: Conventional, OffRoadSAE
Description
Name
size
Type
string
Description
Name
partNumber
Type
string
Description
Name
sku
Type
string
Description
Name
binLocation
Type
string
Description
Name
taxable
Type
boolean
Description
US specific
Name
taxableGST
Type
boolean
Description
CA specific
Name
taxableHST
Type
boolean
Description
CA specific
Name
taxablePST
Type
boolean
Description
CA specific
Name
showPartNumber
Type
boolean
Description
show number on estimate & invoice ///
Name
showPriceAndQuantity
Type
boolean
Description
show on estimates and invoices ///
Name
showNote
Type
boolean
Description
show note on estimates & invoices ///
Name
federalExciseTaxCents
Type
integer
Description
Name
wasteTireFeeCents
Type
integer
Description
Name
inventoryNumber
Type
string
Description
Name
tireModelId
Type
string Required
Description
Name
url
Type
string
Description
Name
userId
Type
string
Description
Name
categoryType
Type
string
Description
AT, XL ...
Name
loadRange
Type
string
Description
Name
serviceType
Type
string
Description
Name
construction
Type
string
Description
Name
isStudded
Type
boolean
Description
Name
isRunFlat
Type
boolean
Description
Name
sectionWidthUnit
Type
one of: mm, in
Description
Name
sectionWidthValue
Type
number
Description
Name
sidewallAspectValue
Type
number
Description
Name
wheelDiameterUnit
Type
one of: mm, in
Description
Name
wheelDiameterValue
Type
number
Description
Name
loadIndex
Type
integer
Description
Name
speedRating
Type
string
Description
Name
outerDiameterUnit
Type
one of: mm, in
Description
Name
outerDiameterValue
Type
number
Description
Name
treadDepthUnit
Type
one of: mm, in
Description
Name
treadDepthValue
Type
number
Description
Name
maxTirePressurePSI
Type
number
Description
Name
traction_UTQG
Type
string
Description
Name
temperature_UTQG
Type
string
Description
Name
treadWear_UTQG
Type
number
Description
Name
deleted
Type
boolean
Description
if the record has been deleted
Name
deletedUserId
Type
string
Description
the user that deleted the record or null if not deleted
Name
deletedReason
Type
string
Description
the reason that the record was deleted
Name
markedForDeletion
Type
boolean
Description
if the record is pending deletion because of the template being deleted

Produces

The response content type: application/json

`200` Response

Name
code
Type
string
Description
The error code
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if success = false
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message
Name
data
Type
object Required
Description
InventoryTire schema

Properties for `data` object

Name
id
Type
string Required
Description
Name
createdDate
Type
string Required
Description
Name
updatedDate
Type
string Required
Description
Name
locationId
Type
string Required
Description
Name
companyId
Type
string Required
Description
Name
inventoryTireTemplateId
Type
string Required
Description
/// This is explicitly not a foreign key to persist this connection for consumer processing after inventory tire template deletion
Name
name
Type
string Required
Description
Name
note
Type
string Required
Description
Name
pricingMatrixId
Type
string Required
Description
Name
pricingMatrixDate
Type
string Required
Description
datetime when pricingMatrixId was set, for determining if matrix has been changed
Name
discountCents
Type
integer Required
Description
Name
discountPercent
Type
number Required
Description
Name
discountValueType
Type
one of: Percent, FixedCents Required
Description
Name
minCriticalQuantity
Type
number Required
Description
Name
maxCriticalQuantity
Type
number Required
Description
Name
quantity
Type
number Required
Description
Name
onEstimateQuantity
Type
number Required
Description
Name
reservedQuantity
Type
number Required
Description
Name
availableQuantity
Type
number Required
Description
Name
reorderQuantity
Type
number Required
Description
Name
retailCostCents
Type
integer Required
Description
Name
wholesaleCostCents
Type
integer Required
Description
Name
suggestedRetailCostCents
Type
integer Required
Description
Name
hasSetRetailCost
Type
boolean Required
Description
used to determine whether we should push updates to suggested retail cost down to retailCostCents
Name
sizeFormat
Type
one of: Conventional, OffRoadSAE Required
Description
Name
size
Type
string Required
Description
Name
partNumber
Type
string Required
Description
Name
normalizedPartNumber
Type
string Required
Description
Name
sku
Type
string Required
Description
Name
normalizedSKU
Type
string Required
Description
Name
binLocation
Type
string Required
Description
Name
taxable
Type
boolean Required
Description
US specific
Name
taxableGST
Type
boolean Required
Description
CA specific
Name
taxableHST
Type
boolean Required
Description
CA specific
Name
taxablePST
Type
boolean Required
Description
CA specific
Name
showPartNumber
Type
boolean Required
Description
show number on estimate & invoice ///
Name
showPriceAndQuantity
Type
boolean Required
Description
show on estimates and invoices ///
Name
showNote
Type
boolean Required
Description
show note on estimates & invoices ///
Name
federalExciseTaxCents
Type
integer Required
Description
Name
wasteTireFeeCents
Type
integer Required
Description
Name
inventoryNumber
Type
string Required
Description
Name
tireModelId
Type
string Required
Description
Name
url
Type
string Required
Description
Name
userId
Type
string Required
Description
Name
categoryType
Type
string Required
Description
AT, XL ...
Name
loadRange
Type
string Required
Description
Name
serviceType
Type
string Required
Description
Name
construction
Type
string Required
Description
Name
isStudded
Type
boolean Required
Description
Name
isRunFlat
Type
boolean Required
Description
Name
sectionWidthUnit
Type
one of: mm, in Required
Description
Name
sectionWidthValue
Type
number Required
Description
Name
sidewallAspectValue
Type
number Required
Description
Name
wheelDiameterUnit
Type
one of: mm, in Required
Description
Name
wheelDiameterValue
Type
number Required
Description
Name
loadIndex
Type
integer Required
Description
Name
speedRating
Type
string Required
Description
Name
outerDiameterUnit
Type
one of: mm, in Required
Description
Name
outerDiameterValue
Type
number Required
Description
Name
treadDepthUnit
Type
one of: mm, in Required
Description
Name
treadDepthValue
Type
number Required
Description
Name
maxTirePressurePSI
Type
number Required
Description
Name
traction_UTQG
Type
string Required
Description
Name
temperature_UTQG
Type
string Required
Description
Name
treadWear_UTQG
Type
number Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been deleted
Name
deletedUserId
Type
string Required
Description
the user that deleted the record or null if not deleted
Name
deletedDate
Type
string Required
Description
the date that the record was deleted or null if not deleted
Name
deletedReason
Type
string Required
Description
the reason that the record was deleted
Name
markedForDeletion
Type
boolean Required
Description
if the record is pending deletion because of the template being deleted

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST

/v3/inventory_tire

curl https://api.shopmonkey.cloud/v3/inventory_tire \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{ "tireModelId" : "value" }'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "locationId": "locationId",
    "companyId": "companyId",
    "name": "name",
    "note": null,
    "pricingMatrixId": null,
    "pricingMatrixDate": null,
    "discountCents": 1,
    "discountPercent": 1,
    "discountValueType": "discountValueType",
    "quantity": 1,
    "retailCostCents": 1,
    "wholesaleCostCents": null,
    "sizeFormat": "sizeFormat",
    "size": null,
    "partNumber": null,
    "binLocation": null,
    "brandId": null,
    "model": null,
    "vendorId": null,
    "seasonality": null,
    "taxable": true,
    "showPartNumber": true,
    "showPriceAndQuantity": true,
    "showNote": true,
    "categoryId": null,
    "federalExciseTaxCents": 1,
    "wasteTireFeeCents": 1,
    "inventoryNumber": null,
    "categoryType": null,
    "loadRange": null,
    "serviceType": null,
    "construction": null,
    "isStudded": true,
    "isRunFlat": true,
    "sectionWidthUnit": "sectionWidthUnit",
    "sectionWidthValue": null,
    "sidewallAspectValue": null,
    "wheelDiameterUnit": "wheelDiameterUnit",
    "wheelDiameterValue": null,
    "loadIndex": null,
    "speedRating": null,
    "outerDiameterUnit": "outerDiameterUnit",
    "outerDiameterValue": null,
    "treadDepthUnit": "treadDepthUnit",
    "treadDepthValue": null,
    "maxTirePressurePSI": null,
    "traction_UTQG": null,
    "temperature_UTQG": null,
    "treadWear_UTQG": null,
    "deleted": true,
    "deletedUserId": null,
    "deletedDate": null,
    "deletedReason": null,
    "userId": null
  }
}

PUT/v3/inventory_tire/:id

Update

Update one by id

URL parameters

Name
id
Type
string Required
Description
the id for the object to update

Body parameters

Consumes

The following content type is required: application/json

Name
name
Type
string
Description
Name
note
Type
string
Description
Name
pricingMatrixId
Type
string
Description
Name
discountCents
Type
integer
Description
Name
discountPercent
Type
number
Description
Name
discountValueType
Type
one of: Percent, FixedCents
Description
Name
minCriticalQuantity
Type
number
Description
Name
maxCriticalQuantity
Type
number
Description
Name
quantity
Type
number
Description
Name
retailCostCents
Type
integer
Description
Name
wholesaleCostCents
Type
integer
Description
Name
suggestedRetailCostCents
Type
integer
Description
Name
sizeFormat
Type
one of: Conventional, OffRoadSAE
Description
Name
size
Type
string
Description
Name
partNumber
Type
string
Description
Name
sku
Type
string
Description
Name
binLocation
Type
string
Description
Name
taxable
Type
boolean
Description
US specific
Name
taxableGST
Type
boolean
Description
CA specific
Name
taxableHST
Type
boolean
Description
CA specific
Name
taxablePST
Type
boolean
Description
CA specific
Name
showPartNumber
Type
boolean
Description
show number on estimate & invoice ///
Name
showPriceAndQuantity
Type
boolean
Description
show on estimates and invoices ///
Name
showNote
Type
boolean
Description
show note on estimates & invoices ///
Name
federalExciseTaxCents
Type
integer
Description
Name
wasteTireFeeCents
Type
integer
Description
Name
inventoryNumber
Type
string
Description
Name
tireModelId
Type
string
Description
Name
url
Type
string
Description
Name
userId
Type
string
Description
Name
categoryType
Type
string
Description
AT, XL ...
Name
loadRange
Type
string
Description
Name
serviceType
Type
string
Description
Name
construction
Type
string
Description
Name
isStudded
Type
boolean
Description
Name
isRunFlat
Type
boolean
Description
Name
sectionWidthUnit
Type
one of: mm, in
Description
Name
sectionWidthValue
Type
number
Description
Name
sidewallAspectValue
Type
number
Description
Name
wheelDiameterUnit
Type
one of: mm, in
Description
Name
wheelDiameterValue
Type
number
Description
Name
loadIndex
Type
integer
Description
Name
speedRating
Type
string
Description
Name
outerDiameterUnit
Type
one of: mm, in
Description
Name
outerDiameterValue
Type
number
Description
Name
treadDepthUnit
Type
one of: mm, in
Description
Name
treadDepthValue
Type
number
Description
Name
maxTirePressurePSI
Type
number
Description
Name
traction_UTQG
Type
string
Description
Name
temperature_UTQG
Type
string
Description
Name
treadWear_UTQG
Type
number
Description
Name
deleted
Type
boolean
Description
if the record has been deleted
Name
deletedUserId
Type
string
Description
the user that deleted the record or null if not deleted
Name
deletedReason
Type
string
Description
the reason that the record was deleted
Name
markedForDeletion
Type
boolean
Description
if the record is pending deletion because of the template being deleted
Name
activityNote
Type
string
Description

Produces

The response content type: application/json

`200` Response

Name
code
Type
string
Description
The error code
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if success = false
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message
Name
data
Type
object Required
Description
InventoryTire schema

Properties for `data` object

Name
id
Type
string Required
Description
Name
createdDate
Type
string Required
Description
Name
updatedDate
Type
string Required
Description
Name
locationId
Type
string Required
Description
Name
companyId
Type
string Required
Description
Name
inventoryTireTemplateId
Type
string Required
Description
/// This is explicitly not a foreign key to persist this connection for consumer processing after inventory tire template deletion
Name
name
Type
string Required
Description
Name
note
Type
string Required
Description
Name
pricingMatrixId
Type
string Required
Description
Name
pricingMatrixDate
Type
string Required
Description
datetime when pricingMatrixId was set, for determining if matrix has been changed
Name
discountCents
Type
integer Required
Description
Name
discountPercent
Type
number Required
Description
Name
discountValueType
Type
one of: Percent, FixedCents Required
Description
Name
minCriticalQuantity
Type
number Required
Description
Name
maxCriticalQuantity
Type
number Required
Description
Name
quantity
Type
number Required
Description
Name
onEstimateQuantity
Type
number Required
Description
Name
reservedQuantity
Type
number Required
Description
Name
availableQuantity
Type
number Required
Description
Name
reorderQuantity
Type
number Required
Description
Name
retailCostCents
Type
integer Required
Description
Name
wholesaleCostCents
Type
integer Required
Description
Name
suggestedRetailCostCents
Type
integer Required
Description
Name
hasSetRetailCost
Type
boolean Required
Description
used to determine whether we should push updates to suggested retail cost down to retailCostCents
Name
sizeFormat
Type
one of: Conventional, OffRoadSAE Required
Description
Name
size
Type
string Required
Description
Name
partNumber
Type
string Required
Description
Name
normalizedPartNumber
Type
string Required
Description
Name
sku
Type
string Required
Description
Name
normalizedSKU
Type
string Required
Description
Name
binLocation
Type
string Required
Description
Name
taxable
Type
boolean Required
Description
US specific
Name
taxableGST
Type
boolean Required
Description
CA specific
Name
taxableHST
Type
boolean Required
Description
CA specific
Name
taxablePST
Type
boolean Required
Description
CA specific
Name
showPartNumber
Type
boolean Required
Description
show number on estimate & invoice ///
Name
showPriceAndQuantity
Type
boolean Required
Description
show on estimates and invoices ///
Name
showNote
Type
boolean Required
Description
show note on estimates & invoices ///
Name
federalExciseTaxCents
Type
integer Required
Description
Name
wasteTireFeeCents
Type
integer Required
Description
Name
inventoryNumber
Type
string Required
Description
Name
tireModelId
Type
string Required
Description
Name
url
Type
string Required
Description
Name
userId
Type
string Required
Description
Name
categoryType
Type
string Required
Description
AT, XL ...
Name
loadRange
Type
string Required
Description
Name
serviceType
Type
string Required
Description
Name
construction
Type
string Required
Description
Name
isStudded
Type
boolean Required
Description
Name
isRunFlat
Type
boolean Required
Description
Name
sectionWidthUnit
Type
one of: mm, in Required
Description
Name
sectionWidthValue
Type
number Required
Description
Name
sidewallAspectValue
Type
number Required
Description
Name
wheelDiameterUnit
Type
one of: mm, in Required
Description
Name
wheelDiameterValue
Type
number Required
Description
Name
loadIndex
Type
integer Required
Description
Name
speedRating
Type
string Required
Description
Name
outerDiameterUnit
Type
one of: mm, in Required
Description
Name
outerDiameterValue
Type
number Required
Description
Name
treadDepthUnit
Type
one of: mm, in Required
Description
Name
treadDepthValue
Type
number Required
Description
Name
maxTirePressurePSI
Type
number Required
Description
Name
traction_UTQG
Type
string Required
Description
Name
temperature_UTQG
Type
string Required
Description
Name
treadWear_UTQG
Type
number Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been deleted
Name
deletedUserId
Type
string Required
Description
the user that deleted the record or null if not deleted
Name
deletedDate
Type
string Required
Description
the date that the record was deleted or null if not deleted
Name
deletedReason
Type
string Required
Description
the reason that the record was deleted
Name
markedForDeletion
Type
boolean Required
Description
if the record is pending deletion because of the template being deleted

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

PUT

/v3/inventory_tire/:id

curl https://api.shopmonkey.cloud/v3/inventory_tire/:id \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X PUT -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "success": true
}

DELETE/v3/inventory_tire/:id

Delete Inventory Tire

Delete one Inventory Tire by id

URL parameters

Name
id
Type
string Required
Description
the id for the object to delete

Produces

The response content type: application/json

`200` Response

Name
data
Type
object
Description
Name
success
Type
boolean Required
Description

Properties for `data` object

Name
id
Type
string Required
Description
the id for the object

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

DELETE

/v3/inventory_tire/:id

curl https://api.shopmonkey.cloud/v3/inventory_tire/:id \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X DELETE -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "success": true
}

PATCH/v3/inventory_tire/:id/:action

Soft Delete Inventory Tire

Soft delete or undelete a Inventory Tire by id

URL parameters

Name
action
Type
one of: 'delete', 'undelete' Required
Description
the action to take
Name
id
Type
string Required
Description
primary key for the record

Body parameters

Consumes

The following content type is required: application/json

Name
reason
Type
string Required
Description
the reason message if deleted

Produces

The response content type: application/json

`200` Response

Name
code
Type
string
Description
The error code
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if success = false
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message
Name
data
Type
object Required
Description
InventoryTire schema

Properties for `data` object

Name
id
Type
string Required
Description
Name
createdDate
Type
string Required
Description
Name
updatedDate
Type
string Required
Description
Name
locationId
Type
string Required
Description
Name
companyId
Type
string Required
Description
Name
inventoryTireTemplateId
Type
string Required
Description
/// This is explicitly not a foreign key to persist this connection for consumer processing after inventory tire template deletion
Name
name
Type
string Required
Description
Name
note
Type
string Required
Description
Name
pricingMatrixId
Type
string Required
Description
Name
pricingMatrixDate
Type
string Required
Description
datetime when pricingMatrixId was set, for determining if matrix has been changed
Name
discountCents
Type
integer Required
Description
Name
discountPercent
Type
number Required
Description
Name
discountValueType
Type
one of: Percent, FixedCents Required
Description
Name
minCriticalQuantity
Type
number Required
Description
Name
maxCriticalQuantity
Type
number Required
Description
Name
quantity
Type
number Required
Description
Name
onEstimateQuantity
Type
number Required
Description
Name
reservedQuantity
Type
number Required
Description
Name
availableQuantity
Type
number Required
Description
Name
reorderQuantity
Type
number Required
Description
Name
retailCostCents
Type
integer Required
Description
Name
wholesaleCostCents
Type
integer Required
Description
Name
suggestedRetailCostCents
Type
integer Required
Description
Name
hasSetRetailCost
Type
boolean Required
Description
used to determine whether we should push updates to suggested retail cost down to retailCostCents
Name
sizeFormat
Type
one of: Conventional, OffRoadSAE Required
Description
Name
size
Type
string Required
Description
Name
partNumber
Type
string Required
Description
Name
normalizedPartNumber
Type
string Required
Description
Name
sku
Type
string Required
Description
Name
normalizedSKU
Type
string Required
Description
Name
binLocation
Type
string Required
Description
Name
taxable
Type
boolean Required
Description
US specific
Name
taxableGST
Type
boolean Required
Description
CA specific
Name
taxableHST
Type
boolean Required
Description
CA specific
Name
taxablePST
Type
boolean Required
Description
CA specific
Name
showPartNumber
Type
boolean Required
Description
show number on estimate & invoice ///
Name
showPriceAndQuantity
Type
boolean Required
Description
show on estimates and invoices ///
Name
showNote
Type
boolean Required
Description
show note on estimates & invoices ///
Name
federalExciseTaxCents
Type
integer Required
Description
Name
wasteTireFeeCents
Type
integer Required
Description
Name
inventoryNumber
Type
string Required
Description
Name
tireModelId
Type
string Required
Description
Name
url
Type
string Required
Description
Name
userId
Type
string Required
Description
Name
categoryType
Type
string Required
Description
AT, XL ...
Name
loadRange
Type
string Required
Description
Name
serviceType
Type
string Required
Description
Name
construction
Type
string Required
Description
Name
isStudded
Type
boolean Required
Description
Name
isRunFlat
Type
boolean Required
Description
Name
sectionWidthUnit
Type
one of: mm, in Required
Description
Name
sectionWidthValue
Type
number Required
Description
Name
sidewallAspectValue
Type
number Required
Description
Name
wheelDiameterUnit
Type
one of: mm, in Required
Description
Name
wheelDiameterValue
Type
number Required
Description
Name
loadIndex
Type
integer Required
Description
Name
speedRating
Type
string Required
Description
Name
outerDiameterUnit
Type
one of: mm, in Required
Description
Name
outerDiameterValue
Type
number Required
Description
Name
treadDepthUnit
Type
one of: mm, in Required
Description
Name
treadDepthValue
Type
number Required
Description
Name
maxTirePressurePSI
Type
number Required
Description
Name
traction_UTQG
Type
string Required
Description
Name
temperature_UTQG
Type
string Required
Description
Name
treadWear_UTQG
Type
number Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been deleted
Name
deletedUserId
Type
string Required
Description
the user that deleted the record or null if not deleted
Name
deletedDate
Type
string Required
Description
the date that the record was deleted or null if not deleted
Name
deletedReason
Type
string Required
Description
the reason that the record was deleted
Name
markedForDeletion
Type
boolean Required
Description
if the record is pending deletion because of the template being deleted

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

PATCH

/v3/inventory_tire/:id/:action

curl https://api.shopmonkey.cloud/v3/inventory_tire/:id/:action \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X PATCH -H 'Content-Type: application/json' \
  --data '{ "reason" : "value" }'

Example Response
application/json

{
  "success": true,
  "data": {
    "locationId": "locationId",
    "name": "name",
    "note": null,
    "pricingMatrixId": null,
    "pricingMatrixDate": null,
    "discountCents": 1,
    "discountPercent": 1,
    "discountValueType": "discountValueType",
    "quantity": 1,
    "retailCostCents": 1,
    "wholesaleCostCents": null,
    "sizeFormat": "sizeFormat",
    "size": null,
    "partNumber": null,
    "binLocation": null,
    "brandId": null,
    "model": null,
    "vendorId": null,
    "seasonality": null,
    "taxable": true,
    "showPartNumber": true,
    "showPriceAndQuantity": true,
    "showNote": true,
    "categoryId": null,
    "federalExciseTaxCents": 1,
    "wasteTireFeeCents": 1,
    "inventoryNumber": null,
    "categoryType": null,
    "loadRange": null,
    "serviceType": null,
    "construction": null,
    "isStudded": true,
    "isRunFlat": true,
    "sectionWidthUnit": "sectionWidthUnit",
    "sectionWidthValue": null,
    "sidewallAspectValue": null,
    "wheelDiameterUnit": "wheelDiameterUnit",
    "wheelDiameterValue": null,
    "loadIndex": null,
    "speedRating": null,
    "outerDiameterUnit": "outerDiameterUnit",
    "outerDiameterValue": null,
    "treadDepthUnit": "treadDepthUnit",
    "treadDepthValue": null,
    "maxTirePressurePSI": null,
    "traction_UTQG": null,
    "temperature_UTQG": null,
    "treadWear_UTQG": null,
    "deleted": true,
    "deletedUserId": null,
    "deletedDate": null,
    "deletedReason": null,
    "userId": null
  }
}

POST/v3/inventory_tire/sku_exists

Get the ID, brand name, model name, size, and soft deleted state of an Inventory Tire if the SKU matches

Check if an existing inventory tire was soft deleted with the same SKU, returning that tire's ID, brand name, model name, and size

Body parameters

Consumes

The following content type is required: application/json

Name
sku
Type
string Required
Description
the SKU of the Inventory Part

Produces

The response content type: application/json

`200` Response

Name
data
Type
object Required
Description
Name
success
Type
boolean Required
Description

Properties for `data` object

Name
brand
Type
string Required
Description
Name
deleted
Type
boolean Required
Description
Name
id
Type
string Required
Description
Name
model
Type
string Required
Description
Name
size
Type
string Required
Description

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST

/v3/inventory_tire/sku_exists

curl https://api.shopmonkey.cloud/v3/inventory_tire/sku_exists \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{ "sku" : "value" }'

Example Response
application/json

{
  "data": {
    "deleted": true,
    "id": "id"
  },
  "success": true
}

GET/v3/inventory_tire/template/:id

Find Inventory Tire Template

Find one Inventory Tire Template by id

URL parameters

Name
id
Type
string Required
Description
the id for the object to retrieve

Produces

The response content type: application/json

`200` Response

Name
data
Type
object Required
Description
InventoryTireTemplate schema
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Properties for `data` object

Name
id
Type
string Required
Description
Name
meta
Type
object Required
Description
the metadata about the most recent change to the row
Name
metadata
Type
object
Description
metadata reserved for customers to control
Name
createdDate
Type
string Required
Description
Name
updatedDate
Type
string Required
Description
Name
companyId
Type
string Required
Description
Name
name
Type
string Required
Description
Name
note
Type
string Required
Description
Name
pricingMatrixTemplateId
Type
string Required
Description
Name
retailCostCents
Type
integer Required
Description
Name
wholesaleCostCents
Type
integer Required
Description
Name
suggestedRetailCostCents
Type
integer Required
Description
Name
sizeFormat
Type
one of: Conventional, OffRoadSAE Required
Description
Name
size
Type
string Required
Description
Name
partNumber
Type
string Required
Description
Name
normalizedPartNumber
Type
string Required
Description
Name
sku
Type
string Required
Description
Name
normalizedSKU
Type
string Required
Description
Name
taxable
Type
boolean Required
Description
US specific
Name
taxableGST
Type
boolean Required
Description
CA specific
Name
taxableHST
Type
boolean Required
Description
CA specific
Name
taxablePST
Type
boolean Required
Description
CA specific
Name
federalExciseTaxCents
Type
integer Required
Description
Name
wasteTireFeeCents
Type
integer Required
Description
Name
inventoryNumber
Type
string Required
Description
Name
tireModelTemplateId
Type
string Required
Description
Name
url
Type
string Required
Description
Name
categoryType
Type
string Required
Description
AT, XL ...
Name
loadRange
Type
string Required
Description
Name
serviceType
Type
string Required
Description
Name
construction
Type
string Required
Description
Name
isStudded
Type
boolean Required
Description
Name
isRunFlat
Type
boolean Required
Description
Name
sectionWidthUnit
Type
one of: mm, in Required
Description
Name
sectionWidthValue
Type
number Required
Description
Name
sidewallAspectValue
Type
number Required
Description
Name
wheelDiameterUnit
Type
one of: mm, in Required
Description
Name
wheelDiameterValue
Type
number Required
Description
Name
loadIndex
Type
integer Required
Description
Name
speedRating
Type
string Required
Description
Name
outerDiameterUnit
Type
one of: mm, in Required
Description
Name
outerDiameterValue
Type
number Required
Description
Name
treadDepthUnit
Type
one of: mm, in Required
Description
Name
treadDepthValue
Type
number Required
Description
Name
maxTirePressurePSI
Type
number Required
Description
Name
traction_UTQG
Type
string Required
Description
Name
temperature_UTQG
Type
string Required
Description
Name
treadWear_UTQG
Type
number Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been deleted
Name
deletedUserId
Type
string Required
Description
the user that deleted the record or null if not deleted
Name
deletedDate
Type
string Required
Description
the date that the record was deleted or null if not deleted
Name
deletedReason
Type
string Required
Description
the reason that the record was deleted
Name
tireModelTemplate
Type
object
Description
TireModelTemplate schema

Properties for `meta` object

Name
userId
Type
string
Description
the user id that made the most recent change
Name
sessionId
Type
string
Description
the session id for the most recent change
Name
version
Type
number
Description
a monotonically increasing number for the most recent change

Properties for `tireModelTemplate` object

Name
id
Type
string Required
Description
Name
name
Type
string Required
Description
Name
seasonality
Type
one of: Summer, Winter, AllSeasons Required
Description
Name
brandTemplate
Type
object Required
Description
BrandTemplate schema
Name
categoryTemplate
Type
object Required
Description
Name
vendorTemplate
Type
object Required
Description
VendorTemplate schema

Properties for `brandTemplate` object

Name
id
Type
string Required
Description
Name
name
Type
string Required
Description

Properties for `categoryTemplate` object

Name
id
Type
string Required
Description
Name
name
Type
string Required
Description
Name
parent
Type
object Required
Description
InventoryCategoryTemplate schema

Properties for `parent` object

Name
id
Type
string Required
Description
Name
name
Type
string Required
Description

Properties for `vendorTemplate` object

Name
id
Type
string Required
Description
Name
name
Type
string Required
Description

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

GET

/v3/inventory_tire/template/:id

curl https://api.shopmonkey.cloud/v3/inventory_tire/template/:id \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "data": {
    "id": "id",
    "meta": {
      "userId": "userId",
      "sessionId": "sessionId",
      "version": 1
    },
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "name": "name",
    "note": null,
    "pricingMatrixTemplateId": null,
    "retailCostCents": 1,
    "wholesaleCostCents": null,
    "sizeFormat": "sizeFormat",
    "size": null,
    "partNumber": null,
    "normalizedPartNumber": null,
    "sku": null,
    "normalizedSKU": null,
    "taxable": true,
    "taxableGST": true,
    "taxableHST": true,
    "taxablePST": true,
    "federalExciseTaxCents": 1,
    "wasteTireFeeCents": 1,
    "inventoryNumber": null,
    "tireModelTemplateId": "tireModelTemplateId",
    "url": null,
    "categoryType": null,
    "loadRange": null,
    "serviceType": null,
    "construction": null,
    "isStudded": true,
    "isRunFlat": true,
    "sectionWidthUnit": "sectionWidthUnit",
    "sectionWidthValue": null,
    "sidewallAspectValue": null,
    "wheelDiameterUnit": "wheelDiameterUnit",
    "wheelDiameterValue": null,
    "loadIndex": null,
    "speedRating": null,
    "outerDiameterUnit": "outerDiameterUnit",
    "outerDiameterValue": null,
    "treadDepthUnit": "treadDepthUnit",
    "treadDepthValue": null,
    "maxTirePressurePSI": null,
    "traction_UTQG": null,
    "temperature_UTQG": null,
    "treadWear_UTQG": null,
    "deleted": true,
    "deletedUserId": null,
    "deletedDate": null,
    "deletedReason": null
  },
  "success": true
}

GET/v3/inventory_tire/template

List Inventory Tire Templates

Find all Inventory Tire Templates

Query String parameters

Name
ids
Type
array
Description
Name
limit
Type
number
Description
the limit on the number of records to return
Name
orderby
Type
string
Description
the order instructions for the result
Name
params
Type
string
Description
additional request specific params
Name
skip
Type
number
Description
the number of records to skip for a paginated result
Name
where
Type
string
Description
an object to use for filtering the results

Produces

The response content type: application/json

`200` Response

Name
data
Type
array Required
Description
an array of items
Name
meta
Type
object
Description
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Properties for `meta` object

Name
hasMore
Type
boolean Required
Description
if there are more records available
Name
total
Type
number Required
Description
the total number of records

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

GET

/v3/inventory_tire/template

curl https://api.shopmonkey.cloud/v3/inventory_tire/template \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "name": "name",
      "note": null,
      "pricingMatrixTemplateId": null,
      "retailCostCents": 1,
      "wholesaleCostCents": null,
      "sizeFormat": "sizeFormat",
      "size": null,
      "partNumber": null,
      "normalizedPartNumber": null,
      "sku": null,
      "normalizedSKU": null,
      "taxable": true,
      "taxableGST": true,
      "taxableHST": true,
      "taxablePST": true,
      "federalExciseTaxCents": 1,
      "wasteTireFeeCents": 1,
      "inventoryNumber": null,
      "tireModelTemplateId": "tireModelTemplateId",
      "url": null,
      "categoryType": null,
      "loadRange": null,
      "serviceType": null,
      "construction": null,
      "isStudded": true,
      "isRunFlat": true,
      "sectionWidthUnit": "sectionWidthUnit",
      "sectionWidthValue": null,
      "sidewallAspectValue": null,
      "wheelDiameterUnit": "wheelDiameterUnit",
      "wheelDiameterValue": null,
      "loadIndex": null,
      "speedRating": null,
      "outerDiameterUnit": "outerDiameterUnit",
      "outerDiameterValue": null,
      "treadDepthUnit": "treadDepthUnit",
      "treadDepthValue": null,
      "maxTirePressurePSI": null,
      "traction_UTQG": null,
      "temperature_UTQG": null,
      "treadWear_UTQG": null,
      "deleted": true,
      "deletedUserId": null,
      "deletedDate": null,
      "deletedReason": null
    }
  ],
  "success": true
}

POST/v3/inventory_tire/template/search

Search Inventory Tire Template entities

Search for Inventory Tire Template Entries

Produces

The response content type: application/json

`200` Response

Name
data
Type
array Required
Description
an array of items
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST

/v3/inventory_tire/template/search

curl https://api.shopmonkey.cloud/v3/inventory_tire/template/search \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "name": "name",
      "note": null,
      "pricingMatrixTemplateId": null,
      "retailCostCents": 1,
      "wholesaleCostCents": null,
      "sizeFormat": "sizeFormat",
      "size": null,
      "partNumber": null,
      "normalizedPartNumber": null,
      "sku": null,
      "normalizedSKU": null,
      "taxable": true,
      "taxableGST": true,
      "taxableHST": true,
      "taxablePST": true,
      "federalExciseTaxCents": 1,
      "wasteTireFeeCents": 1,
      "inventoryNumber": null,
      "tireModelTemplateId": "tireModelTemplateId",
      "url": null,
      "categoryType": null,
      "loadRange": null,
      "serviceType": null,
      "construction": null,
      "isStudded": true,
      "isRunFlat": true,
      "sectionWidthUnit": "sectionWidthUnit",
      "sectionWidthValue": null,
      "sidewallAspectValue": null,
      "wheelDiameterUnit": "wheelDiameterUnit",
      "wheelDiameterValue": null,
      "loadIndex": null,
      "speedRating": null,
      "outerDiameterUnit": "outerDiameterUnit",
      "outerDiameterValue": null,
      "treadDepthUnit": "treadDepthUnit",
      "treadDepthValue": null,
      "maxTirePressurePSI": null,
      "traction_UTQG": null,
      "temperature_UTQG": null,
      "treadWear_UTQG": null,
      "deleted": true,
      "deletedUserId": null,
      "deletedDate": null,
      "deletedReason": null,
      "tireModelTemplate": {
        "id": "id",
        "name": "name",
        "seasonality": null,
        "brandTemplate": {
          "id": "id",
          "name": "name"
        },
        "categoryTemplate": {
          "id": "id",
          "name": "name",
          "parent": {
            "id": "id",
            "name": "name"
          }
        },
        "vendorTemplate": {
          "id": "id",
          "name": "name"
        }
      }
    }
  ],
  "success": true
}

POST/v3/inventory_tire/template

Create Inventory Tire Template

Create one Inventory Tire Template

Body parameters

Consumes

The following content type is required: application/json

Name
name
Type
string
Description
Name
note
Type
string
Description
Name
pricingMatrixTemplateId
Type
string
Description
Name
retailCostCents
Type
integer
Description
Name
wholesaleCostCents
Type
integer
Description
Name
suggestedRetailCostCents
Type
integer
Description
Name
sizeFormat
Type
one of: Conventional, OffRoadSAE
Description
Name
size
Type
string
Description
Name
partNumber
Type
string
Description
Name
sku
Type
string
Description
Name
taxable
Type
boolean
Description
US specific
Name
taxableGST
Type
boolean
Description
CA specific
Name
taxableHST
Type
boolean
Description
CA specific
Name
taxablePST
Type
boolean
Description
CA specific
Name
federalExciseTaxCents
Type
integer
Description
Name
wasteTireFeeCents
Type
integer
Description
Name
inventoryNumber
Type
string
Description
Name
tireModelTemplateId
Type
string Required
Description
Name
url
Type
string
Description
Name
categoryType
Type
string
Description
AT, XL ...
Name
loadRange
Type
string
Description
Name
serviceType
Type
string
Description
Name
construction
Type
string
Description
Name
isStudded
Type
boolean
Description
Name
isRunFlat
Type
boolean
Description
Name
sectionWidthUnit
Type
one of: mm, in
Description
Name
sectionWidthValue
Type
number
Description
Name
sidewallAspectValue
Type
number
Description
Name
wheelDiameterUnit
Type
one of: mm, in
Description
Name
wheelDiameterValue
Type
number
Description
Name
loadIndex
Type
integer
Description
Name
speedRating
Type
string
Description
Name
outerDiameterUnit
Type
one of: mm, in
Description
Name
outerDiameterValue
Type
number
Description
Name
treadDepthUnit
Type
one of: mm, in
Description
Name
treadDepthValue
Type
number
Description
Name
maxTirePressurePSI
Type
number
Description
Name
traction_UTQG
Type
string
Description
Name
temperature_UTQG
Type
string
Description
Name
treadWear_UTQG
Type
number
Description
Name
deleted
Type
boolean
Description
if the record has been deleted
Name
deletedUserId
Type
string
Description
the user that deleted the record or null if not deleted
Name
deletedReason
Type
string
Description
the reason that the record was deleted

Produces

The response content type: application/json

`200` Response

Name
code
Type
string
Description
The error code
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if success = false
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message
Name
data
Type
object Required
Description
InventoryTireTemplate schema

Properties for `data` object

Name
id
Type
string Required
Description
Name
createdDate
Type
string Required
Description
Name
updatedDate
Type
string Required
Description
Name
companyId
Type
string Required
Description
Name
name
Type
string Required
Description
Name
note
Type
string Required
Description
Name
pricingMatrixTemplateId
Type
string Required
Description
Name
retailCostCents
Type
integer Required
Description
Name
wholesaleCostCents
Type
integer Required
Description
Name
suggestedRetailCostCents
Type
integer Required
Description
Name
sizeFormat
Type
one of: Conventional, OffRoadSAE Required
Description
Name
size
Type
string Required
Description
Name
partNumber
Type
string Required
Description
Name
normalizedPartNumber
Type
string Required
Description
Name
sku
Type
string Required
Description
Name
normalizedSKU
Type
string Required
Description
Name
taxable
Type
boolean Required
Description
US specific
Name
taxableGST
Type
boolean Required
Description
CA specific
Name
taxableHST
Type
boolean Required
Description
CA specific
Name
taxablePST
Type
boolean Required
Description
CA specific
Name
federalExciseTaxCents
Type
integer Required
Description
Name
wasteTireFeeCents
Type
integer Required
Description
Name
inventoryNumber
Type
string Required
Description
Name
tireModelTemplateId
Type
string Required
Description
Name
url
Type
string Required
Description
Name
categoryType
Type
string Required
Description
AT, XL ...
Name
loadRange
Type
string Required
Description
Name
serviceType
Type
string Required
Description
Name
construction
Type
string Required
Description
Name
isStudded
Type
boolean Required
Description
Name
isRunFlat
Type
boolean Required
Description
Name
sectionWidthUnit
Type
one of: mm, in Required
Description
Name
sectionWidthValue
Type
number Required
Description
Name
sidewallAspectValue
Type
number Required
Description
Name
wheelDiameterUnit
Type
one of: mm, in Required
Description
Name
wheelDiameterValue
Type
number Required
Description
Name
loadIndex
Type
integer Required
Description
Name
speedRating
Type
string Required
Description
Name
outerDiameterUnit
Type
one of: mm, in Required
Description
Name
outerDiameterValue
Type
number Required
Description
Name
treadDepthUnit
Type
one of: mm, in Required
Description
Name
treadDepthValue
Type
number Required
Description
Name
maxTirePressurePSI
Type
number Required
Description
Name
traction_UTQG
Type
string Required
Description
Name
temperature_UTQG
Type
string Required
Description
Name
treadWear_UTQG
Type
number Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been deleted
Name
deletedUserId
Type
string Required
Description
the user that deleted the record or null if not deleted
Name
deletedDate
Type
string Required
Description
the date that the record was deleted or null if not deleted
Name
deletedReason
Type
string Required
Description
the reason that the record was deleted

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST

/v3/inventory_tire/template

curl https://api.shopmonkey.cloud/v3/inventory_tire/template \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{ "tireModelTemplateId" : "value" }'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "name": "name",
    "note": null,
    "pricingMatrixTemplateId": null,
    "retailCostCents": 1,
    "wholesaleCostCents": null,
    "sizeFormat": "sizeFormat",
    "size": null,
    "partNumber": null,
    "normalizedPartNumber": null,
    "sku": null,
    "normalizedSKU": null,
    "taxable": true,
    "taxableGST": true,
    "taxableHST": true,
    "taxablePST": true,
    "federalExciseTaxCents": 1,
    "wasteTireFeeCents": 1,
    "inventoryNumber": null,
    "tireModelTemplateId": "tireModelTemplateId",
    "url": null,
    "categoryType": null,
    "loadRange": null,
    "serviceType": null,
    "construction": null,
    "isStudded": true,
    "isRunFlat": true,
    "sectionWidthUnit": "sectionWidthUnit",
    "sectionWidthValue": null,
    "sidewallAspectValue": null,
    "wheelDiameterUnit": "wheelDiameterUnit",
    "wheelDiameterValue": null,
    "loadIndex": null,
    "speedRating": null,
    "outerDiameterUnit": "outerDiameterUnit",
    "outerDiameterValue": null,
    "treadDepthUnit": "treadDepthUnit",
    "treadDepthValue": null,
    "maxTirePressurePSI": null,
    "traction_UTQG": null,
    "temperature_UTQG": null,
    "treadWear_UTQG": null,
    "deleted": true,
    "deletedUserId": null,
    "deletedDate": null,
    "deletedReason": null
  }
}

PUT/v3/inventory_tire/template/:id

Update Inventory Tire Template

Update one Inventory Tire Template by id

URL parameters

Name
id
Type
string Required
Description
the id for the object to update

Body parameters

Consumes

The following content type is required: application/json

Name
name
Type
string
Description
Name
note
Type
string
Description
Name
pricingMatrixTemplateId
Type
string
Description
Name
retailCostCents
Type
integer
Description
Name
wholesaleCostCents
Type
integer
Description
Name
suggestedRetailCostCents
Type
integer
Description
Name
sizeFormat
Type
one of: Conventional, OffRoadSAE
Description
Name
size
Type
string
Description
Name
partNumber
Type
string
Description
Name
sku
Type
string
Description
Name
taxable
Type
boolean
Description
US specific
Name
taxableGST
Type
boolean
Description
CA specific
Name
taxableHST
Type
boolean
Description
CA specific
Name
taxablePST
Type
boolean
Description
CA specific
Name
federalExciseTaxCents
Type
integer
Description
Name
wasteTireFeeCents
Type
integer
Description
Name
inventoryNumber
Type
string
Description
Name
tireModelTemplateId
Type
string
Description
Name
url
Type
string
Description
Name
categoryType
Type
string
Description
AT, XL ...
Name
loadRange
Type
string
Description
Name
serviceType
Type
string
Description
Name
construction
Type
string
Description
Name
isStudded
Type
boolean
Description
Name
isRunFlat
Type
boolean
Description
Name
sectionWidthUnit
Type
one of: mm, in
Description
Name
sectionWidthValue
Type
number
Description
Name
sidewallAspectValue
Type
number
Description
Name
wheelDiameterUnit
Type
one of: mm, in
Description
Name
wheelDiameterValue
Type
number
Description
Name
loadIndex
Type
integer
Description
Name
speedRating
Type
string
Description
Name
outerDiameterUnit
Type
one of: mm, in
Description
Name
outerDiameterValue
Type
number
Description
Name
treadDepthUnit
Type
one of: mm, in
Description
Name
treadDepthValue
Type
number
Description
Name
maxTirePressurePSI
Type
number
Description
Name
traction_UTQG
Type
string
Description
Name
temperature_UTQG
Type
string
Description
Name
treadWear_UTQG
Type
number
Description
Name
deleted
Type
boolean
Description
if the record has been deleted
Name
deletedUserId
Type
string
Description
the user that deleted the record or null if not deleted
Name
deletedReason
Type
string
Description
the reason that the record was deleted

Produces

The response content type: application/json

`200` Response

Name
code
Type
string
Description
The error code
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if success = false
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message
Name
data
Type
object Required
Description
InventoryTireTemplate schema

Properties for `data` object

Name
id
Type
string Required
Description
Name
createdDate
Type
string Required
Description
Name
updatedDate
Type
string Required
Description
Name
companyId
Type
string Required
Description
Name
name
Type
string Required
Description
Name
note
Type
string Required
Description
Name
pricingMatrixTemplateId
Type
string Required
Description
Name
retailCostCents
Type
integer Required
Description
Name
wholesaleCostCents
Type
integer Required
Description
Name
suggestedRetailCostCents
Type
integer Required
Description
Name
sizeFormat
Type
one of: Conventional, OffRoadSAE Required
Description
Name
size
Type
string Required
Description
Name
partNumber
Type
string Required
Description
Name
normalizedPartNumber
Type
string Required
Description
Name
sku
Type
string Required
Description
Name
normalizedSKU
Type
string Required
Description
Name
taxable
Type
boolean Required
Description
US specific
Name
taxableGST
Type
boolean Required
Description
CA specific
Name
taxableHST
Type
boolean Required
Description
CA specific
Name
taxablePST
Type
boolean Required
Description
CA specific
Name
federalExciseTaxCents
Type
integer Required
Description
Name
wasteTireFeeCents
Type
integer Required
Description
Name
inventoryNumber
Type
string Required
Description
Name
tireModelTemplateId
Type
string Required
Description
Name
url
Type
string Required
Description
Name
categoryType
Type
string Required
Description
AT, XL ...
Name
loadRange
Type
string Required
Description
Name
serviceType
Type
string Required
Description
Name
construction
Type
string Required
Description
Name
isStudded
Type
boolean Required
Description
Name
isRunFlat
Type
boolean Required
Description
Name
sectionWidthUnit
Type
one of: mm, in Required
Description
Name
sectionWidthValue
Type
number Required
Description
Name
sidewallAspectValue
Type
number Required
Description
Name
wheelDiameterUnit
Type
one of: mm, in Required
Description
Name
wheelDiameterValue
Type
number Required
Description
Name
loadIndex
Type
integer Required
Description
Name
speedRating
Type
string Required
Description
Name
outerDiameterUnit
Type
one of: mm, in Required
Description
Name
outerDiameterValue
Type
number Required
Description
Name
treadDepthUnit
Type
one of: mm, in Required
Description
Name
treadDepthValue
Type
number Required
Description
Name
maxTirePressurePSI
Type
number Required
Description
Name
traction_UTQG
Type
string Required
Description
Name
temperature_UTQG
Type
string Required
Description
Name
treadWear_UTQG
Type
number Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been deleted
Name
deletedUserId
Type
string Required
Description
the user that deleted the record or null if not deleted
Name
deletedDate
Type
string Required
Description
the date that the record was deleted or null if not deleted
Name
deletedReason
Type
string Required
Description
the reason that the record was deleted

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

PUT

/v3/inventory_tire/template/:id

curl https://api.shopmonkey.cloud/v3/inventory_tire/template/:id \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X PUT -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "name": "name",
    "note": null,
    "pricingMatrixTemplateId": null,
    "retailCostCents": 1,
    "wholesaleCostCents": null,
    "sizeFormat": "sizeFormat",
    "size": null,
    "partNumber": null,
    "normalizedPartNumber": null,
    "sku": null,
    "normalizedSKU": null,
    "taxable": true,
    "taxableGST": true,
    "taxableHST": true,
    "taxablePST": true,
    "federalExciseTaxCents": 1,
    "wasteTireFeeCents": 1,
    "inventoryNumber": null,
    "tireModelTemplateId": "tireModelTemplateId",
    "url": null,
    "categoryType": null,
    "loadRange": null,
    "serviceType": null,
    "construction": null,
    "isStudded": true,
    "isRunFlat": true,
    "sectionWidthUnit": "sectionWidthUnit",
    "sectionWidthValue": null,
    "sidewallAspectValue": null,
    "wheelDiameterUnit": "wheelDiameterUnit",
    "wheelDiameterValue": null,
    "loadIndex": null,
    "speedRating": null,
    "outerDiameterUnit": "outerDiameterUnit",
    "outerDiameterValue": null,
    "treadDepthUnit": "treadDepthUnit",
    "treadDepthValue": null,
    "maxTirePressurePSI": null,
    "traction_UTQG": null,
    "temperature_UTQG": null,
    "treadWear_UTQG": null,
    "deleted": true,
    "deletedUserId": null,
    "deletedDate": null,
    "deletedReason": null
  }
}

PATCH/v3/inventory_tire/template/:id/:action

Soft Delete Inventory Tire Template

Soft delete or undelete a Inventory Tire Template by id

URL parameters

Name
action
Type
one of: 'delete', 'undelete' Required
Description
the action to take
Name
id
Type
string Required
Description
primary key for the record

Body parameters

Consumes

The following content type is required: application/json

Name
reason
Type
string Required
Description
the reason message if deleted

Produces

The response content type: application/json

`200` Response

Name
code
Type
string
Description
The error code
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if success = false
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message
Name
data
Type
object Required
Description
InventoryTireTemplate schema

Properties for `data` object

Name
id
Type
string Required
Description
Name
createdDate
Type
string Required
Description
Name
updatedDate
Type
string Required
Description
Name
companyId
Type
string Required
Description
Name
name
Type
string Required
Description
Name
note
Type
string Required
Description
Name
pricingMatrixTemplateId
Type
string Required
Description
Name
retailCostCents
Type
integer Required
Description
Name
wholesaleCostCents
Type
integer Required
Description
Name
suggestedRetailCostCents
Type
integer Required
Description
Name
sizeFormat
Type
one of: Conventional, OffRoadSAE Required
Description
Name
size
Type
string Required
Description
Name
partNumber
Type
string Required
Description
Name
normalizedPartNumber
Type
string Required
Description
Name
sku
Type
string Required
Description
Name
normalizedSKU
Type
string Required
Description
Name
taxable
Type
boolean Required
Description
US specific
Name
taxableGST
Type
boolean Required
Description
CA specific
Name
taxableHST
Type
boolean Required
Description
CA specific
Name
taxablePST
Type
boolean Required
Description
CA specific
Name
federalExciseTaxCents
Type
integer Required
Description
Name
wasteTireFeeCents
Type
integer Required
Description
Name
inventoryNumber
Type
string Required
Description
Name
tireModelTemplateId
Type
string Required
Description
Name
url
Type
string Required
Description
Name
categoryType
Type
string Required
Description
AT, XL ...
Name
loadRange
Type
string Required
Description
Name
serviceType
Type
string Required
Description
Name
construction
Type
string Required
Description
Name
isStudded
Type
boolean Required
Description
Name
isRunFlat
Type
boolean Required
Description
Name
sectionWidthUnit
Type
one of: mm, in Required
Description
Name
sectionWidthValue
Type
number Required
Description
Name
sidewallAspectValue
Type
number Required
Description
Name
wheelDiameterUnit
Type
one of: mm, in Required
Description
Name
wheelDiameterValue
Type
number Required
Description
Name
loadIndex
Type
integer Required
Description
Name
speedRating
Type
string Required
Description
Name
outerDiameterUnit
Type
one of: mm, in Required
Description
Name
outerDiameterValue
Type
number Required
Description
Name
treadDepthUnit
Type
one of: mm, in Required
Description
Name
treadDepthValue
Type
number Required
Description
Name
maxTirePressurePSI
Type
number Required
Description
Name
traction_UTQG
Type
string Required
Description
Name
temperature_UTQG
Type
string Required
Description
Name
treadWear_UTQG
Type
number Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been deleted
Name
deletedUserId
Type
string Required
Description
the user that deleted the record or null if not deleted
Name
deletedDate
Type
string Required
Description
the date that the record was deleted or null if not deleted
Name
deletedReason
Type
string Required
Description
the reason that the record was deleted

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

PATCH

/v3/inventory_tire/template/:id/:action

curl https://api.shopmonkey.cloud/v3/inventory_tire/template/:id/:action \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X PATCH -H 'Content-Type: application/json' \
  --data '{ "reason" : "value" }'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "name": "name",
    "note": null,
    "pricingMatrixTemplateId": null,
    "retailCostCents": 1,
    "wholesaleCostCents": null,
    "sizeFormat": "sizeFormat",
    "size": null,
    "partNumber": null,
    "normalizedPartNumber": null,
    "sku": null,
    "normalizedSKU": null,
    "taxable": true,
    "taxableGST": true,
    "taxableHST": true,
    "taxablePST": true,
    "federalExciseTaxCents": 1,
    "wasteTireFeeCents": 1,
    "inventoryNumber": null,
    "tireModelTemplateId": "tireModelTemplateId",
    "url": null,
    "categoryType": null,
    "loadRange": null,
    "serviceType": null,
    "construction": null,
    "isStudded": true,
    "isRunFlat": true,
    "sectionWidthUnit": "sectionWidthUnit",
    "sectionWidthValue": null,
    "sidewallAspectValue": null,
    "wheelDiameterUnit": "wheelDiameterUnit",
    "wheelDiameterValue": null,
    "loadIndex": null,
    "speedRating": null,
    "outerDiameterUnit": "outerDiameterUnit",
    "outerDiameterValue": null,
    "treadDepthUnit": "treadDepthUnit",
    "treadDepthValue": null,
    "maxTirePressurePSI": null,
    "traction_UTQG": null,
    "temperature_UTQG": null,
    "treadWear_UTQG": null,
    "deleted": true,
    "deletedUserId": null,
    "deletedDate": null,
    "deletedReason": null
  }
}

DELETE/v3/inventory_tire/template/:id

Delete Inventory Tire Template

Delete one Inventory Tire Template by id

URL parameters

Name
id
Type
string Required
Description
the id for the object to delete

Produces

The response content type: application/json

`200` Response

Name
data
Type
object
Description
Name
success
Type
boolean Required
Description

Properties for `data` object

Name
id
Type
string Required
Description
the id for the object

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
object
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

DELETE

/v3/inventory_tire/template/:id

curl https://api.shopmonkey.cloud/v3/inventory_tire/template/:id \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X DELETE -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "success": true
}

Inventory Tire

URL parameters

Produces

200 Response

Properties for data object

Properties for meta object

Properties for tireModel object

Properties for brand object

Properties for category object

Properties for parent object

Properties for vendor object

4xx Response

5xx Response

Example Request

Example Responseapplication/json

Query String parameters

Produces

200 Response

Properties for meta object

4xx Response

5xx Response

Example Request

Example Responseapplication/json

Produces

200 Response

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

Body parameters

Consumes

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

URL parameters

Body parameters

Consumes

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

URL parameters

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

URL parameters

Body parameters

Consumes

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

Body parameters

Consumes

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

URL parameters

Produces

200 Response

Properties for data object

Properties for meta object

`200` Response

Properties for `data` object

Properties for `meta` object

Properties for `tireModel` object

Properties for `brand` object

Properties for `category` object

Properties for `parent` object

Properties for `vendor` object

`4xx` Response

`5xx` Response

Example Response
application/json

`200` Response

Properties for `meta` object

`4xx` Response

`5xx` Response

Example Response
application/json

`200` Response

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `data` object

Properties for `meta` object

Properties for `tireModelTemplate` object

Properties for `brandTemplate` object

Properties for `categoryTemplate` object

Properties for `parent` object

Properties for `vendorTemplate` object

`4xx` Response

`5xx` Response

Example Response
application/json

`200` Response

Properties for `meta` object

`4xx` Response

`5xx` Response

Example Response
application/json

`200` Response

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `data` object