Inventory Part

WIP: A summary needs to be written for Inventory Part

GET/v3/inventory_part/:id

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
availableQuantity
Type
number Required
Description
*100)/100
Name
binLocation
Type
string Required
Description
Name
brandId
Type
string Required
Description
Name
categoryId
Type
string Required
Description
Name
companyId
Type
string Required
Description
Name
computed_fullText
Type
string Required
Description
, '') || CASE WHEN (NULLIF(name, '') IS NOT NULL) AND (NULLIF(note, '') IS NOT NULL) THEN ' ' ELSE '' END) || COALESCE(lower(NULLIF(note, '')), '')) || CASE WHEN ((NULLIF(name, '') IS NOT NULL) OR (NULLIF(note, '') IS NOT NULL)) AND (NULLIF(number, '') IS NOT NULL) THEN ' ' ELSE '' END) || COALESCE(lower(NULLIF(number, '')), '')) || CASE WHEN (((NULLIF(name, '') IS NOT NULL) OR (NULLIF(note, '') IS NOT NULL)) OR (NULLIF(number, '') IS NOT NULL)) AND (NULLIF("binLocation", '') IS NOT NULL) THEN ' ' ELSE '' END) || COALESCE(lower(NULLIF("binLocation", '')), '')), ''
Name
createdDate
Type
string Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been 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
deletedUserId
Type
string Required
Description
the user that deleted the record or null if not deleted
Name
hasSetRetailCost
Type
boolean Required
Description
used to determine whether we should push updates to suggested retail cost down to retailCostCents
Name
id
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
locationId
Type
string Required
Description
Name
markedForDeletion
Type
boolean Required
Description
if the record is marked for deletion because of the template being deleted
Name
maxCriticalQuantity
Type
number 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
minCriticalQuantity
Type
number Required
Description
Name
name
Type
string Required
Description
Name
normalizedPartNumber
Type
string Required
Description
Name
normalizedSKU
Type
string Required
Description
Name
note
Type
string Required
Description
Name
number
Type
string Required
Description
Name
onEstimateQuantity
Type
number Required
Description
Name
otherLocationsAvailableQuantity
Type
number Required
Description
Name
pricingMatrixDate
Type
string Required
Description
datetime when pricingMatrixId was set, for determining if matrix has been changed
Name
pricingMatrixId
Type
string Required
Description
Name
quantity
Type
number Required
Description
Name
reorderQuantity
Type
number Required
Description
, 2) AS FLOAT8) ELSE 0.0 END
Name
reservedQuantity
Type
number Required
Description
Name
retailCostCents
Type
integer Required
Description
Name
showCostAndQuantity
Type
boolean Required
Description
Name
showNote
Type
boolean Required
Description
Name
showPartNumber
Type
boolean Required
Description
Name
sku
Type
string Required
Description
Name
specification
Type
object
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
templatePhotoBlobId
Type
string Required
Description
Name
type
Type
string Required
Description
Name
updatedDate
Type
string Required
Description
Name
url
Type
string Required
Description
Name
userId
Type
string Required
Description
Name
vendorId
Type
string Required
Description
Name
wholesaleCostCents
Type
integer Required
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
deleted
Type
boolean Required
Description
if the record has been deleted
Name
id
Type
string Required
Description
Name
name
Type
string Required
Description

Properties for `location` object

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

Properties for `vendor` object

Name
deleted
Type
boolean Required
Description
if the record has been deleted
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_part/:id

curl https://api.shopmonkey.cloud/v3/inventory_part/: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,
    "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
  }
}

POST/v3/inventory_part/search

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
object
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
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_part/search

curl https://api.shopmonkey.cloud/v3/inventory_part/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",
      "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
}

POST/v3/inventory_part/search_other_locations

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
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_part/search_other_locations

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

Example Response
application/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
}

POST/v3/inventory_part

Create Inventory Part

Create one Inventory Part

Body parameters

Consumes

The following content type is required: application/json

