Purchase Order
WIP: A summary needs to be written for Purchase Order
GET/v3/purchase_order
Find purchase orders
Find all purchase orders with parts and tires
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
hasMore
- Type
- boolean Required
- Description
- Name
total
- Type
- number 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
GET
/v3/purchase_ordercurl https://api.shopmonkey.cloud/v3/purchase_order \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": [
{
"id": "id",
"companyId": "companyId",
"locationId": "locationId",
"number": "number",
"status": "status",
"totalPriceCents": 1,
"invoiceNumber": null,
"orderId": null,
"note": null,
"provider": null,
"createdDate": "createdDate",
"updatedDate": null,
"orderedDate": null,
"fullfiledDate": null,
"items": [
{
"id": "id",
"companyId": "companyId",
"locationId": "locationId",
"purchaseOrderId": "purchaseOrderId",
"name": "name",
"type": "type",
"quantity": 1,
"costCents": 1,
"shippingChargeCents": 1,
"coreChargesCents": 1,
"exciseTaxCents": 1,
"vendorId": "vendorId",
"lineItemId": null,
"inventoryItemId": null,
"number": null,
"status": null,
"note": null,
"imageUrl": null,
"createdDate": "createdDate",
"updatedDate": null
}
]
}
]
}
GET/v3/purchase_order/cart/order
Find purchase orders of an order
Find all 'Draft' provider-related PO's (PartsTech etc.) for an order
200
Response
- Name
data
- Type
- array Required
- Description
- Name
success
- Type
- boolean 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
GET
/v3/purchase_order/cart/ordercurl https://api.shopmonkey.cloud/v3/purchase_order/cart/order \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"data": [
{
"id": "id",
"status": "status",
"provider": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"purchaseOrderId": "purchaseOrderId",
"amountCents": 1,
"name": "name",
"ordinal": 1,
"purchaseOrderPartId": null,
"kind": null
}
],
"parts": [
{
"id": "id",
"companyId": "companyId",
"locationId": "locationId",
"purchaseOrderId": "purchaseOrderId",
"createdDate": "createdDate",
"updatedDate": null,
"name": "name",
"number": "number",
"costCents": 1,
"quantity": 1,
"receivedQuantity": 1,
"ordinal": 1,
"inventoryPartId": null
}
],
"tires": [
{
"id": "id",
"companyId": "companyId",
"locationId": "locationId",
"purchaseOrderId": "purchaseOrderId",
"createdDate": "createdDate",
"updatedDate": null,
"name": "name",
"number": "number",
"costCents": 1,
"quantity": 1,
"receivedQuantity": 1,
"ordinal": 1,
"inventoryTireId": null
}
],
"vendor": {
"name": "name"
}
}
],
"success": true
}
GET/v3/purchase_order/cart/swap
Find purchase orders of an order
Find active (Draft) or just placed (Ordered) provider-related PO's (PartsTech etc.) for an order
200
Response
- Name
data
- Type
- array Required
- Description
- Name
success
- Type
- boolean 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
GET
/v3/purchase_order/cart/swapcurl https://api.shopmonkey.cloud/v3/purchase_order/cart/swap \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"data": [
{
"id": "id",
"status": "status",
"provider": null,
"fees": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"purchaseOrderId": "purchaseOrderId",
"amountCents": 1,
"name": "name",
"ordinal": 1,
"purchaseOrderPartId": null,
"kind": null
}
],
"parts": [
{
"id": "id",
"companyId": "companyId",
"locationId": "locationId",
"purchaseOrderId": "purchaseOrderId",
"createdDate": "createdDate",
"updatedDate": null,
"name": "name",
"number": "number",
"costCents": 1,
"quantity": 1,
"receivedQuantity": 1,
"ordinal": 1,
"inventoryPartId": null
}
],
"tires": [
{
"id": "id",
"companyId": "companyId",
"locationId": "locationId",
"purchaseOrderId": "purchaseOrderId",
"createdDate": "createdDate",
"updatedDate": null,
"name": "name",
"number": "number",
"costCents": 1,
"quantity": 1,
"receivedQuantity": 1,
"ordinal": 1,
"inventoryTireId": null
}
],
"vendor": {
"name": "name"
}
}
],
"success": true
}
GET/v3/purchase_order/:id
Find purchase order
Find the purchase order by id
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object
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
- PurchaseOrder schema
Properties for data
object
- Name
id
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
locationId
- 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
session
- Type
- object
- Description
- Name
number
- Type
- integer Required
- Description
- Name
status
- Type
- string Required
- Description
- Name
totalCostCents
- Type
- integer Required
- Description
- Name
invoiceNumber
- Type
- string Required
- Description
- Name
orderId
- Type
- string Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
provider
- Type
- string Required
- Description
- Name
providerData
- Type
- object
- Description
- Name
createdDate
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
orderedDate
- Type
- string Required
- Description
- Name
fulfilledDate
- Type
- string Required
- Description
- Name
vendorId
- Type
- string Required
- Description
- Name
fees
- Type
- array
- Description
- Name
order
- Type
- object
- Description
- Name
parts
- Type
- array
- Description
- Name
tires
- Type
- array
- Description
- Name
vendor
- Type
- object
- 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 order
object
- Name
coalescedName
- Type
- string
- Description
- Name
name
- Type
- string
- Description
- Name
number
- Type
- string Required
- Description
Properties for vendor
object
- Name
name
- 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
GET
/v3/purchase_order/:idcurl https://api.shopmonkey.cloud/v3/purchase_order/ID \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"companyId": "companyId",
"locationId": "locationId",
"meta": {
"userId": "userId",
"sessionId": "sessionId",
"version": 1
},
"number": "number",
"status": "status",
"totalPriceCents": 1,
"invoiceNumber": null,
"orderId": null,
"note": null,
"provider": null,
"createdDate": "createdDate",
"updatedDate": null,
"orderedDate": null,
"fullfiledDate": null,
"items": [
{
"id": "id",
"companyId": "companyId",
"locationId": "locationId",
"purchaseOrderId": "purchaseOrderId",
"name": "name",
"type": "type",
"quantity": 1,
"costCents": 1,
"shippingChargeCents": 1,
"coreChargesCents": 1,
"exciseTaxCents": 1,
"vendorId": "vendorId",
"lineItemId": null,
"inventoryItemId": null,
"number": null,
"status": null,
"note": null,
"imageUrl": null,
"createdDate": "createdDate",
"updatedDate": null
}
]
}
}
DELETE/v3/purchase_order/:id
Delete a purchase order
Permanently delete a purchase order by id`
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object
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
id
- Type
- string Required
- Description
- the id of the purchase order
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/purchase_order/:idcurl https://api.shopmonkey.cloud/v3/purchase_order/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X DELETE -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true
}
GET/v3/purchase_order/export
Export Purchase Orders
Export Purchase Orders data as Excel spreadsheet
200
Response
the data in excel format
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/purchase_order/exportcurl https://api.shopmonkey.cloud/v3/purchase_order/export \
-H "Authorization: Bearer ${SM_TOKEN}"
POST/v3/purchase_order/export
Export Purchase Orders
Export Purchase Orders data as Excel spreadsheet
200
Response
the data in excel format
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/purchase_order/exportcurl https://api.shopmonkey.cloud/v3/purchase_order/export \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{}'
GET/v3/purchase_order_part/:id
Find purchase order part
Find the purchase order part by id
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object
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
id
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
locationId
- Type
- string Required
- Description
- Name
purchaseOrderId
- 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
name
- Type
- string Required
- Description
- Name
number
- Type
- string Required
- Description
- Name
costCents
- Type
- integer Required
- Description
- Name
quantity
- Type
- number Required
- Description
- Name
receivedQuantity
- Type
- number Required
- Description
- Name
ordinal
- Type
- number Required
- Description
- Name
inventoryPartId
- Type
- string Required
- Description
- Name
providerData
- Type
- object
- Description
- Name
purchaseOrder
- Type
- object Required
- Description
- PurchaseOrder 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 purchaseOrder
object
- Name
id
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
locationId
- 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
session
- Type
- object
- Description
- Name
number
- Type
- integer Required
- Description
- Name
status
- Type
- string Required
- Description
- Name
totalCostCents
- Type
- integer Required
- Description
- Name
invoiceNumber
- Type
- string Required
- Description
- Name
orderId
- Type
- string Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
provider
- Type
- string Required
- Description
- Name
providerData
- Type
- object
- Description
- Name
createdDate
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
orderedDate
- Type
- string Required
- Description
- Name
fulfilledDate
- Type
- string Required
- Description
- Name
vendorId
- 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/purchase_order_part/:idcurl https://api.shopmonkey.cloud/v3/purchase_order_part/ID \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"companyId": "companyId",
"locationId": "locationId",
"purchaseOrderId": "purchaseOrderId",
"meta": {
"userId": "userId",
"sessionId": "sessionId",
"version": 1
},
"createdDate": "createdDate",
"updatedDate": null,
"name": "name",
"number": "number",
"costCents": 1,
"quantity": 1,
"receivedQuantity": 1,
"ordinal": 1,
"inventoryPartId": null,
"purchaseOrder": {
"id": "id",
"companyId": "companyId",
"locationId": "locationId",
"meta": {
"userId": "userId",
"sessionId": "sessionId",
"version": 1
},
"number": 1,
"status": "status",
"totalCostCents": 1,
"invoiceNumber": null,
"orderId": null,
"note": null,
"provider": null,
"createdDate": "createdDate",
"updatedDate": null,
"orderedDate": null,
"fulfilledDate": null,
"vendorId": null
}
}
}
GET/v3/purchase_order_tire/:id
Find purchase order tire
Find the purchase order tire by id
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object
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
id
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
locationId
- Type
- string Required
- Description
- Name
purchaseOrderId
- 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
name
- Type
- string Required
- Description
- Name
number
- Type
- string Required
- Description
- Name
costCents
- Type
- integer Required
- Description
- Name
quantity
- Type
- number Required
- Description
- Name
receivedQuantity
- Type
- number Required
- Description
- Name
ordinal
- Type
- number Required
- Description
- Name
inventoryTireId
- Type
- string Required
- Description
- Name
providerData
- Type
- object
- Description
- Name
purchaseOrder
- Type
- object Required
- Description
- PurchaseOrder 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 purchaseOrder
object
- Name
id
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
locationId
- 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
session
- Type
- object
- Description
- Name
number
- Type
- integer Required
- Description
- Name
status
- Type
- string Required
- Description
- Name
totalCostCents
- Type
- integer Required
- Description
- Name
invoiceNumber
- Type
- string Required
- Description
- Name
orderId
- Type
- string Required
- Description
- Name
note
- Type
- string Required
- Description
- Name
provider
- Type
- string Required
- Description
- Name
providerData
- Type
- object
- Description
- Name
createdDate
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
orderedDate
- Type
- string Required
- Description
- Name
fulfilledDate
- Type
- string Required
- Description
- Name
vendorId
- 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/purchase_order_tire/:idcurl https://api.shopmonkey.cloud/v3/purchase_order_tire/ID \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"companyId": "companyId",
"locationId": "locationId",
"purchaseOrderId": "purchaseOrderId",
"meta": {
"userId": "userId",
"sessionId": "sessionId",
"version": 1
},
"createdDate": "createdDate",
"updatedDate": null,
"name": "name",
"number": "number",
"costCents": 1,
"quantity": 1,
"receivedQuantity": 1,
"ordinal": 1,
"inventoryTireId": null,
"purchaseOrder": {
"id": "id",
"companyId": "companyId",
"locationId": "locationId",
"meta": {
"userId": "userId",
"sessionId": "sessionId",
"version": 1
},
"number": 1,
"status": "status",
"totalCostCents": 1,
"invoiceNumber": null,
"orderId": null,
"note": null,
"provider": null,
"createdDate": "createdDate",
"updatedDate": null,
"orderedDate": null,
"fulfilledDate": null,
"vendorId": null
}
}
}