Skip to main content
Fetch a purchase order
curl --request GET \
  --url https://api.cf.ovrsea.com/v1/purchaseOrders/{reference}
import requests

url = "https://api.cf.ovrsea.com/v1/purchaseOrders/{reference}"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.cf.ovrsea.com/v1/purchaseOrders/{reference}', 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://api.cf.ovrsea.com/v1/purchaseOrders/{reference}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://api.cf.ovrsea.com/v1/purchaseOrders/{reference}"

req, _ := http.NewRequest("GET", url, nil)

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.cf.ovrsea.com/v1/purchaseOrders/{reference}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.cf.ovrsea.com/v1/purchaseOrders/{reference}")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "po_number": "PO5792303",
  "supplier_name": "Detroit Factory",
  "purchase_order_lines": [
    {
      "reference": "Delivery #1",
      "product": {
        "sku": "REF0123458",
        "name": "blue t-shirt",
        "hs_code": "96032930",
        "description": "blue shirt with a T shape",
        "is_hazardous": "false",
        "hazardous_description": "UN1993",
        "custom_parameters": [
          {
            "name": "parameter1",
            "value": "value1"
          }
        ]
      },
      "ordered_quantity": 500,
      "unit_price": {
        "amount": 150357.99,
        "currency": "USD"
      },
      "assigned_order_lines": [
        {
          "ovrsea_shipment_id": "BATE",
          "assigned_quantity": 200,
          "shipped_order_lines": [
            {
              "container_number": "HLCU1234567",
              "shipped_quantity": 150,
              "packaging_total_volume": 5,
              "number_of_packages": 10,
              "packaging_type": "box",
              "net_weight": 100,
              "gross_weight": 110,
              "volume_unit": "m3",
              "weight_unit": "kg"
            }
          ]
        }
      ]
    }
  ],
  "desired_ex_factory_date": "2021-10-11",
  "desired_delivery_date": "2021-10-11",
  "custom_parameters": [
    {
      "name": "parameter1",
      "value": "value1"
    }
  ]
}
{}

Path Parameters

reference
string
required

Response

Purchase order found

po_number
string
Example:

"PO5792303"

supplier_name
string

Supplier name as per client convention

Example:

"Detroit Factory"

purchase_order_lines
object[]
desired_ex_factory_date
string
Example:

"2021-10-11"

desired_delivery_date
string
Example:

"2021-10-11"

custom_parameters
object[]

Array of up to 6 custom parameters