Name
binLocation
Type
string
Description
Name
brandId
Type
string
Description
Name
categoryId
Type
string
Description
Name
deleted
Type
boolean
Description
if the record has been deleted
Name
deletedReason
Type
string
Description
the reason that the record was deleted
Name
deletedUserId
Type
string
Description
the user that deleted the record or null if not deleted
Name
markedForDeletion
Type
boolean
Description
if the record is marked for deletion because of the template being deleted
Name
maxCriticalQuantity
Type
number
Description
Name
minCriticalQuantity
Type
number
Description
Name
name
Type
string Required
Description
Name
note
Type
string
Description
Name
number
Type
string
Description
Name
otherLocationsAvailableQuantity
Type
number
Description
Name
pricingMatrixId
Type
string
Description
Name
quantity
Type
number
Description
Name
retailCostCents
Type
integer
Description
Name
showCostAndQuantity
Type
boolean
Description
Name
showNote
Type
boolean
Description
Name
showPartNumber
Type
boolean
Description
Name
sku
Type
string
Description
Name
specification
Type
object
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
type
Type
string
Description
Name
url
Type
string
Description
Name
userId
Type
string
Description
Name
vendorId
Type
string
Description
Name
wholesaleCostCents
Type
integer
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
availableQuantity
Type
number Required
Description
*100)/100
Name
binLocation
Type
string Required
Description
Name
brandId
Type
string Required
Description
Name
categoryId
Type
string Required
Description
Name
companyId
Type
string Required
Description
Name
computed_fullText
Type
string Required
Description
, '') || CASE WHEN (NULLIF(name, '') IS NOT NULL) AND (NULLIF(note, '') IS NOT NULL) THEN ' ' ELSE '' END) || COALESCE(lower(NULLIF(note, '')), '')) || CASE WHEN ((NULLIF(name, '') IS NOT NULL) OR (NULLIF(note, '') IS NOT NULL)) AND (NULLIF(number, '') IS NOT NULL) THEN ' ' ELSE '' END) || COALESCE(lower(NULLIF(number, '')), '')) || CASE WHEN (((NULLIF(name, '') IS NOT NULL) OR (NULLIF(note, '') IS NOT NULL)) OR (NULLIF(number, '') IS NOT NULL)) AND (NULLIF("binLocation", '') IS NOT NULL) THEN ' ' ELSE '' END) || COALESCE(lower(NULLIF("binLocation", '')), '')), ''
Name
createdDate
Type
string Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been 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
deletedUserId
Type
string Required
Description
the user that deleted the record or null if not deleted
Name
hasSetRetailCost
Type
boolean Required
Description
used to determine whether we should push updates to suggested retail cost down to retailCostCents
Name
id
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
locationId
Type
string Required
Description
Name
markedForDeletion
Type
boolean Required
Description
if the record is marked for deletion because of the template being deleted
Name
maxCriticalQuantity
Type
number Required
Description
Name
minCriticalQuantity
Type
number Required
Description
Name
name
Type
string Required
Description
Name
normalizedPartNumber
Type
string Required
Description
Name
normalizedSKU
Type
string Required
Description
Name
note
Type
string Required
Description
Name
number
Type
string Required
Description
Name
onEstimateQuantity
Type
number Required
Description
Name
otherLocationsAvailableQuantity
Type
number Required
Description
Name
pricingMatrixDate
Type
string Required
Description
datetime when pricingMatrixId was set, for determining if matrix has been changed
Name
pricingMatrixId
Type
string Required
Description
Name
quantity
Type
number Required
Description
Name
reorderQuantity
Type
number Required
Description
, 2) AS FLOAT8) ELSE 0.0 END
Name
reservedQuantity
Type
number Required
Description
Name
retailCostCents
Type
integer Required
Description
Name
showCostAndQuantity
Type
boolean Required
Description
Name
showNote
Type
boolean Required
Description
Name
showPartNumber
Type
boolean Required
Description
Name
sku
Type
string Required
Description
Name
specification
Type
object
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
templatePhotoBlobId
Type
string Required
Description
Name
type
Type
string Required
Description
Name
updatedDate
Type
string Required
Description
Name
url
Type
string Required
Description
Name
userId
Type
string Required
Description
Name
vendorId
Type
string Required
Description
Name
wholesaleCostCents
Type
integer 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_part

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

Example Response
application/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
  }
}

