Get fulfillment status
curl --request GET \
--url https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/procurement/orders/{orderId}/fulfillment \
--header 'x-api-key: <x-api-key>'import requests
url = "https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/procurement/orders/{orderId}/fulfillment"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/procurement/orders/{orderId}/fulfillment', 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://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/procurement/orders/{orderId}/fulfillment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/procurement/orders/{orderId}/fulfillment"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/procurement/orders/{orderId}/fulfillment")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/procurement/orders/{orderId}/fulfillment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"purchase_order_id": "po_01j5k...",
"status": "PARTIALLY_RECEIVED",
"lines": [
{
"purchase_order_line_id": "pol_01...",
"item_id": "itm_chicken_01...",
"ordered_qty_base": 10000,
"received_qty_base": 6000,
"pending_qty_base": 4000
}
],
"total_ordered_qty_base": 10000,
"total_received_qty_base": 6000,
"total_pending_qty_base": 4000,
"linked_goods_receipt_ids": ["rcpt_01j5k..."]
}
Purchase Orders
Get fulfillment status
Shows how much of each purchase order line has been received via linked goods receipts.
GET
/
api
/
v1
/
public
/
vendors
/
{vendorId}
/
procurement
/
orders
/
{orderId}
/
fulfillment
Get fulfillment status
curl --request GET \
--url https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/procurement/orders/{orderId}/fulfillment \
--header 'x-api-key: <x-api-key>'import requests
url = "https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/procurement/orders/{orderId}/fulfillment"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/procurement/orders/{orderId}/fulfillment', 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://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/procurement/orders/{orderId}/fulfillment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/procurement/orders/{orderId}/fulfillment"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/procurement/orders/{orderId}/fulfillment")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/procurement/orders/{orderId}/fulfillment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"purchase_order_id": "po_01j5k...",
"status": "PARTIALLY_RECEIVED",
"lines": [
{
"purchase_order_line_id": "pol_01...",
"item_id": "itm_chicken_01...",
"ordered_qty_base": 10000,
"received_qty_base": 6000,
"pending_qty_base": 4000
}
],
"total_ordered_qty_base": 10000,
"total_received_qty_base": 6000,
"total_pending_qty_base": 4000,
"linked_goods_receipt_ids": ["rcpt_01j5k..."]
}
string
required
API key with
inventory:read scope.string
required
Vendor UUID.
string
required
Purchase order UUID.
string
The PO UUID.
string
Current PO status.
object[]
Per line:
purchase_order_line_id, item_id, ordered_qty_base, received_qty_base, pending_qty_base.number
Sum of ordered quantities (base units).
number
Sum received so far.
number
Sum still pending.
string[]
Goods receipts that fulfilled this PO.
{
"purchase_order_id": "po_01j5k...",
"status": "PARTIALLY_RECEIVED",
"lines": [
{
"purchase_order_line_id": "pol_01...",
"item_id": "itm_chicken_01...",
"ordered_qty_base": 10000,
"received_qty_base": 6000,
"pending_qty_base": 4000
}
],
"total_ordered_qty_base": 10000,
"total_received_qty_base": 6000,
"total_pending_qty_base": 4000,
"linked_goods_receipt_ids": ["rcpt_01j5k..."]
}
⌘I

