Vendor
WIP: A summary needs to be written for Vendor
GET/v3/vendor/:id
Find Vendor
Find one Vendor 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
- Vendor 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
url
- Type
- string Required
- Description
- Name
contactFirstName
- Type
- string Required
- Description
- Name
contactLastName
- Type
- string Required
- Description
- Name
contactEmail
- Type
- string Required
- Description
- Name
contactPhone
- Type
- object
- Description
- Name
accountNumber
- Type
- string Required
- Description
- Name
address1
- Type
- string Required
- Description
- Name
address2
- Type
- string Required
- Description
- Name
city
- Type
- string Required
- Description
- Name
state
- Type
- string Required
- Description
- Name
postalCode
- Type
- string Required
- Description
- Name
country
- Type
- string 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
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/vendor/:idcurl https://api.shopmonkey.cloud/v3/vendor/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",
"url": null,
"contactFirstName": null,
"contactLastName": null,
"contactEmail": null,
"accountNumber": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"postalCode": null,
"country": null
}
}
GET/v3/vendor
List Vendors
Find all Vendors
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
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/vendorcurl https://api.shopmonkey.cloud/v3/vendor \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"name": "name",
"url": null,
"contactFirstName": null,
"contactLastName": null,
"contactEmail": null,
"accountNumber": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"postalCode": null,
"country": null
}
]
}
PUT/v3/vendor/:id
Update Vendor
Update one Vendor by id
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object to update
Body parameters
- Name
locationId
- Type
- string
- Description
- Name
name
- Type
- string
- Description
- Name
url
- Type
- string
- Description
- Name
contactFirstName
- Type
- string
- Description
- Name
contactLastName
- Type
- string
- Description
- Name
contactEmail
- Type
- string
- Description
- Name
contactPhone
- Type
- object
- Description
- Name
accountNumber
- Type
- string
- Description
- Name
address1
- Type
- string
- Description
- Name
address2
- Type
- string
- Description
- Name
city
- Type
- string
- Description
- Name
state
- Type
- string
- Description
- Name
postalCode
- Type
- string
- Description
- Name
country
- Type
- string
- Description
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 Requestapplication/json
PUT
/v3/vendor/:idcurl https://api.shopmonkey.cloud/v3/vendor/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true
}
POST/v3/vendor/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 Requestmultipart/form-data
POST
/v3/vendor/importcurl https://api.shopmonkey.cloud/v3/vendor/import \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: multipart/form-data' \
--data '{}'
Example Responseapplication/json
{}
POST/v3/vendor
Create Vendor
Create an Vendor
Body parameters
- Name
locationId
- Type
- string
- Description
- Name
name
- Type
- string Required
- Description
- Name
url
- Type
- string
- Description
- Name
contactFirstName
- Type
- string
- Description
- Name
contactLastName
- Type
- string
- Description
- Name
contactEmail
- Type
- string
- Description
- Name
contactPhone
- Type
- object
- Description
- Name
accountNumber
- Type
- string
- Description
- Name
address1
- Type
- string
- Description
- Name
address2
- Type
- string
- Description
- Name
city
- Type
- string
- Description
- Name
state
- Type
- string
- Description
- Name
postalCode
- Type
- string
- Description
- Name
country
- 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
- Vendor 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
url
- Type
- string Required
- Description
- Name
contactFirstName
- Type
- string Required
- Description
- Name
contactLastName
- Type
- string Required
- Description
- Name
contactEmail
- Type
- string Required
- Description
- Name
contactPhone
- Type
- object
- Description
- Name
accountNumber
- Type
- string Required
- Description
- Name
address1
- Type
- string Required
- Description
- Name
address2
- Type
- string Required
- Description
- Name
city
- Type
- string Required
- Description
- Name
state
- Type
- string Required
- Description
- Name
postalCode
- Type
- string Required
- Description
- Name
country
- 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 Requestapplication/json
POST
/v3/vendorcurl https://api.shopmonkey.cloud/v3/vendor \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -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",
"url": null,
"contactFirstName": null,
"contactLastName": null,
"contactEmail": null,
"accountNumber": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"postalCode": null,
"country": null
}
}
DELETE/v3/vendor/:id
Delete Vendor
Permanently delete a Vendor 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 Requestapplication/json
DELETE
/v3/vendor/:idcurl https://api.shopmonkey.cloud/v3/vendor/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X DELETE -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true
}