PUT/v3/inventory_part/: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
binLocation
Type
string
Description
Name
brandId
Type
string
Description
Name
categoryId
Type
string
Description
Name
deleted
Type
boolean
Description
if the record has been deleted
Name
deletedReason
Type
string
Description
the reason that the record was deleted
Name
deletedUserId
Type
string
Description
the user that deleted the record or null if not deleted
Name
markedForDeletion
Type
boolean
Description
if the record is marked for deletion because of the template being deleted
Name
maxCriticalQuantity
Type
number
Description
Name
minCriticalQuantity
Type
number
Description
Name
name
Type
string
Description
Name
note
Type
string
Description
Name
number
Type
string
Description
Name
otherLocationsAvailableQuantity
Type
number
Description
Name
pricingMatrixId
Type
string
Description
Name
quantity
Type
number
Description
Name
retailCostCents
Type
integer
Description
Name
showCostAndQuantity
Type
boolean
Description
Name
showNote
Type
boolean
Description
Name
showPartNumber
Type
boolean
Description
Name
sku
Type
string
Description
Name
specification
Type
object
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
type
Type
string
Description
Name
url
Type
string
Description
Name
userId
Type
string
Description
Name
vendorId
Type
string
Description
Name
wholesaleCostCents
Type
integer
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
availableQuantity
Type
number Required
Description
*100)/100
Name
binLocation
Type
string Required
Description
Name
brandId
Type
string Required
Description
Name
categoryId
Type
string Required
Description
Name
companyId
Type
string Required
Description
Name
computed_fullText
Type
string Required
Description
, '') || CASE WHEN (NULLIF(name, '') IS NOT NULL) AND (NULLIF(note, '') IS NOT NULL) THEN ' ' ELSE '' END) || COALESCE(lower(NULLIF(note, '')), '')) || CASE WHEN ((NULLIF(name, '') IS NOT NULL) OR (NULLIF(note, '') IS NOT NULL)) AND (NULLIF(number, '') IS NOT NULL) THEN ' ' ELSE '' END) || COALESCE(lower(NULLIF(number, '')), '')) || CASE WHEN (((NULLIF(name, '') IS NOT NULL) OR (NULLIF(note, '') IS NOT NULL)) OR (NULLIF(number, '') IS NOT NULL)) AND (NULLIF("binLocation", '') IS NOT NULL) THEN ' ' ELSE '' END) || COALESCE(lower(NULLIF("binLocation", '')), '')), ''
Name
createdDate
Type
string Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been 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
deletedUserId
Type
string Required
Description
the user that deleted the record or null if not deleted
Name
hasSetRetailCost
Type
boolean Required
Description
used to determine whether we should push updates to suggested retail cost down to retailCostCents
Name
id
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
locationId
Type
string Required
Description
Name
markedForDeletion
Type
boolean Required
Description
if the record is marked for deletion because of the template being deleted
Name
maxCriticalQuantity
Type
number Required
Description
Name
minCriticalQuantity
Type
number Required
Description
Name
name
Type
string Required
Description
Name
normalizedPartNumber
Type
string Required
Description
Name
normalizedSKU
Type
string Required
Description
Name
note
Type
string Required
Description
Name
number
Type
string Required
Description
Name
onEstimateQuantity
Type
number Required
Description
Name
otherLocationsAvailableQuantity
Type
number Required
Description
Name
pricingMatrixDate
Type
string Required
Description
datetime when pricingMatrixId was set, for determining if matrix has been changed
Name
pricingMatrixId
Type
string Required
Description
Name
quantity
Type
number Required
Description
Name
reorderQuantity
Type
number Required
Description
, 2) AS FLOAT8) ELSE 0.0 END
Name
reservedQuantity
Type
number Required
Description
Name
retailCostCents
Type
integer Required
Description
Name
showCostAndQuantity
Type
boolean Required
Description
Name
showNote
Type
boolean Required
Description
Name
showPartNumber
Type
boolean Required
Description
Name
sku
Type
string Required
Description
Name
specification
Type
object
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
templatePhotoBlobId
Type
string Required
Description
Name
type
Type
string Required
Description
Name
updatedDate
Type
string Required
Description
Name
url
Type
string Required
Description
Name
userId
Type
string Required
Description
Name
vendorId
Type
string Required
Description
Name
wholesaleCostCents
Type
integer 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

PUT

/v3/inventory_part/:id

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

Example Response
application/json

{
  "success": true
}

DELETE/v3/inventory_part/:id

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
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_part/:id

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

Example Response
application/json

{
  "success": true
}

