Inventory Part
WIP: A summary needs to be written for Inventory Part
Find Inventory Part
Find one Inventory Part 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
- InventoryPart 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
locationId
- Type
- string Required
- Description
- Name
inventoryPartTemplateId
- Type
- string Required
- Description
- /// This is explicitly not a foreign key to persist this connection for consumer processing after inventory part template deletion
- Name
name
- Type
- string Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
categoryId
- Type
- string Required
- Description
- Name
vendorId
- Type
- string Required
- Description
- Name
pricingMatrixId
- Type
- string Required
- Description
- Name
templatePhotoBlobId
- Type
- string 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
otherLocationsAvailableQuantity
- Type
- integer Required
- Description
- Name
reorderQuantity
- Type
- number Required
- Description
- Name
number
- 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
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
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
showNote
- Type
- boolean Required
- Description
- show note on estimate & invoice ///
- Name
showPartNumber
- Type
- boolean Required
- Description
- show number on estimate & invoice ///
- Name
showCostAndQuantity
- Type
- boolean Required
- Description
- show cost/quantity on estimate & invoice ///
- Name
brandId
- Type
- string Required
- Description
- Name
pricingMatrixDate
- Type
- string Required
- Description
- datetime when pricingMatrixId was set, for determining if matrix has been changed
- 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 marked for deletion because of the template being deleted
- Name
computed_fullText
- Type
- string Required
- Description
- Name
url
- Type
- string Required
- Description
- Name
userId
- Type
- string Required
- Description
- Name
type
- Type
- string Required
- Description
- Name
specification
- Type
- object
- Description
- Name
matchType
- Type
- one of: 'ExactMatch', 'NoMatch', 'PartialMatch'
- Description
- Name
brand
- Type
- object Required
- Description
- Brand schema
- Name
category
- Type
- one of: any, any Required
- Description
- Name
location
- Type
- object
- Description
- Location schema
- Name
photo
- Type
- boolean Required
- Description
- true if the part has a photo
- Name
vendor
- Type
- object Required
- Description
- Vendor 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 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 location
object
- Name
id
- Type
- string Required
- Description
- Name
name
- Type
- string Required
- Description
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
- undefined
- 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
- undefined
- 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
curl https://api.shopmonkey.cloud/v3/inventory_part/ID \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"meta": {
"userId": "userId",
"sessionId": "sessionId",
"version": 1
},
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": null,
"categoryId": null,
"vendorId": null,
"quantity": 1,
"number": "number",
"binLocation": null,
"retailCostCents": 1,
"wholesaleCostCents": 1,
"taxable": true,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"userId": null
}
}
Search Inventory Part entities
Search for Inventory Part Entries
Body parameters
Consumes
The following content type is required: application/json
- Name
limit
- Type
- number
- Description
- the limit on the number of records to return
- Name
orderBy
- Type
- one of: any, any
- Description
- the order instructions for the result
- Name
params
- Type
- undefined
- Description
- additonal request specific params
- Name
skip
- Type
- number
- Description
- the number of records to skip for a paginated result
- Name
where
- Type
- one of: any, any
- 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
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
- undefined
- 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
- undefined
- 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 Requestapplication/json
curl https://api.shopmonkey.cloud/v3/inventory_part/search \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"data": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"inventoryPartTemplateId": null,
"name": "name",
"note": null,
"categoryId": null,
"vendorId": null,
"pricingMatrixId": null,
"templatePhotoBlobId": null,
"minCriticalQuantity": null,
"maxCriticalQuantity": null,
"quantity": 1,
"onEstimateQuantity": 1,
"reservedQuantity": 1,
"availableQuantity": 1,
"otherLocationsAvailableQuantity": 1,
"reorderQuantity": 1,
"number": null,
"normalizedPartNumber": null,
"sku": null,
"normalizedSKU": null,
"binLocation": null,
"retailCostCents": 1,
"wholesaleCostCents": null,
"taxable": true,
"taxableGST": true,
"taxableHST": true,
"taxablePST": true,
"showNote": true,
"showPartNumber": true,
"showCostAndQuantity": true,
"brandId": null,
"pricingMatrixDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"computed_fullText": null,
"url": null,
"userId": null,
"type": null,
"brand": {
"id": "id",
"name": "name"
},
"location": {
"id": "id",
"name": "name"
},
"photo": true,
"vendor": {
"id": "id",
"name": "name"
}
}
],
"meta": {
"totalCost": 1,
"totalQuantity": 1,
"totalValue": 1,
"hasMore": true,
"total": 1
},
"success": true
}
Search Inventory Part entities
Search for Inventory Part 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
- undefined
- 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
- undefined
- 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 Requestapplication/json
curl https://api.shopmonkey.cloud/v3/inventory_part/search_other_locations \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"data": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"inventoryPartTemplateId": null,
"name": "name",
"note": null,
"categoryId": null,
"vendorId": null,
"pricingMatrixId": null,
"templatePhotoBlobId": null,
"minCriticalQuantity": null,
"maxCriticalQuantity": null,
"quantity": 1,
"onEstimateQuantity": 1,
"reservedQuantity": 1,
"availableQuantity": 1,
"otherLocationsAvailableQuantity": 1,
"reorderQuantity": 1,
"number": null,
"normalizedPartNumber": null,
"sku": null,
"normalizedSKU": null,
"binLocation": null,
"retailCostCents": 1,
"wholesaleCostCents": null,
"taxable": true,
"taxableGST": true,
"taxableHST": true,
"taxablePST": true,
"showNote": true,
"showPartNumber": true,
"showCostAndQuantity": true,
"brandId": null,
"pricingMatrixDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"computed_fullText": null,
"url": null,
"userId": null,
"type": null,
"brand": {
"id": "id",
"name": "name"
},
"location": {
"id": "id",
"name": "name"
},
"photo": true,
"vendor": {
"id": "id",
"name": "name"
}
}
],
"meta": {
"totalCost": 1,
"totalQuantity": 1,
"totalValue": 1,
"hasMore": true,
"total": 1
},
"success": true
}
Create Inventory Part
Create one Inventory Part
Body parameters
Consumes
The following content type is required: application/json
- Name
name
- Type
- string Required
- Description
- Name
note
- Type
- string
- Description
- Name
categoryId
- Type
- string
- Description
- Name
vendorId
- Type
- string
- Description
- Name
pricingMatrixId
- Type
- string
- Description
- Name
minCriticalQuantity
- Type
- number
- Description
- Name
maxCriticalQuantity
- Type
- number
- Description
- Name
quantity
- Type
- number
- Description
- Name
otherLocationsAvailableQuantity
- Type
- integer
- Description
- Name
number
- Type
- string
- Description
- Name
sku
- Type
- string
- Description
- Name
binLocation
- Type
- string
- Description
- Name
retailCostCents
- Type
- integer
- Description
- Name
wholesaleCostCents
- Type
- integer
- Description
- Name
suggestedRetailCostCents
- Type
- integer
- 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
showNote
- Type
- boolean
- Description
- show note on estimate & invoice ///
- Name
showPartNumber
- Type
- boolean
- Description
- show number on estimate & invoice ///
- Name
showCostAndQuantity
- Type
- boolean
- Description
- show cost/quantity on estimate & invoice ///
- Name
brandId
- Type
- string
- 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 marked for deletion because of the template being deleted
- Name
url
- Type
- string
- Description
- Name
userId
- Type
- string
- Description
- Name
type
- Type
- string
- Description
- Name
specification
- Type
- object
- 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
- InventoryPart 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
locationId
- Type
- string Required
- Description
- Name
inventoryPartTemplateId
- Type
- string Required
- Description
- /// This is explicitly not a foreign key to persist this connection for consumer processing after inventory part template deletion
- Name
name
- Type
- string Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
categoryId
- Type
- string Required
- Description
- Name
vendorId
- Type
- string Required
- Description
- Name
pricingMatrixId
- Type
- string Required
- Description
- Name
templatePhotoBlobId
- Type
- string 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
otherLocationsAvailableQuantity
- Type
- integer Required
- Description
- Name
reorderQuantity
- Type
- number Required
- Description
- Name
number
- 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
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
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
showNote
- Type
- boolean Required
- Description
- show note on estimate & invoice ///
- Name
showPartNumber
- Type
- boolean Required
- Description
- show number on estimate & invoice ///
- Name
showCostAndQuantity
- Type
- boolean Required
- Description
- show cost/quantity on estimate & invoice ///
- Name
brandId
- Type
- string Required
- Description
- Name
pricingMatrixDate
- Type
- string Required
- Description
- datetime when pricingMatrixId was set, for determining if matrix has been changed
- 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 marked for deletion because of the template being deleted
- Name
computed_fullText
- Type
- string Required
- Description
- Name
url
- Type
- string Required
- Description
- Name
userId
- Type
- string Required
- Description
- Name
type
- Type
- string Required
- Description
- Name
specification
- Type
- object
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- 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
- undefined
- 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 Requestapplication/json
curl https://api.shopmonkey.cloud/v3/inventory_part \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{ "name" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"note": null,
"categoryId": null,
"vendorId": null,
"quantity": 1,
"number": "number",
"binLocation": null,
"retailCostCents": 1,
"wholesaleCostCents": 1,
"taxable": true,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"userId": null
}
}
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
categoryId
- Type
- string
- Description
- Name
vendorId
- Type
- string
- Description
- Name
pricingMatrixId
- Type
- string
- Description
- Name
minCriticalQuantity
- Type
- number
- Description
- Name
maxCriticalQuantity
- Type
- number
- Description
- Name
quantity
- Type
- number
- Description
- Name
otherLocationsAvailableQuantity
- Type
- integer
- Description
- Name
number
- Type
- string
- Description
- Name
sku
- Type
- string
- Description
- Name
binLocation
- Type
- string
- Description
- Name
retailCostCents
- Type
- integer
- Description
- Name
wholesaleCostCents
- Type
- integer
- Description
- Name
suggestedRetailCostCents
- Type
- integer
- 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
showNote
- Type
- boolean
- Description
- show note on estimate & invoice ///
- Name
showPartNumber
- Type
- boolean
- Description
- show number on estimate & invoice ///
- Name
showCostAndQuantity
- Type
- boolean
- Description
- show cost/quantity on estimate & invoice ///
- Name
brandId
- Type
- string
- 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 marked for deletion because of the template being deleted
- Name
url
- Type
- string
- Description
- Name
userId
- Type
- string
- Description
- Name
type
- Type
- string
- Description
- Name
specification
- Type
- object
- Description
- 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
- InventoryPart 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
locationId
- Type
- string Required
- Description
- Name
inventoryPartTemplateId
- Type
- string Required
- Description
- /// This is explicitly not a foreign key to persist this connection for consumer processing after inventory part template deletion
- Name
name
- Type
- string Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
categoryId
- Type
- string Required
- Description
- Name
vendorId
- Type
- string Required
- Description
- Name
pricingMatrixId
- Type
- string Required
- Description
- Name
templatePhotoBlobId
- Type
- string 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
otherLocationsAvailableQuantity
- Type
- integer Required
- Description
- Name
reorderQuantity
- Type
- number Required
- Description
- Name
number
- 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
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
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
showNote
- Type
- boolean Required
- Description
- show note on estimate & invoice ///
- Name
showPartNumber
- Type
- boolean Required
- Description
- show number on estimate & invoice ///
- Name
showCostAndQuantity
- Type
- boolean Required
- Description
- show cost/quantity on estimate & invoice ///
- Name
brandId
- Type
- string Required
- Description
- Name
pricingMatrixDate
- Type
- string Required
- Description
- datetime when pricingMatrixId was set, for determining if matrix has been changed
- 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 marked for deletion because of the template being deleted
- Name
computed_fullText
- Type
- string Required
- Description
- Name
url
- Type
- string Required
- Description
- Name
userId
- Type
- string Required
- Description
- Name
type
- Type
- string Required
- Description
- Name
specification
- Type
- object
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- 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
- undefined
- 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 Requestapplication/json
curl https://api.shopmonkey.cloud/v3/inventory_part/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true
}
Delete Inventory Part
Delete one Inventory Part 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
- undefined
- 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
- undefined
- 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 Requestapplication/json
curl https://api.shopmonkey.cloud/v3/inventory_part/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X DELETE -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true
}
Soft Delete Inventory Part
Soft delete or undelete a Inventory Part 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
- InventoryPart 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
locationId
- Type
- string Required
- Description
- Name
inventoryPartTemplateId
- Type
- string Required
- Description
- /// This is explicitly not a foreign key to persist this connection for consumer processing after inventory part template deletion
- Name
name
- Type
- string Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
categoryId
- Type
- string Required
- Description
- Name
vendorId
- Type
- string Required
- Description
- Name
pricingMatrixId
- Type
- string Required
- Description
- Name
templatePhotoBlobId
- Type
- string 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
otherLocationsAvailableQuantity
- Type
- integer Required
- Description
- Name
reorderQuantity
- Type
- number Required
- Description
- Name
number
- 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
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
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
showNote
- Type
- boolean Required
- Description
- show note on estimate & invoice ///
- Name
showPartNumber
- Type
- boolean Required
- Description
- show number on estimate & invoice ///
- Name
showCostAndQuantity
- Type
- boolean Required
- Description
- show cost/quantity on estimate & invoice ///
- Name
brandId
- Type
- string Required
- Description
- Name
pricingMatrixDate
- Type
- string Required
- Description
- datetime when pricingMatrixId was set, for determining if matrix has been changed
- 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 marked for deletion because of the template being deleted
- Name
computed_fullText
- Type
- string Required
- Description
- Name
url
- Type
- string Required
- Description
- Name
userId
- Type
- string Required
- Description
- Name
type
- Type
- string Required
- Description
- Name
specification
- Type
- object
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- 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
- undefined
- 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 Requestapplication/json
curl https://api.shopmonkey.cloud/v3/inventory_part/ID/ACTION \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PATCH -H 'Content-Type: application/json' \
--data '{ "reason" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"locationId": "locationId",
"name": "name",
"note": null,
"categoryId": null,
"vendorId": null,
"quantity": 1,
"number": "number",
"binLocation": null,
"retailCostCents": 1,
"wholesaleCostCents": 1,
"taxable": true,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"userId": null
}
}
Import entities
Import one or more entities
Body parameters
Consumes
The following content type is required: multipart/form-data
- Name
entityType
- Type
- object
- Description
- Name
file
- Type
- undefined Required
- Description
- a multipart mime data payload in Microsoft Excel (xlsx) format
Properties for entityType
object
- Name
value
- Type
- string Required
- Description
- the entity name to import data to
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
Properties for data
object
- Name
added
- Type
- number Required
- Description
- number of records created
- Name
updated
- Type
- number Required
- Description
- number of records updated
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- 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
- undefined
- 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 Requestmultipart/form-data
curl https://api.shopmonkey.cloud/v3/inventory_part/import \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: multipart/form-data' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"added": 1,
"updated": 1
}
}
Inventory Part count from Other Locations by SKU
Get other company location's availability for a specific Inventory Part by SKU
URL parameters
- Name
sku
- Type
- string Required
- Description
- the SKU of the Inventory Part
Produces
The response content type: application/json
200
Response
- Name
data
- Type
- array Required
- Description
- Name
meta
- Type
- object Required
- Description
- Name
success
- Type
- boolean Required
- Description
Properties for meta
object
- Name
total
- Type
- number Required
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- 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
- undefined
- 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
curl https://api.shopmonkey.cloud/v3/inventory_part/SKU/availability \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"data": [
{
"location": {
"id": "id",
"name": "name"
},
"part": {
"id": "id",
"name": "name",
"availableQuantity": 1,
"normalizedPartNumber": null,
"normalizedSKU": null
}
}
],
"meta": {
"total": 1
},
"success": true
}
Import Inventory Part from another location
Imports the inventory part's information to another location other than quantity and pricing matrix data. The inventory part must be from a different location than the current context location.
URL parameters
- Name
id
- Type
- string Required
- Description
- the id of the Inventory Part
Produces
The response content type: application/json
200
Response
- 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
locationId
- Type
- string Required
- Description
- Name
inventoryPartTemplateId
- Type
- string Required
- Description
- /// This is explicitly not a foreign key to persist this connection for consumer processing after inventory part template deletion
- Name
name
- Type
- string Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
categoryId
- Type
- string Required
- Description
- Name
vendorId
- Type
- string Required
- Description
- Name
pricingMatrixId
- Type
- string Required
- Description
- Name
templatePhotoBlobId
- Type
- string 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
otherLocationsAvailableQuantity
- Type
- integer Required
- Description
- Name
reorderQuantity
- Type
- number Required
- Description
- Name
number
- 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
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
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
showNote
- Type
- boolean Required
- Description
- show note on estimate & invoice ///
- Name
showPartNumber
- Type
- boolean Required
- Description
- show number on estimate & invoice ///
- Name
showCostAndQuantity
- Type
- boolean Required
- Description
- show cost/quantity on estimate & invoice ///
- Name
brandId
- Type
- string Required
- Description
- Name
pricingMatrixDate
- Type
- string Required
- Description
- datetime when pricingMatrixId was set, for determining if matrix has been changed
- 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 marked for deletion because of the template being deleted
- Name
computed_fullText
- Type
- string Required
- Description
- Name
url
- Type
- string Required
- Description
- Name
userId
- Type
- string Required
- Description
- Name
type
- Type
- string Required
- Description
- Name
specification
- Type
- object
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- 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
- undefined
- 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 Requestapplication/json
curl https://api.shopmonkey.cloud/v3/inventory_part/ID/import \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"inventoryPartTemplateId": null,
"name": "name",
"note": null,
"categoryId": null,
"vendorId": null,
"pricingMatrixId": null,
"templatePhotoBlobId": null,
"minCriticalQuantity": null,
"maxCriticalQuantity": null,
"quantity": 1,
"onEstimateQuantity": 1,
"reservedQuantity": 1,
"availableQuantity": 1,
"otherLocationsAvailableQuantity": 1,
"reorderQuantity": 1,
"number": null,
"normalizedPartNumber": null,
"sku": null,
"normalizedSKU": null,
"binLocation": null,
"retailCostCents": 1,
"wholesaleCostCents": null,
"taxable": true,
"taxableGST": true,
"taxableHST": true,
"taxablePST": true,
"showNote": true,
"showPartNumber": true,
"showCostAndQuantity": true,
"brandId": null,
"pricingMatrixDate": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"computed_fullText": null,
"url": null,
"userId": null,
"type": null
}
Get the ID, name, and soft deleted state of an existing Inventory Part if the SKU matches
Check if an existing inventory part was soft deleted with the same SKU, also returning that part's ID and name
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
deleted
- Type
- boolean Required
- Description
- 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
- undefined
- 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
- undefined
- 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 Requestapplication/json
curl https://api.shopmonkey.cloud/v3/inventory_part/sku_exists \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{ "sku" : "value" }'
Example Responseapplication/json
{
"data": {
"deleted": true,
"id": "id",
"name": "name"
},
"success": true
}
Find
Find one 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
- 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
brandTemplateId
- Type
- string Required
- Description
- Name
categoryTemplateId
- Type
- string Required
- Description
- Name
pricingMatrixTemplateId
- Type
- string Required
- Description
- Name
vendorTemplateId
- Type
- string Required
- Description
- Name
type
- Type
- string Required
- Description
- Name
name
- Type
- string Required
- Description
- Name
number
- Type
- string Required
- Description
- Name
normalizedPartNumber
- Type
- string Required
- Description
- Name
sku
- Type
- string Required
- Description
- Name
normalizedSKU
- Type
- string Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
url
- Type
- string Required
- Description
- Name
retailCostCents
- Type
- integer Required
- Description
- Name
wholesaleCostCents
- Type
- integer Required
- Description
- Name
suggestedRetailCostCents
- Type
- integer 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
specification
- Type
- object
- 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
brandTemplate
- Type
- object Required
- Description
- BrandTemplate schema
- Name
categoryTemplate
- Type
- object Required
- Description
- Name
deletedUser
- Type
- object Required
- Description
- User schema
- Name
photo
- Type
- boolean Required
- Description
- true if the part has a photo
- Name
pricingMatrixTemplate
- Type
- object Required
- Description
- PricingMatrixTemplate schema
- Name
vendorTemplate
- Type
- object Required
- Description
- VendorTemplate 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 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 deletedUser
object
- Name
id
- Type
- string Required
- Description
- Name
firstName
- Type
- string Required
- Description
- Name
lastName
- Type
- string Required
- Description
Properties for pricingMatrixTemplate
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
- undefined
- 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
- undefined
- 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
curl https://api.shopmonkey.cloud/v3/inventory_part/template/ID \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"data": {
"id": "id",
"meta": {
"userId": "userId",
"sessionId": "sessionId",
"version": 1
},
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"brandTemplateId": null,
"categoryTemplateId": null,
"pricingMatrixTemplateId": null,
"vendorTemplateId": null,
"type": null,
"name": "name",
"number": null,
"normalizedPartNumber": null,
"sku": null,
"normalizedSKU": null,
"note": null,
"url": null,
"retailCostCents": 1,
"wholesaleCostCents": null,
"taxable": true,
"taxableGST": true,
"taxableHST": true,
"taxablePST": true,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"brandTemplate": {
"id": "id",
"name": "name"
},
"categoryTemplate": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"photo": true,
"vendorTemplate": {
"id": "id",
"name": "name"
}
},
"success": true
}
List s
Find all s
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
- undefined
- 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
- undefined
- 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
curl https://api.shopmonkey.cloud/v3/inventory_part/template \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"data": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"brandTemplateId": null,
"categoryTemplateId": null,
"pricingMatrixTemplateId": null,
"vendorTemplateId": null,
"type": null,
"name": "name",
"number": null,
"normalizedPartNumber": null,
"sku": null,
"normalizedSKU": null,
"note": null,
"url": null,
"retailCostCents": 1,
"wholesaleCostCents": null,
"taxable": true,
"taxableGST": true,
"taxableHST": true,
"taxablePST": true,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"brandTemplate": {
"id": "id",
"name": "name"
},
"categoryTemplate": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"photo": true,
"vendorTemplate": {
"id": "id",
"name": "name"
}
}
],
"success": true
}
Search entities
Search for 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
- undefined
- 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
- undefined
- 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 Requestapplication/json
curl https://api.shopmonkey.cloud/v3/inventory_part/template/search \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"data": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"brandTemplateId": null,
"categoryTemplateId": null,
"pricingMatrixTemplateId": null,
"vendorTemplateId": null,
"type": null,
"name": "name",
"number": null,
"normalizedPartNumber": null,
"sku": null,
"normalizedSKU": null,
"note": null,
"url": null,
"retailCostCents": 1,
"wholesaleCostCents": null,
"taxable": true,
"taxableGST": true,
"taxableHST": true,
"taxablePST": true,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"brandTemplate": {
"id": "id",
"name": "name"
},
"categoryTemplate": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
},
"photo": true,
"vendorTemplate": {
"id": "id",
"name": "name"
}
}
],
"success": true
}
Create Inventory Part Template
Create one Inventory Part Template
Body parameters
Consumes
The following content type is required: application/json
- Name
brandTemplateId
- Type
- string
- Description
- Name
categoryTemplateId
- Type
- string
- Description
- Name
pricingMatrixTemplateId
- Type
- string
- Description
- Name
vendorTemplateId
- Type
- string
- Description
- Name
type
- Type
- string
- Description
- Name
name
- Type
- string Required
- Description
- Name
number
- Type
- string
- Description
- Name
sku
- Type
- string
- Description
- Name
note
- Type
- string
- Description
- Name
url
- Type
- string
- Description
- Name
retailCostCents
- Type
- integer
- Description
- Name
wholesaleCostCents
- Type
- integer
- Description
- Name
suggestedRetailCostCents
- Type
- integer
- 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
specification
- Type
- object
- 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
- InventoryPartTemplate 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
brandTemplateId
- Type
- string Required
- Description
- Name
categoryTemplateId
- Type
- string Required
- Description
- Name
pricingMatrixTemplateId
- Type
- string Required
- Description
- Name
vendorTemplateId
- Type
- string Required
- Description
- Name
type
- Type
- string Required
- Description
- Name
name
- Type
- string Required
- Description
- Name
number
- Type
- string Required
- Description
- Name
normalizedPartNumber
- Type
- string Required
- Description
- Name
sku
- Type
- string Required
- Description
- Name
normalizedSKU
- Type
- string Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
url
- Type
- string Required
- Description
- Name
retailCostCents
- Type
- integer Required
- Description
- Name
wholesaleCostCents
- Type
- integer Required
- Description
- Name
suggestedRetailCostCents
- Type
- integer 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
specification
- Type
- object
- 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
- undefined
- 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
- undefined
- 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 Requestapplication/json
curl https://api.shopmonkey.cloud/v3/inventory_part/template \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{ "name" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"brandTemplateId": null,
"categoryTemplateId": null,
"pricingMatrixTemplateId": null,
"vendorTemplateId": null,
"type": null,
"name": "name",
"number": null,
"normalizedPartNumber": null,
"sku": null,
"normalizedSKU": null,
"note": null,
"url": null,
"retailCostCents": 1,
"wholesaleCostCents": null,
"taxable": true,
"taxableGST": true,
"taxableHST": true,
"taxablePST": true,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null
}
}
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
brandTemplateId
- Type
- string
- Description
- Name
categoryTemplateId
- Type
- string
- Description
- Name
pricingMatrixTemplateId
- Type
- string
- Description
- Name
vendorTemplateId
- Type
- string
- Description
- Name
type
- Type
- string
- Description
- Name
name
- Type
- string
- Description
- Name
number
- Type
- string
- Description
- Name
sku
- Type
- string
- Description
- Name
note
- Type
- string
- Description
- Name
url
- Type
- string
- Description
- Name
retailCostCents
- Type
- integer
- Description
- Name
wholesaleCostCents
- Type
- integer
- Description
- Name
suggestedRetailCostCents
- Type
- integer
- 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
specification
- Type
- object
- 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
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
- InventoryPartTemplate 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
brandTemplateId
- Type
- string Required
- Description
- Name
categoryTemplateId
- Type
- string Required
- Description
- Name
pricingMatrixTemplateId
- Type
- string Required
- Description
- Name
vendorTemplateId
- Type
- string Required
- Description
- Name
type
- Type
- string Required
- Description
- Name
name
- Type
- string Required
- Description
- Name
number
- Type
- string Required
- Description
- Name
normalizedPartNumber
- Type
- string Required
- Description
- Name
sku
- Type
- string Required
- Description
- Name
normalizedSKU
- Type
- string Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
url
- Type
- string Required
- Description
- Name
retailCostCents
- Type
- integer Required
- Description
- Name
wholesaleCostCents
- Type
- integer Required
- Description
- Name
suggestedRetailCostCents
- Type
- integer 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
specification
- Type
- object
- 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
- undefined
- 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
- undefined
- 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 Requestapplication/json
curl https://api.shopmonkey.cloud/v3/inventory_part/template/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"brandTemplateId": null,
"categoryTemplateId": null,
"pricingMatrixTemplateId": null,
"vendorTemplateId": null,
"type": null,
"name": "name",
"number": null,
"normalizedPartNumber": null,
"sku": null,
"normalizedSKU": null,
"note": null,
"url": null,
"retailCostCents": 1,
"wholesaleCostCents": null,
"taxable": true,
"taxableGST": true,
"taxableHST": true,
"taxablePST": true,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null
}
}
Soft Delete Inventory Part Template
Soft delete or undelete a Inventory Part 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
- InventoryPartTemplate 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
brandTemplateId
- Type
- string Required
- Description
- Name
categoryTemplateId
- Type
- string Required
- Description
- Name
pricingMatrixTemplateId
- Type
- string Required
- Description
- Name
vendorTemplateId
- Type
- string Required
- Description
- Name
type
- Type
- string Required
- Description
- Name
name
- Type
- string Required
- Description
- Name
number
- Type
- string Required
- Description
- Name
normalizedPartNumber
- Type
- string Required
- Description
- Name
sku
- Type
- string Required
- Description
- Name
normalizedSKU
- Type
- string Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
url
- Type
- string Required
- Description
- Name
retailCostCents
- Type
- integer Required
- Description
- Name
wholesaleCostCents
- Type
- integer Required
- Description
- Name
suggestedRetailCostCents
- Type
- integer 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
specification
- Type
- object
- 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
- undefined
- 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
- undefined
- 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 Requestapplication/json
curl https://api.shopmonkey.cloud/v3/inventory_part/template/ID/ACTION \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PATCH -H 'Content-Type: application/json' \
--data '{ "reason" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"brandTemplateId": null,
"categoryTemplateId": null,
"pricingMatrixTemplateId": null,
"vendorTemplateId": null,
"type": null,
"name": "name",
"number": null,
"normalizedPartNumber": null,
"sku": null,
"normalizedSKU": null,
"note": null,
"url": null,
"retailCostCents": 1,
"wholesaleCostCents": null,
"taxable": true,
"taxableGST": true,
"taxableHST": true,
"taxablePST": true,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null
}
}
Delete Inventory Part Template
Delete one Inventory Part 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
- undefined
- 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
- undefined
- 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 Requestapplication/json
curl https://api.shopmonkey.cloud/v3/inventory_part/template/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X DELETE -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true
}