# Purchase Order API

- Human documentation: https://www.myrepairapp.com/api-docs/purchase-order
- OpenAPI: https://www.myrepairapp.com/openapi.json
- Last updated: 2026-07-30T23:33:32.512Z

## The Inventory Purchase Order Model

The Inventory Purchase Order object represents a purchase order in the system. Below is an example of an Inventory Purchase Order object with all possible fields.

```json
{
    "rush": true,
    "status": "Ordered",
    "supplierId": "SUP12345",
    "vendorOrderNumber": "VON67890",
    "shipper": "FedEx",
    "trackingNumber": "TRK123456789",
    "shippingCost": 25.5,
    "taxes": 5.75,
    "otherCostAdjustments": 2.0,
    "note": "Urgent order"
  }
```

### Inventory Purchase Order Object Properties

This model supports multiple types of updates. An update can contain:

* A **rush order flag**.

* A **status update**.

* Detailed **order information updates**.

| Field                  | Type      | Required | Description                                            |
| ---------------------- | --------- | -------- | ------------------------------------------------------ |
| `rush`                 | `boolean` | No       | Indicates if the order is a rush order.                |
| `status`               | `enum`    | No       | The status of the purchase order (Ordered/Reconciled). |
| `supplierId`           | `string`  | No       | The supplier ID for the purchase order.                |
| `vendorOrderNumber`    | `string`  | No       | The vendor's order number for reference.               |
| `shipper`              | `enum`    | No       | The shipping provider (e.g., FedEx, UPS).              |
| `trackingNumber`       | `string`  | No       | The tracking number for the shipment.                  |
| `shippingCost`         | `number`  | No       | The cost of shipping the order.                        |
| `taxes`                | `number`  | No       | The tax amount for the purchase order.                 |
| `otherCostAdjustments` | `number`  | No       | Any additional cost adjustments.                       |
| `note`                 | `string`  | No       | Any additional notes related to the order.             |

### Update Options

Updates to an Inventory Purchase Order can be made using any of the following bodies:

1. **Rush Order Update:** Contains only the `rush` field.

2. **Status Update:** Contains only the `status` field.

3. **Order Info Update:** Contains fields such as `supplierId`, `vendorOrderNumber`, `shipper`, `trackingNumber`, `shippingCost`, `taxes`, `otherCostAdjustments`, and `note`.

All three updates are possible and can be applied separately or together based on the update requirements.

***

## Purchase Order Resources

### Get all purchase orders

This endpoint returns a list of all purchase orders.

**HTTP Request**

```http
GET https://www.myrepairapp.com/api/v2/inventory/order
```

**Response**

If successful, the response will include a list of all purchase orders from the inventory.

***

### Create a purchase order

This endpoint creates an empty purchase order.

**HTTP Request**

```http
POST https://www.myrepairapp.com/api/v2/inventory/order
```

**Request Body**

There should be no request body for this endpoint.

**Response**

If successful, the response will include the details of the newly created purchase order.

***

### Get a purchase order by ID

This endpoint returns a single purchase order by ID.

**HTTP Request**

```http
GET https://www.myrepairapp.com/api/v2/inventory/order/{id}
```

**Response**

If successful, the response will include the details of the requested purchase order.

***

### Update a purchase order

This endpoint updates a purchase order's information.

**HTTP Request**

```http
PATCH https://www.myrepairapp.com/api/v2/inventory/order/{id}
```

**Request Body**

The request body can contain any of the following fields:

* `rush`

* `status`

* `supplierId`

* `vendorOrderNumber`

* `shipper`

* `trackingNumber`

* `shippingCost`

* `taxes`

* `otherCostAdjustments`

* `note`

**Response**

If successful, the response will include the updated purchase order's details.

***

### Delete a purchase order

This endpoint deletes a purchase order.

**HTTP Request**

```http
DELETE https://www.myrepairapp.com/api/v2/inventory/order/{id}
```

**Response**

If successful, the response will include a confirmation message that the purchase order has been deleted.