PATCH/v3/inventory_part/:id/:action

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
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
availableQuantity
Type
number Required
Description
*100)/100
Name
binLocation
Type
string Required
Description
Name
brandId
Type
string Required
Description
Name
categoryId
Type
string Required
Description
Name
companyId
Type
string Required
Description
Name
computed_fullText
Type
string Required
Description
, '') || CASE WHEN (NULLIF(name, '') IS NOT NULL) AND (NULLIF(note, '') IS NOT NULL) THEN ' ' ELSE '' END) || COALESCE(lower(NULLIF(note, '')), '')) || CASE WHEN ((NULLIF(name, '') IS NOT NULL) OR (NULLIF(note, '') IS NOT NULL)) AND (NULLIF(number, '') IS NOT NULL) THEN ' ' ELSE '' END) || COALESCE(lower(NULLIF(number, '')), '')) || CASE WHEN (((NULLIF(name, '') IS NOT NULL) OR (NULLIF(note, '') IS NOT NULL)) OR (NULLIF(number, '') IS NOT NULL)) AND (NULLIF("binLocation", '') IS NOT NULL) THEN ' ' ELSE '' END) || COALESCE(lower(NULLIF("binLocation", '')), '')), ''
Name
createdDate
Type
string Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been 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
deletedUserId
Type
string Required
Description
the user that deleted the record or null if not deleted
Name
hasSetRetailCost
Type
boolean Required
Description
used to determine whether we should push updates to suggested retail cost down to retailCostCents
Name
id
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
locationId
Type
string Required
Description
Name
markedForDeletion
Type
boolean Required
Description
if the record is marked for deletion because of the template being deleted
Name
maxCriticalQuantity
Type
number Required
Description
Name
minCriticalQuantity
Type
number Required
Description
Name
name
Type
string Required
Description
Name
normalizedPartNumber
Type
string Required
Description
Name
normalizedSKU
Type
string Required
Description
Name
note
Type
string Required
Description
Name
number
Type
string Required
Description
Name
onEstimateQuantity
Type
number Required
Description
Name
otherLocationsAvailableQuantity
Type
number Required
Description
Name
pricingMatrixDate
Type
string Required
Description
datetime when pricingMatrixId was set, for determining if matrix has been changed
Name
pricingMatrixId
Type
string Required
Description
Name
quantity
Type
number Required
Description
Name
reorderQuantity
Type
number Required
Description
, 2) AS FLOAT8) ELSE 0.0 END
Name
reservedQuantity
Type
number Required
Description
Name
retailCostCents
Type
integer Required
Description
Name
showCostAndQuantity
Type
boolean Required
Description
Name
showNote
Type
boolean Required
Description
Name
showPartNumber
Type
boolean Required
Description
Name
sku
Type
string Required
Description
Name
specification
Type
object
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
templatePhotoBlobId
Type
string Required
Description
Name
type
Type
string Required
Description
Name
updatedDate
Type
string Required
Description
Name
url
Type
string Required
Description
Name
userId
Type
string Required
Description
Name
vendorId
Type
string Required
Description
Name
wholesaleCostCents
Type
integer 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

PATCH

/v3/inventory_part/:id/:action

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

Example Response
application/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
  }
}

GET/v3/inventory_part/:sku/availability

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
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_part/:sku/availability

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

Example Response
application/json

{
  "data": [
    {
      "location": {
        "id": "id",
        "name": "name"
      },
      "part": {
        "id": "id",
        "name": "name",
        "availableQuantity": 1,
        "normalizedPartNumber": null,
        "normalizedSKU": null
      }
    }
  ],
  "meta": {
    "total": 1
  },
  "success": true
}

