InternalPurchaseOrder
Was this helpful?
Was this helpful?
InternalPurchaseOrder
Get internal purchase order details
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+Reference to an internal purchase order.
^[A-Za-z0-9-_]+Example response
Delete an internal purchase order
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+Reference to an internal purchase order.
^[A-Za-z0-9-_]+No Content
No Content
List all items on an internal purchase order
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+Reference to an internal purchase order.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Example response
Get internal purchase order item details
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+Reference to an internal purchase order.
^[A-Za-z0-9-_]+Reference to an internal purchase order item.
^[A-Za-z0-9-_]+Example response
Delete an internal purchase order item
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+Reference to an internal purchase order.
^[A-Za-z0-9-_]+Reference to an internal purchase order item.
^[A-Za-z0-9-_]+No Content
No Content
Download internal purchase order.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+Reference to an internal purchase order.
^[A-Za-z0-9-_]+Based on the Accept header the response will be base64 json encoded or a raw file. application/octet-stream will return a binary file application/json will return a json with the file content base64 encoded.
List internal purchase orders for an organization
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+Reference to a store uid
^[A-Za-z0-9-_]+Reference to a store uid
^[A-Za-z0-9-_]+Reference to a internal purchase order status
Reference to a to-date-time
Reference to a from-date-time
Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Example response
sendingStoreUid is the sender of the internal purchase order.
receivingStoreUid is the receiver of the internal purchase order.
creatingStoreUid is the store that creates the internal purchase order, which can be any of the above or another store.
If the creating store is not the sender, then the sender must confirm the request before the products on the order can be sent.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+| ENUM | Description |
|---|---|
| NEW | Draft/work in progress |
| READY_FOR_CONFIRMATION | The order is ready for confirmation by receiving store |
| PREPARING_FOR_SHIPMENT | Internal purchase order is ready to be shipped from the sending store |
| IN_TRANSIT | All quantity sent is registered and products are sent from sending store (and removed from warehouse) |
| ARRIVED | Purchase order has arrived to requesting store and is ready for registering and controlling quantity |
| COMPLETE | Purchase order is complete (and stock is added to the receiving stores warehouse) |
| CANCELLED | Purchase order is cancelled. |
^[A-Za-z0-9-_]+Generate a internal purchase order proposal based on min/max
Example response
Update an internal purchase order
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+Reference to an internal purchase order.
^[A-Za-z0-9-_]+| ENUM | Description |
|---|---|
| NEW | Draft/work in progress |
| READY_FOR_CONFIRMATION | The order is ready for confirmation by receiving store |
| PREPARING_FOR_SHIPMENT | Internal purchase order is ready to be shipped from the sending store |
| IN_TRANSIT | All quantity sent is registered and products are sent from sending store (and removed from warehouse) |
| ARRIVED | Purchase order has arrived to requesting store and is ready for registering and controlling quantity |
| COMPLETE | Purchase order is complete (and stock is added to the receiving stores warehouse) |
| CANCELLED | Purchase order is cancelled. |
Example response
Create an order item on an internal purchase order
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+Reference to an internal purchase order.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Example response
Update internal purchase order item details
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+Reference to an internal purchase order.
^[A-Za-z0-9-_]+Reference to an internal purchase order item.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Example response
Update an internal purchase order item with a send-quantity
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+Reference to an internal purchase order.
^[A-Za-z0-9-_]+Reference to an internal purchase order item.
^[A-Za-z0-9-_]+quantity to send from warehouse
^[A-Za-z0-9-_]+Example response
Update an internal purchase order item with a receive-quantity
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an organization.
^[A-Za-z0-9-_]+Reference to an internal purchase order.
^[A-Za-z0-9-_]+Reference to an internal purchase order item.
^[A-Za-z0-9-_]+Example response