Purchase orders

Update a purchase order

Partially updates a purchase order with the given information. Only fields included in the request body will be updated; omitted fields are left unchanged. Only custom purchase orders (not synced from a purchasing platform) in draft status can be updated.

A purchase order tracks an order placed by a clinic to a supplier for inventory items. Each purchase order contains one or more line items identifying the inventory being ordered, the quantity, and the price. Purchase orders are created in draft status and can later be finalized in the pims web ui.

PATCH

ext

purchase-orders

{purchase_order_id}

Update a purchase order

curl --request PATCH \
  --url https://connect.vetcove.com/ext/v2/purchase-orders/{purchase_order_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order_datetime": "2023-11-07T05:31:56Z",
  "po_number": "<string>",
  "supplier": "<string>"
}
'

import requests

url = "https://connect.vetcove.com/ext/v2/purchase-orders/{purchase_order_id}/"

payload = {
    "order_datetime": "2023-11-07T05:31:56Z",
    "po_number": "<string>",
    "supplier": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    order_datetime: '2023-11-07T05:31:56Z',
    po_number: '<string>',
    supplier: '<string>'
  })
};

fetch('https://connect.vetcove.com/ext/v2/purchase-orders/{purchase_order_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.vetcove.com/ext/v2/purchase-orders/{purchase_order_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'order_datetime' => '2023-11-07T05:31:56Z',
    'po_number' => '<string>',
    'supplier' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.vetcove.com/ext/v2/purchase-orders/{purchase_order_id}/"

	payload := strings.NewReader("{\n  \"order_datetime\": \"2023-11-07T05:31:56Z\",\n  \"po_number\": \"<string>\",\n  \"supplier\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://connect.vetcove.com/ext/v2/purchase-orders/{purchase_order_id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"order_datetime\": \"2023-11-07T05:31:56Z\",\n  \"po_number\": \"<string>\",\n  \"supplier\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/purchase-orders/{purchase_order_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"order_datetime\": \"2023-11-07T05:31:56Z\",\n  \"po_number\": \"<string>\",\n  \"supplier\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "clinic_id": 123,
  "created": "2023-11-07T05:31:56Z",
  "effective_total": 123,
  "id": 123,
  "modified": "2023-11-07T05:31:56Z",
  "order_datetime": "2023-11-07T05:31:56Z",
  "po_number": "<string>",
  "purchase_order_items": [
    {
      "created": "2023-11-07T05:31:56Z",
      "id": 123,
      "inventory_id": 123,
      "modified": "2023-11-07T05:31:56Z",
      "quantity": 123,
      "sku": "<string>",
      "total_price": 123,
      "unit_of_measure": "<string>",
      "inventory_shortcode": ""
    }
  ],
  "raw_total": 123,
  "status": "DRAFT",
  "supplier": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

purchase_order_id

integer

required

The ID of the purchase order to fetch

Body

application/json

order_datetime

string<date-time> | null

Updated order datetime

po_number

string | null

Updated purchase order number

supplier

string | null

Updated supplier name

Response

200 - application/json

clinic_id

integer

required

The ID of the clinic this purchase order belongs to

created

string<date-time>

required

The datetime this object was created.

effective_total

integer

required

The effective total of the order, in cents

integer

required

The unique identifier for the purchase order

modified

string<date-time>

required

The datetime this object was last modified; changes to related entities will not update this field.

order_datetime

string<date-time>

required

The datetime when the order was placed

po_number

string

required

The purchase order number

purchase_order_items

ExternalPurchaseOrderItemSchema · object[]

required

The line items included in this purchase order

Show child attributes

raw_total

integer

required

The raw total of the order, in cents

status

enum<string>

required

The current status of the purchase order

Available options:

DRAFT,

PENDING,

PARTIALLY_RECEIVED,

FULLY_RECEIVED,

CANCELED,

RETURNED,

CLOSED

supplier

string

required

The name of the supplier for this order

⌘I

Update a purchase order

curl --request PATCH \
  --url https://connect.vetcove.com/ext/v2/purchase-orders/{purchase_order_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order_datetime": "2023-11-07T05:31:56Z",
  "po_number": "<string>",
  "supplier": "<string>"
}
'

import requests

url = "https://connect.vetcove.com/ext/v2/purchase-orders/{purchase_order_id}/"

payload = {
    "order_datetime": "2023-11-07T05:31:56Z",
    "po_number": "<string>",
    "supplier": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    order_datetime: '2023-11-07T05:31:56Z',
    po_number: '<string>',
    supplier: '<string>'
  })
};

fetch('https://connect.vetcove.com/ext/v2/purchase-orders/{purchase_order_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.vetcove.com/ext/v2/purchase-orders/{purchase_order_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'order_datetime' => '2023-11-07T05:31:56Z',
    'po_number' => '<string>',
    'supplier' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.vetcove.com/ext/v2/purchase-orders/{purchase_order_id}/"

	payload := strings.NewReader("{\n  \"order_datetime\": \"2023-11-07T05:31:56Z\",\n  \"po_number\": \"<string>\",\n  \"supplier\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://connect.vetcove.com/ext/v2/purchase-orders/{purchase_order_id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"order_datetime\": \"2023-11-07T05:31:56Z\",\n  \"po_number\": \"<string>\",\n  \"supplier\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/purchase-orders/{purchase_order_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"order_datetime\": \"2023-11-07T05:31:56Z\",\n  \"po_number\": \"<string>\",\n  \"supplier\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "clinic_id": 123,
  "created": "2023-11-07T05:31:56Z",
  "effective_total": 123,
  "id": 123,
  "modified": "2023-11-07T05:31:56Z",
  "order_datetime": "2023-11-07T05:31:56Z",
  "po_number": "<string>",
  "purchase_order_items": [
    {
      "created": "2023-11-07T05:31:56Z",
      "id": 123,
      "inventory_id": 123,
      "modified": "2023-11-07T05:31:56Z",
      "quantity": 123,
      "sku": "<string>",
      "total_price": 123,
      "unit_of_measure": "<string>",
      "inventory_shortcode": ""
    }
  ],
  "raw_total": 123,
  "status": "DRAFT",
  "supplier": "<string>"
}

Using the API

Developer guides

Accounts

Care plans

Catalog

Checkout links

Clients & patients

Clinics

External Rx

Insurance

Inbox

Invoices

Labs

Onboardings

Orders

Payments

PDFs

Prescriptions

Scheduler

Service pricing

Standard care

Subscriptions

File uploads

Inventory

Forms

Medical records

Update a purchase order

Authorizations

Path Parameters

Body

Response