POST/v3/inventory_part/:id/import

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
availableQuantity
Type
number Required
Description
*100)/100
Name
binLocation
Type
string Required
Description
Name
brandId
Type
string Required
Description
Name
categoryId
Type
string Required
Description
Name
companyId
Type
string Required
Description
Name
computed_fullText
Type
string Required
Description
, '') || CASE WHEN (NULLIF(name, '') IS NOT NULL) AND (NULLIF(note, '') IS NOT NULL) THEN ' ' ELSE '' END) || COALESCE(lower(NULLIF(note, '')), '')) || CASE WHEN ((NULLIF(name, '') IS NOT NULL) OR (NULLIF(note, '') IS NOT NULL)) AND (NULLIF(number, '') IS NOT NULL) THEN ' ' ELSE '' END) || COALESCE(lower(NULLIF(number, '')), '')) || CASE WHEN (((NULLIF(name, '') IS NOT NULL) OR (NULLIF(note, '') IS NOT NULL)) OR (NULLIF(number, '') IS NOT NULL)) AND (NULLIF("binLocation", '') IS NOT NULL) THEN ' ' ELSE '' END) || COALESCE(lower(NULLIF("binLocation", '')), '')), ''
Name
createdDate
Type
string Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been 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
deletedUserId
Type
string Required
Description
the user that deleted the record or null if not deleted
Name
hasSetRetailCost
Type
boolean Required
Description
used to determine whether we should push updates to suggested retail cost down to retailCostCents
Name
id
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
locationId
Type
string Required
Description
Name
markedForDeletion
Type
boolean Required
Description
if the record is marked for deletion because of the template being deleted
Name
maxCriticalQuantity
Type
number Required
Description
Name
minCriticalQuantity
Type
number Required
Description
Name
name
Type
string Required
Description
Name
normalizedPartNumber
Type
string Required
Description
Name
normalizedSKU
Type
string Required
Description
Name
note
Type
string Required
Description
Name
number
Type
string Required
Description
Name
onEstimateQuantity
Type
number Required
Description
Name
otherLocationsAvailableQuantity
Type
number Required
Description
Name
pricingMatrixDate
Type
string Required
Description
datetime when pricingMatrixId was set, for determining if matrix has been changed
Name
pricingMatrixId
Type
string Required
Description
Name
quantity
Type
number Required
Description
Name
reorderQuantity
Type
number Required
Description
, 2) AS FLOAT8) ELSE 0.0 END
Name
reservedQuantity
Type
number Required
Description
Name
retailCostCents
Type
integer Required
Description
Name
showCostAndQuantity
Type
boolean Required
Description
Name
showNote
Type
boolean Required
Description
Name
showPartNumber
Type
boolean Required
Description
Name
sku
Type
string Required
Description
Name
specification
Type
object
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
templatePhotoBlobId
Type
string Required
Description
Name
type
Type
string Required
Description
Name
updatedDate
Type
string Required
Description
Name
url
Type
string Required
Description
Name
userId
Type
string Required
Description
Name
vendorId
Type
string Required
Description
Name
wholesaleCostCents
Type
integer 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_part/:id/import

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

Example Response
application/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
}

POST/v3/inventory_part/sku_exists

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
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_part/sku_exists

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

Example Response
application/json

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

GET/v3/inventory_part/template/:id

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
brandTemplateId
Type
string Required
Description
Name
categoryTemplateId
Type
string Required
Description
Name
companyId
Type
string Required
Description
Name
createdDate
Type
string Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been 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
deletedUserId
Type
string Required
Description
the user that deleted the record or null if not deleted
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
name
Type
string Required
Description
Name
normalizedPartNumber
Type
string Required
Description
Name
normalizedSKU
Type
string Required
Description
Name
note
Type
string Required
Description
Name
number
Type
string Required
Description
Name
pricingMatrixTemplateId
Type
string Required
Description
Name
retailCostCents
Type
integer Required
Description
Name
sku
Type
string Required
Description
Name
specification
Type
object
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
type
Type
string Required
Description
Name
updatedDate
Type
string Required
Description
Name
url
Type
string Required
Description
Name
vendorTemplateId
Type
string Required
Description
Name
wholesaleCostCents
Type
integer Required
Description
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
firstName
Type
string Required
Description
Name
id
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
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_part/template/:id

curl https://api.shopmonkey.cloud/v3/inventory_part/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",
    "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
}

GET/v3/inventory_part/template

List s

Find all s

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_part/template

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

Example Response
application/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
}

POST/v3/inventory_part/template/search

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
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_part/template/search

curl https://api.shopmonkey.cloud/v3/inventory_part/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",
      "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
}

POST/v3/inventory_part/template

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
deleted
Type
boolean
Description
if the record has been deleted
Name
deletedReason
Type
string
Description
the reason that the record was deleted
Name
deletedUserId
Type
string
Description
the user that deleted the record or null if not deleted
Name
name
Type
string Required
Description
Name
note
Type
string
Description
Name
number
Type
string
Description
Name
pricingMatrixTemplateId
Type
string
Description
Name
retailCostCents
Type
integer
Description
Name
sku
Type
string
Description
Name
specification
Type
object
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
type
Type
string
Description
Name
url
Type
string
Description
Name
vendorTemplateId
Type
string
Description
Name
wholesaleCostCents
Type
integer
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
brandTemplateId
Type
string Required
Description
Name
categoryTemplateId
Type
string Required
Description
Name
companyId
Type
string Required
Description
Name
createdDate
Type
string Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been 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
deletedUserId
Type
string Required
Description
the user that deleted the record or null if not deleted
Name
id
Type
string Required
Description
Name
name
Type
string Required
Description
Name
normalizedPartNumber
Type
string Required
Description
Name
normalizedSKU
Type
string Required
Description
Name
note
Type
string Required
Description
Name
number
Type
string Required
Description
Name
pricingMatrixTemplateId
Type
string Required
Description
Name
retailCostCents
Type
integer Required
Description
Name
sku
Type
string Required
Description
Name
specification
Type
object
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
type
Type
string Required
Description
Name
updatedDate
Type
string Required
Description
Name
url
Type
string Required
Description
Name
vendorTemplateId
Type
string Required
Description
Name
wholesaleCostCents
Type
integer 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_part/template

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

