Confirm receipt of a Purchase Order

1 min

POST

https://developer.digitail.io/api/v1/purchase-orders/{id}/receive

Permissions needed: EDIT_ORDERS.

Marks a pending, draft or backorder purchase order as completed and adds its lines to the clinic's stock, exactly as completing the order in the app does. Quantities, costs and prices are never changed by this call; only the order status and each line's is_received flag.

Omit items (or send an empty body) to receive every line. To receive only some lines, list the ones that did not arrive with is_received: false; lines that are not listed count as received. A finalization_strategy is then required: create_backorder moves the unreceived lines to a new backorder purchase order (returned as related_order), keep_unreceived drops them from this order.

An order that is already completed is rejected with 422.

Body Parameters

bodyobject
Example
```
{
  "items": [
    {
      "id": 1201,
      "is_received": false
    }
  ],
  "finalization_strategy": "create_backorder"
}
```
- itemsobject[]
  Description
  Lines to flag explicitly. Unlisted lines are treated as received.
  - idintegerrequired
    Example
    1201
    Description
    Purchase order item id, as returned by the order detail.
  - is_receivedbooleanrequired
- finalization_strategystring<create_backorder | keep_unreceived>
  Example
  create_backorder
  Description
  Required when any listed line has is_received: false.
  Allowed
  create_backorderkeep_unreceived

Responses

200

The completed purchase order, with its received items and the backorder (if one was created) under related_order.

object
- datadata

curl

curl --request POST \
     --url https://developer.digitail.io/api/v1/purchase-orders/{id}/receive \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "items": [
     {
     "id": 1201,
     "is_received": false
     }
     ]
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "items": [
      {
         "id": 1201,
         "is_received": false
      }
   ]
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://developer.digitail.io/api/v1/purchase-orders/{id}/receive", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://developer.digitail.io/api/v1/purchase-orders/{id}/receive")

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "items": [
      {
         "id": 1201,
         "is_received": false
      }
   ]
})

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

python

import requests
import json

url = "https://developer.digitail.io/api/v1/purchase-orders/{id}/receive"

payload = json.dumps({
   "items": [
      {
         "id": 1201,
         "is_received": False
      }
   ]
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// The completed purchase order, with its received items and the backorder (if one was created) under related_order.
{
  "data": {}
}