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

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
    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
    minCriticalQuantity
    Type
    number Required
    Description
  • Name
    maxCriticalQuantity
    Type
    number Required
    Description
  • Name
    quantity
    Type
    number Required
    Description
  • Name
    onEstimateQuantity
    Type
    number Required
    Description
  • Name
    reservedQuantity
    Type
    number Required
    Description
  • Name
    availableQuantity
    Type
    number Required
    Description
  • Name
    reorderQuantity
    Type
    number Required
    Description
  • Name
    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
    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
    computed_fullText
    Type
    string Required
    Description
  • Name
    url
    Type
    string Required
    Description
  • Name
    userId
    Type
    string Required
    Description
  • Name
    brand
    Type
    one of: any, any Required
    Description
    Brand schema
  • Name
    category
    Type
    one of: any, any Required
    Description
  • Name
    vendor
    Type
    one of: any, any 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

4xx 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 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
    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

Create Inventory Part

Create an Inventory Part

Body parameters

  • Name
    locationId
    Type
    string
    Description
  • 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
    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
    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
    url
    Type
    string
    Description
  • Name
    userId
    Type
    string
    Description

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
    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
    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
    minCriticalQuantity
    Type
    number Required
    Description
  • Name
    maxCriticalQuantity
    Type
    number Required
    Description
  • Name
    quantity
    Type
    number Required
    Description
  • Name
    onEstimateQuantity
    Type
    number Required
    Description
  • Name
    reservedQuantity
    Type
    number Required
    Description
  • Name
    availableQuantity
    Type
    number Required
    Description
  • Name
    reorderQuantity
    Type
    number Required
    Description
  • Name
    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
    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
    computed_fullText
    Type
    string Required
    Description
  • Name
    url
    Type
    string Required
    Description
  • Name
    userId
    Type
    string Required
    Description

4xx 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 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
    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}" \ 
  -X POST -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
  }
}
DELETE/v3/inventory_part/:id

Delete Inventory Part

Permanently delete a Inventory Part by id

URL parameters

  • Name
    id
    Type
    string Required
    Description
    the id of the record to delete

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
    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
    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
}
POST/v3/inventory_part/import

Import entities

Import one or more entities

Body parameters

  • 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

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
    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
    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
    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
multipart/form-data

POST
/v3/inventory_part/import
curl https://api.shopmonkey.cloud/v3/inventory_part/import \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -X POST -H 'Content-Type: multipart/form-data' \ 
  --data '{}'

Example Response
application/json

{
  "success": true,
  "data": {
    "added": 1,
    "updated": 1
  }
}
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

  • Name
    reason
    Type
    string Required
    Description
    the reason message if deleted

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
    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
    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
    minCriticalQuantity
    Type
    number Required
    Description
  • Name
    maxCriticalQuantity
    Type
    number Required
    Description
  • Name
    quantity
    Type
    number Required
    Description
  • Name
    onEstimateQuantity
    Type
    number Required
    Description
  • Name
    reservedQuantity
    Type
    number Required
    Description
  • Name
    availableQuantity
    Type
    number Required
    Description
  • Name
    reorderQuantity
    Type
    number Required
    Description
  • Name
    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
    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
    computed_fullText
    Type
    string Required
    Description
  • Name
    url
    Type
    string Required
    Description
  • Name
    userId
    Type
    string Required
    Description

4xx 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 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
    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 '{ "reason" : "value" }'

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