Example Response
application/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
  }
}

PUT/v3/inventory_part/template/: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
brandTemplateId
Type
string
Description
Name
categoryTemplateId
Type
string
Description
Name
deleted
Type
boolean
Description
if the record has been deleted
Name
deletedReason
Type
string
Description
the reason that the record was deleted
Name
deletedUserId
Type
string
Description
the user that deleted the record or null if not deleted
Name
name
Type
string
Description
Name
note
Type
string
Description
Name
number
Type
string
Description
Name
pricingMatrixTemplateId
Type
string
Description
Name
retailCostCents
Type
integer
Description
Name
sku
Type
string
Description
Name
specification
Type
object
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
type
Type
string
Description
Name
url
Type
string
Description
Name
vendorTemplateId
Type
string
Description
Name
wholesaleCostCents
Type
integer
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
InventoryPartTemplate schema

Properties for `data` object

Name
brandTemplateId
Type
string Required
Description
Name
categoryTemplateId
Type
string Required
Description
Name
companyId
Type
string Required
Description
Name
createdDate
Type
string Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been 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
deletedUserId
Type
string Required
Description
the user that deleted the record or null if not deleted
Name
id
Type
string Required
Description
Name
name
Type
string Required
Description
Name
normalizedPartNumber
Type
string Required
Description
Name
normalizedSKU
Type
string Required
Description
Name
note
Type
string Required
Description
Name
number
Type
string Required
Description
Name
pricingMatrixTemplateId
Type
string Required
Description
Name
retailCostCents
Type
integer Required
Description
Name
sku
Type
string Required
Description
Name
specification
Type
object
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
type
Type
string Required
Description
Name
updatedDate
Type
string Required
Description
Name
url
Type
string Required
Description
Name
vendorTemplateId
Type
string Required
Description
Name
wholesaleCostCents
Type
integer 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

PUT

/v3/inventory_part/template/:id

curl https://api.shopmonkey.cloud/v3/inventory_part/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",
    "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
  }
}

PATCH/v3/inventory_part/template/:id/:action

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
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
brandTemplateId
Type
string Required
Description
Name
categoryTemplateId
Type
string Required
Description
Name
companyId
Type
string Required
Description
Name
createdDate
Type
string Required
Description
Name
deleted
Type
boolean Required
Description
if the record has been 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
deletedUserId
Type
string Required
Description
the user that deleted the record or null if not deleted
Name
id
Type
string Required
Description
Name
name
Type
string Required
Description
Name
normalizedPartNumber
Type
string Required
Description
Name
normalizedSKU
Type
string Required
Description
Name
note
Type
string Required
Description
Name
number
Type
string Required
Description
Name
pricingMatrixTemplateId
Type
string Required
Description
Name
retailCostCents
Type
integer Required
Description
Name
sku
Type
string Required
Description
Name
specification
Type
object
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
type
Type
string Required
Description
Name
updatedDate
Type
string Required
Description
Name
url
Type
string Required
Description
Name
vendorTemplateId
Type
string Required
Description
Name
wholesaleCostCents
Type
integer 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

PATCH

/v3/inventory_part/template/:id/:action

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

Example Response
application/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/v3/inventory_part/template/:id

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
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_part/template/:id

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

Example Response
application/json

{
  "success": true
}

Inventory Part

URL parameters

Produces

200 Response

Properties for data object

Properties for meta object

Properties for brand object

Properties for location object

Properties for vendor object

4xx Response

5xx Response

Example Request

Example Responseapplication/json

Body parameters

Consumes

Produces

200 Response

4xx Response

5xx Response

Example Requestapplication/json

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

URL parameters

Produces

200 Response

Properties for meta object

4xx Response

5xx Response

Example Request

Example Responseapplication/json

URL parameters

Produces

200 Response

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

Body parameters

`200` Response

Properties for `data` object

Properties for `meta` object

Properties for `brand` object

Properties for `location` object

Properties for `vendor` 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

`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 `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

Properties for `meta` object

Properties for `brandTemplate` object

Properties for `categoryTemplate` object

Properties for `parent` object

Properties for `deletedUser` object

Properties for `pricingMatrixTemplate` 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