Inventory Fee
WIP: A summary needs to be written for Inventory Fee
Find Inventory Fee
Find one Inventory Fee 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
- InventoryFee 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
categoryId
- Type
- string Required
- Description
- Name
deleted
- Type
- boolean Required
- Description
- if the record has been deleted
- Name
deletedUserId
- Type
- string Required
- Description
- the user that deleted the record or null if not deleted
- Name
deletedDate
- Type
- string Required
- Description
- the date that the record was deleted or null if not deleted
- Name
deletedReason
- Type
- string Required
- Description
- the reason that the record was deleted
- Name
feeType
- Type
- one of: PercentLineItem, PercentService, FixedCents Required
- Description
- Name
percent
- Type
- number Required
- Description
- Name
amountCents
- Type
- integer Required
- Description
- Name
userId
- Type
- string Required
- Description
- Name
category
- Type
- object Required
- Description
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 category
object
- Name
id
- Type
- string Required
- Description
- the id for the category
- Name
name
- Type
- string Required
- Description
- the category name
- Name
parent
- Type
- object Required
- Description
Properties for parent
object
- Name
id
- Type
- string Required
- Description
- the id for the parent category
- Name
name
- Type
- string Required
- Description
- the name of the parent category
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
curl https://api.shopmonkey.cloud/v3/inventory_fee/ID \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"meta": {
"userId": "userId",
"sessionId": "sessionId",
"version": 1
},
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"categoryId": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"feeType": "feeType",
"percent": 1,
"amountCents": 1,
"userId": null
}
}
List Inventory Fees
Find all Inventory Fees
Produces
The response content type: application/json
200
Response
- Name
data
- Type
- array Required
- Description
- an array of items
- Name
meta
- Type
- object
- Description
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Properties for meta
object
- Name
hasMore
- Type
- boolean Required
- Description
- if there are more records available
- Name
total
- Type
- number Required
- Description
- the total number of records
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
curl https://api.shopmonkey.cloud/v3/inventory_fee \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"categoryId": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"feeType": "feeType",
"percent": 1,
"amountCents": 1,
"userId": null
}
]
}
Search Inventory Fee entities
Search for Inventory Fee Entries
Produces
The response content type: application/json
200
Response
- Name
data
- Type
- array Required
- Description
- an array of items
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
curl https://api.shopmonkey.cloud/v3/inventory_fee/search \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"data": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"categoryId": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"feeType": "feeType",
"percent": 1,
"amountCents": 1,
"userId": null,
"category": {
"id": "id",
"name": "name",
"parent": {
"id": "id",
"name": "name"
}
}
}
],
"success": true
}
Update Inventory Fee
Update one Inventory Fee by id
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object to update
Body parameters
Consumes
The following content type is required: application/json
- Name
name
- Type
- string
- Description
- Name
categoryId
- 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
feeType
- Type
- one of: PercentLineItem, PercentService, FixedCents
- Description
- Name
percent
- Type
- number
- Description
- Name
amountCents
- Type
- integer
- Description
- Name
userId
- Type
- string
- Description
Produces
The response content type: application/json
200
Response
- Name
data
- Type
- object
- Description
- Name
success
- Type
- boolean Required
- Description
Properties for data
object
- Name
id
- Type
- string Required
- Description
- the id for the object
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
curl https://api.shopmonkey.cloud/v3/inventory_fee/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true
}
Create Inventory Fee
Create an Inventory Fee
Body parameters
Consumes
The following content type is required: application/json
- Name
name
- Type
- string Required
- Description
- Name
categoryId
- 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
feeType
- Type
- one of: PercentLineItem, PercentService, FixedCents
- Description
- Name
percent
- Type
- number
- Description
- Name
amountCents
- Type
- integer
- Description
- Name
userId
- 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
- InventoryFee 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
categoryId
- Type
- string Required
- Description
- Name
deleted
- Type
- boolean Required
- Description
- if the record has been deleted
- Name
deletedUserId
- Type
- string Required
- Description
- the user that deleted the record or null if not deleted
- Name
deletedDate
- Type
- string Required
- Description
- the date that the record was deleted or null if not deleted
- Name
deletedReason
- Type
- string Required
- Description
- the reason that the record was deleted
- Name
feeType
- Type
- one of: PercentLineItem, PercentService, FixedCents Required
- Description
- Name
percent
- Type
- number Required
- Description
- Name
amountCents
- Type
- integer Required
- Description
- Name
userId
- Type
- string Required
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
curl https://api.shopmonkey.cloud/v3/inventory_fee \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{ "name" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"categoryId": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"feeType": "feeType",
"percent": 1,
"amountCents": 1,
"userId": null
}
}
Delete Inventory Fee
Permanently delete a Inventory Fee by id
URL parameters
- Name
id
- Type
- string Required
- Description
- the id of the record to delete
Produces
The response content type: application/json
200
Response
- Name
data
- Type
- object
- Description
- Name
success
- Type
- boolean Required
- Description
Properties for data
object
- Name
id
- Type
- string Required
- Description
- the id for the object
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
curl https://api.shopmonkey.cloud/v3/inventory_fee/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X DELETE -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true
}
Soft Delete Inventory Fee
Soft delete or undelete a Inventory Fee by id
URL parameters
- Name
action
- Type
- one of: 'delete', 'undelete' Required
- Description
- the action to take
- Name
id
- Type
- string Required
- Description
- primary key for the record
Body parameters
Consumes
The following content type is required: application/json
- Name
reason
- Type
- string Required
- Description
- the reason message if deleted
Produces
The response content type: application/json
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if success = false
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- object Required
- Description
- InventoryFee 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
categoryId
- Type
- string Required
- Description
- Name
deleted
- Type
- boolean Required
- Description
- if the record has been deleted
- Name
deletedUserId
- Type
- string Required
- Description
- the user that deleted the record or null if not deleted
- Name
deletedDate
- Type
- string Required
- Description
- the date that the record was deleted or null if not deleted
- Name
deletedReason
- Type
- string Required
- Description
- the reason that the record was deleted
- Name
feeType
- Type
- one of: PercentLineItem, PercentService, FixedCents Required
- Description
- Name
percent
- Type
- number Required
- Description
- Name
amountCents
- Type
- integer Required
- Description
- Name
userId
- Type
- string Required
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
curl https://api.shopmonkey.cloud/v3/inventory_fee/ID/ACTION \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PATCH -H 'Content-Type: application/json' \
--data '{ "reason" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"locationId": "locationId",
"name": "name",
"categoryId": null,
"deleted": true,
"deletedUserId": null,
"deletedDate": null,
"deletedReason": null,
"feeType": "feeType",
"percent": 1,
"amountCents": 1,
"userId": null
}
}
Export Fee
Export Fee data as Excel spreadsheet
Produces
The response content type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
200
Response
the data in excel format
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
curl https://api.shopmonkey.cloud/v3/inventory_fee/export \
-H "Authorization: Bearer ${SM_TOKEN}"
Export Fee
Export Fee data as Excel spreadsheet
Produces
The response content type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
200
Response
the data in excel format
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- undefined
- Description
- An optional object containing relevant error data
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
curl https://api.shopmonkey.cloud/v3/inventory_fee/export \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{}'