Create a purchase order
curl --request POST \
--url https://api.useopenwrench.com/api/external/v1/supplier/inventory/purchase_orders \
--header 'Content-Type: application/json' \
--header 'OW-KEY: <api-key>' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"status": "<string>",
"partEquipmentVendorId": 123,
"currencyId": "<string>",
"createdByEmail": "<string>",
"totalCost": 123,
"id": 123,
"name": "<string>",
"description": "<string>",
"paymentTerms": "<string>",
"shippingTerms": "<string>",
"stockLocationId": 123,
"locationId": 123,
"brandId": 123,
"freightTotalBeforeTax": 123,
"miscTotalBeforeTax": 123,
"totalBeforeTax": 123,
"tax": 123,
"internalNotes": "<string>",
"incomingLineItems": [
{
"isEquipmentLine": true,
"partUomId": 123,
"partCurrencyId": "<string>",
"equipmentUomId": 123,
"equipmentCurrencyId": "<string>",
"id": 123,
"status": "<string>",
"viaStockLocationId": 123,
"partId": 123,
"partCatalogId": 123,
"partQuantity": 123,
"partCost": 123,
"equipmentTypeId": 123,
"equipmentCatalogId": 123,
"equipmentQuantity": 123,
"equipmentCost": 123,
"prLineItemIds": [
123
],
"warrantyAssetId": 123,
"glCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
]
}
'import requests
url = "https://api.useopenwrench.com/api/external/v1/supplier/inventory/purchase_orders"
payload = {
"status": "<string>",
"partEquipmentVendorId": 123,
"currencyId": "<string>",
"createdByEmail": "<string>",
"totalCost": 123,
"id": 123,
"name": "<string>",
"description": "<string>",
"paymentTerms": "<string>",
"shippingTerms": "<string>",
"stockLocationId": 123,
"locationId": 123,
"brandId": 123,
"freightTotalBeforeTax": 123,
"miscTotalBeforeTax": 123,
"totalBeforeTax": 123,
"tax": 123,
"internalNotes": "<string>",
"incomingLineItems": [
{
"isEquipmentLine": True,
"partUomId": 123,
"partCurrencyId": "<string>",
"equipmentUomId": 123,
"equipmentCurrencyId": "<string>",
"id": 123,
"status": "<string>",
"viaStockLocationId": 123,
"partId": 123,
"partCatalogId": 123,
"partQuantity": 123,
"partCost": 123,
"equipmentTypeId": 123,
"equipmentCatalogId": 123,
"equipmentQuantity": 123,
"equipmentCost": 123,
"prLineItemIds": [123],
"warrantyAssetId": 123,
"glCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
]
}
headers = {
"X-API-KEY": "<api-key>",
"OW-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-KEY': '<api-key>',
'OW-KEY': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
status: '<string>',
partEquipmentVendorId: 123,
currencyId: '<string>',
createdByEmail: '<string>',
totalCost: 123,
id: 123,
name: '<string>',
description: '<string>',
paymentTerms: '<string>',
shippingTerms: '<string>',
stockLocationId: 123,
locationId: 123,
brandId: 123,
freightTotalBeforeTax: 123,
miscTotalBeforeTax: 123,
totalBeforeTax: 123,
tax: 123,
internalNotes: '<string>',
incomingLineItems: [
{
isEquipmentLine: true,
partUomId: 123,
partCurrencyId: '<string>',
equipmentUomId: 123,
equipmentCurrencyId: '<string>',
id: 123,
status: '<string>',
viaStockLocationId: 123,
partId: 123,
partCatalogId: 123,
partQuantity: 123,
partCost: 123,
equipmentTypeId: 123,
equipmentCatalogId: 123,
equipmentQuantity: 123,
equipmentCost: 123,
prLineItemIds: [123],
warrantyAssetId: 123,
glCode: '<string>',
createdAt: '2023-11-07T05:31:56Z'
}
]
})
};
fetch('https://api.useopenwrench.com/api/external/v1/supplier/inventory/purchase_orders', 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.useopenwrench.com/api/external/v1/supplier/inventory/purchase_orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'status' => '<string>',
'partEquipmentVendorId' => 123,
'currencyId' => '<string>',
'createdByEmail' => '<string>',
'totalCost' => 123,
'id' => 123,
'name' => '<string>',
'description' => '<string>',
'paymentTerms' => '<string>',
'shippingTerms' => '<string>',
'stockLocationId' => 123,
'locationId' => 123,
'brandId' => 123,
'freightTotalBeforeTax' => 123,
'miscTotalBeforeTax' => 123,
'totalBeforeTax' => 123,
'tax' => 123,
'internalNotes' => '<string>',
'incomingLineItems' => [
[
'isEquipmentLine' => true,
'partUomId' => 123,
'partCurrencyId' => '<string>',
'equipmentUomId' => 123,
'equipmentCurrencyId' => '<string>',
'id' => 123,
'status' => '<string>',
'viaStockLocationId' => 123,
'partId' => 123,
'partCatalogId' => 123,
'partQuantity' => 123,
'partCost' => 123,
'equipmentTypeId' => 123,
'equipmentCatalogId' => 123,
'equipmentQuantity' => 123,
'equipmentCost' => 123,
'prLineItemIds' => [
123
],
'warrantyAssetId' => 123,
'glCode' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"OW-KEY: <api-key>",
"X-API-KEY: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useopenwrench.com/api/external/v1/supplier/inventory/purchase_orders"
payload := strings.NewReader("{\n \"status\": \"<string>\",\n \"partEquipmentVendorId\": 123,\n \"currencyId\": \"<string>\",\n \"createdByEmail\": \"<string>\",\n \"totalCost\": 123,\n \"id\": 123,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"paymentTerms\": \"<string>\",\n \"shippingTerms\": \"<string>\",\n \"stockLocationId\": 123,\n \"locationId\": 123,\n \"brandId\": 123,\n \"freightTotalBeforeTax\": 123,\n \"miscTotalBeforeTax\": 123,\n \"totalBeforeTax\": 123,\n \"tax\": 123,\n \"internalNotes\": \"<string>\",\n \"incomingLineItems\": [\n {\n \"isEquipmentLine\": true,\n \"partUomId\": 123,\n \"partCurrencyId\": \"<string>\",\n \"equipmentUomId\": 123,\n \"equipmentCurrencyId\": \"<string>\",\n \"id\": 123,\n \"status\": \"<string>\",\n \"viaStockLocationId\": 123,\n \"partId\": 123,\n \"partCatalogId\": 123,\n \"partQuantity\": 123,\n \"partCost\": 123,\n \"equipmentTypeId\": 123,\n \"equipmentCatalogId\": 123,\n \"equipmentQuantity\": 123,\n \"equipmentCost\": 123,\n \"prLineItemIds\": [\n 123\n ],\n \"warrantyAssetId\": 123,\n \"glCode\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("OW-KEY", "<api-key>")
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.post("https://api.useopenwrench.com/api/external/v1/supplier/inventory/purchase_orders")
.header("X-API-KEY", "<api-key>")
.header("OW-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"<string>\",\n \"partEquipmentVendorId\": 123,\n \"currencyId\": \"<string>\",\n \"createdByEmail\": \"<string>\",\n \"totalCost\": 123,\n \"id\": 123,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"paymentTerms\": \"<string>\",\n \"shippingTerms\": \"<string>\",\n \"stockLocationId\": 123,\n \"locationId\": 123,\n \"brandId\": 123,\n \"freightTotalBeforeTax\": 123,\n \"miscTotalBeforeTax\": 123,\n \"totalBeforeTax\": 123,\n \"tax\": 123,\n \"internalNotes\": \"<string>\",\n \"incomingLineItems\": [\n {\n \"isEquipmentLine\": true,\n \"partUomId\": 123,\n \"partCurrencyId\": \"<string>\",\n \"equipmentUomId\": 123,\n \"equipmentCurrencyId\": \"<string>\",\n \"id\": 123,\n \"status\": \"<string>\",\n \"viaStockLocationId\": 123,\n \"partId\": 123,\n \"partCatalogId\": 123,\n \"partQuantity\": 123,\n \"partCost\": 123,\n \"equipmentTypeId\": 123,\n \"equipmentCatalogId\": 123,\n \"equipmentQuantity\": 123,\n \"equipmentCost\": 123,\n \"prLineItemIds\": [\n 123\n ],\n \"warrantyAssetId\": 123,\n \"glCode\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useopenwrench.com/api/external/v1/supplier/inventory/purchase_orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["OW-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"<string>\",\n \"partEquipmentVendorId\": 123,\n \"currencyId\": \"<string>\",\n \"createdByEmail\": \"<string>\",\n \"totalCost\": 123,\n \"id\": 123,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"paymentTerms\": \"<string>\",\n \"shippingTerms\": \"<string>\",\n \"stockLocationId\": 123,\n \"locationId\": 123,\n \"brandId\": 123,\n \"freightTotalBeforeTax\": 123,\n \"miscTotalBeforeTax\": 123,\n \"totalBeforeTax\": 123,\n \"tax\": 123,\n \"internalNotes\": \"<string>\",\n \"incomingLineItems\": [\n {\n \"isEquipmentLine\": true,\n \"partUomId\": 123,\n \"partCurrencyId\": \"<string>\",\n \"equipmentUomId\": 123,\n \"equipmentCurrencyId\": \"<string>\",\n \"id\": 123,\n \"status\": \"<string>\",\n \"viaStockLocationId\": 123,\n \"partId\": 123,\n \"partCatalogId\": 123,\n \"partQuantity\": 123,\n \"partCost\": 123,\n \"equipmentTypeId\": 123,\n \"equipmentCatalogId\": 123,\n \"equipmentQuantity\": 123,\n \"equipmentCost\": 123,\n \"prLineItemIds\": [\n 123\n ],\n \"warrantyAssetId\": 123,\n \"glCode\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"data": {
"status": "new",
"partEquipmentVendorId": 123,
"currencyId": "<string>",
"supplierFacilityId": 123,
"supplierCompanyId": 123,
"createdByEmail": "<string>",
"isDeleted": true,
"id": 123,
"purchaseOrderUniqueId": 123,
"purchaseOrderUniqueIdWithPrefix": "<string>",
"purchaseOrderCustomIdentifier": "<string>",
"name": "<string>",
"description": "<string>",
"paymentTerms": "<string>",
"shippingTerms": "<string>",
"partEquipmentVendor": {
"name": "<string>",
"currencyId": "<string>",
"isActive": true,
"supplierFacilityId": 123,
"isDeleted": true,
"id": 123,
"vendorId": "<string>",
"address": {},
"email": "<string>",
"logoUrl": "<string>",
"phoneNumber": "<string>",
"paymentTerms": "<string>",
"shippingTerms": "<string>",
"orderingEmails": [
"<string>"
],
"accountManagerEmails": [
"<string>"
],
"accountManagerContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"salesRepEmails": [
"<string>"
],
"salesRepContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"accountsPayableEmails": [
"<string>"
],
"accountsPayableContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"defaultWarrantyMonths": 123,
"notes": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"stockLocationId": 123,
"stockLocation": {
"name": "<string>",
"isMobile": true,
"supplierFacilityId": 123,
"supplierCompanyId": 123,
"isActive": true,
"allowEquipmentForwarding": true,
"isDeleted": true,
"id": 123,
"warehouseId": "<string>",
"images": [
"<string>"
],
"description": "<string>",
"address": {},
"latitude": 123,
"longitude": 123,
"timeZoneId": "<string>",
"locationId": 123,
"burdenRates": [
{
"year": 123,
"rate": "<string>"
}
],
"taxRates": [
{
"year": 123,
"rate": "<string>"
}
],
"purchaseOrderPrefix": "<string>",
"glCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"locationId": 123,
"brandId": 123,
"freightTotalBeforeTax": 123,
"miscTotalBeforeTax": 123,
"totalBeforeTax": 123,
"tax": 123,
"totalCost": 123,
"actualCost": 123,
"partIds": "<string>",
"equipmentTypeIds": "<string>",
"purchaseRequestIds": "<string>",
"notes": [
{
"text": "<string>",
"noteAddedBy": "<string>",
"noteAddedAt": "2023-11-07T05:31:56Z",
"id": 123,
"photo": "<string>",
"video": "<string>",
"audio": "<string>",
"otherFile": "<string>",
"elements": [
{
"type": "<string>",
"value": "<string>",
"userObject": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteReadDetails": [
{
"readAt": "2023-11-07T05:31:56Z",
"readBy": "<string>",
"readByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteAddedByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"noteType": "<string>",
"noteAddedByType": "<string>",
"caption": "<string>",
"isNoteAwaitingResponse": true
}
],
"internalNotes": "<string>",
"partSupplierPurchaseOrderLineItems": [
{
"supplierPurchaseOrderId": 123,
"isEquipmentLine": true,
"partUomId": 123,
"partCurrencyId": "<string>",
"equipmentUomId": 123,
"equipmentCurrencyId": "<string>",
"supplierFacilityId": 123,
"supplierCompanyId": 123,
"isDeleted": true,
"id": 123,
"status": "new",
"stockLocationId": 123,
"locationId": 123,
"viaStockLocationId": 123,
"partId": 123,
"part": {
"name": "<string>",
"uomId": 123,
"isActive": true,
"isStocked": true,
"supplierCompanyId": 123,
"isDeleted": true,
"id": 123,
"partUUID": "<string>",
"manufacturerId": "<string>",
"manufacturerName": "<string>",
"partNumber": "<string>",
"aliasPartId": "<string>",
"images": [
"<string>"
],
"description": "<string>",
"cost": 123,
"defaultVendorId": 123,
"defaultVendor": {
"name": "<string>",
"currencyId": "<string>",
"isActive": true,
"supplierFacilityId": 123,
"isDeleted": true,
"id": 123,
"vendorId": "<string>",
"address": {},
"email": "<string>",
"logoUrl": "<string>",
"phoneNumber": "<string>",
"paymentTerms": "<string>",
"shippingTerms": "<string>",
"orderingEmails": [
"<string>"
],
"accountManagerEmails": [
"<string>"
],
"accountManagerContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"salesRepEmails": [
"<string>"
],
"salesRepContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"accountsPayableEmails": [
"<string>"
],
"accountsPayableContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"defaultWarrantyMonths": 123,
"notes": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"defaultPartCatalogId": 123,
"assetTypeId": 123,
"assetModelId": 123,
"glCode": "<string>",
"partEquipmentVendorCount": 123,
"labelIds": [
123
],
"labels": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"partCatalogId": 123,
"partQuantity": 123,
"partCost": 123,
"partReceivedQuantity": 123,
"partReceivedAverageCost": 123,
"equipmentTypeId": 123,
"equipmentType": {
"modelName": "<string>",
"isActive": true,
"supplierFacilityId": 123,
"supplierCompanyId": 123,
"isDeleted": true,
"id": 123,
"equipmentTypeNumber": "<string>",
"aliasEquipmentTypeNumber": "<string>",
"manufacturerId": "<string>",
"manufacturerName": "<string>",
"images": [
"<string>"
],
"description": "<string>",
"cost": 123,
"defaultVendorId": 123,
"defaultVendor": {
"name": "<string>",
"currencyId": "<string>",
"isActive": true,
"supplierFacilityId": 123,
"isDeleted": true,
"id": 123,
"vendorId": "<string>",
"address": {},
"email": "<string>",
"logoUrl": "<string>",
"phoneNumber": "<string>",
"paymentTerms": "<string>",
"shippingTerms": "<string>",
"orderingEmails": [
"<string>"
],
"accountManagerEmails": [
"<string>"
],
"accountManagerContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"salesRepEmails": [
"<string>"
],
"salesRepContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"accountsPayableEmails": [
"<string>"
],
"accountsPayableContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"defaultWarrantyMonths": 123,
"notes": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"defaultEquipmentCatalogId": 123,
"assetTypeId": 123,
"assetType": {
"name": "<string>",
"usesRefrigerant": true,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"primarySpendCategory": 123,
"attachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"allProblemTypeIds": [
123
],
"allProblemTypeIdsAsString": "<string>",
"allProblemTypes": [
{
"id": 123,
"name": "<string>",
"buyerCompanyId": 123,
"hasChildren": true
}
],
"allProblemTypesName": "<string>",
"allSpendCategories": [
123
],
"depreciationClassId": 123,
"depreciationClassName": "<string>",
"requiredFields": [
{}
],
"optionalFields": [
{}
],
"replaceMarkupOnOriginalCost": 123,
"replacementThreshold": 123,
"applianceCategory": "<string>",
"refrigerantTypeCode": "<string>",
"fullChargeLb": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"glCode": "<string>",
"partEquipmentVendorCount": 123,
"isAssociatedWithOtherEntities": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"equipmentCatalogId": 123,
"equipmentQuantity": 123,
"equipmentCost": 123,
"equipmentReceivedQuantity": 123,
"equipmentReceivedAverageCost": 123,
"prLineItemIds": [
123
],
"warrantyAssetId": 123,
"glCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"equipmentSupplierPurchaseOrderLineItems": [
{
"supplierPurchaseOrderId": 123,
"isEquipmentLine": true,
"partUomId": 123,
"partCurrencyId": "<string>",
"equipmentUomId": 123,
"equipmentCurrencyId": "<string>",
"supplierFacilityId": 123,
"supplierCompanyId": 123,
"isDeleted": true,
"id": 123,
"status": "new",
"stockLocationId": 123,
"locationId": 123,
"viaStockLocationId": 123,
"partId": 123,
"part": {
"name": "<string>",
"uomId": 123,
"isActive": true,
"isStocked": true,
"supplierCompanyId": 123,
"isDeleted": true,
"id": 123,
"partUUID": "<string>",
"manufacturerId": "<string>",
"manufacturerName": "<string>",
"partNumber": "<string>",
"aliasPartId": "<string>",
"images": [
"<string>"
],
"description": "<string>",
"cost": 123,
"defaultVendorId": 123,
"defaultVendor": {
"name": "<string>",
"currencyId": "<string>",
"isActive": true,
"supplierFacilityId": 123,
"isDeleted": true,
"id": 123,
"vendorId": "<string>",
"address": {},
"email": "<string>",
"logoUrl": "<string>",
"phoneNumber": "<string>",
"paymentTerms": "<string>",
"shippingTerms": "<string>",
"orderingEmails": [
"<string>"
],
"accountManagerEmails": [
"<string>"
],
"accountManagerContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"salesRepEmails": [
"<string>"
],
"salesRepContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"accountsPayableEmails": [
"<string>"
],
"accountsPayableContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"defaultWarrantyMonths": 123,
"notes": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"defaultPartCatalogId": 123,
"assetTypeId": 123,
"assetModelId": 123,
"glCode": "<string>",
"partEquipmentVendorCount": 123,
"labelIds": [
123
],
"labels": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"partCatalogId": 123,
"partQuantity": 123,
"partCost": 123,
"partReceivedQuantity": 123,
"partReceivedAverageCost": 123,
"equipmentTypeId": 123,
"equipmentType": {
"modelName": "<string>",
"isActive": true,
"supplierFacilityId": 123,
"supplierCompanyId": 123,
"isDeleted": true,
"id": 123,
"equipmentTypeNumber": "<string>",
"aliasEquipmentTypeNumber": "<string>",
"manufacturerId": "<string>",
"manufacturerName": "<string>",
"images": [
"<string>"
],
"description": "<string>",
"cost": 123,
"defaultVendorId": 123,
"defaultVendor": {
"name": "<string>",
"currencyId": "<string>",
"isActive": true,
"supplierFacilityId": 123,
"isDeleted": true,
"id": 123,
"vendorId": "<string>",
"address": {},
"email": "<string>",
"logoUrl": "<string>",
"phoneNumber": "<string>",
"paymentTerms": "<string>",
"shippingTerms": "<string>",
"orderingEmails": [
"<string>"
],
"accountManagerEmails": [
"<string>"
],
"accountManagerContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"salesRepEmails": [
"<string>"
],
"salesRepContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"accountsPayableEmails": [
"<string>"
],
"accountsPayableContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"defaultWarrantyMonths": 123,
"notes": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"defaultEquipmentCatalogId": 123,
"assetTypeId": 123,
"assetType": {
"name": "<string>",
"usesRefrigerant": true,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"primarySpendCategory": 123,
"attachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"allProblemTypeIds": [
123
],
"allProblemTypeIdsAsString": "<string>",
"allProblemTypes": [
{
"id": 123,
"name": "<string>",
"buyerCompanyId": 123,
"hasChildren": true
}
],
"allProblemTypesName": "<string>",
"allSpendCategories": [
123
],
"depreciationClassId": 123,
"depreciationClassName": "<string>",
"requiredFields": [
{}
],
"optionalFields": [
{}
],
"replaceMarkupOnOriginalCost": 123,
"replacementThreshold": 123,
"applianceCategory": "<string>",
"refrigerantTypeCode": "<string>",
"fullChargeLb": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"glCode": "<string>",
"partEquipmentVendorCount": 123,
"isAssociatedWithOtherEntities": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"equipmentCatalogId": 123,
"equipmentQuantity": 123,
"equipmentCost": 123,
"equipmentReceivedQuantity": 123,
"equipmentReceivedAverageCost": 123,
"prLineItemIds": [
123
],
"warrantyAssetId": 123,
"glCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"incomingLineItems": [
{
"isEquipmentLine": true,
"partUomId": 123,
"partCurrencyId": "<string>",
"equipmentUomId": 123,
"equipmentCurrencyId": "<string>",
"id": 123,
"status": "<string>",
"viaStockLocationId": 123,
"partId": 123,
"partCatalogId": 123,
"partQuantity": 123,
"partCost": 123,
"equipmentTypeId": 123,
"equipmentCatalogId": 123,
"equipmentQuantity": 123,
"equipmentCost": 123,
"prLineItemIds": [
123
],
"warrantyAssetId": 123,
"glCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"integratorName": "<string>",
"integratorStatus": "<string>",
"dueDate": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"status": "ok"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}Purchase Orders
Create a purchase order
Creates a purchase order (with its line items) for the API key’s supplier facility. Service-level validation failures are returned as 400 with the error envelope.
POST
/
v1
/
supplier
/
inventory
/
purchase_orders
Create a purchase order
curl --request POST \
--url https://api.useopenwrench.com/api/external/v1/supplier/inventory/purchase_orders \
--header 'Content-Type: application/json' \
--header 'OW-KEY: <api-key>' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"status": "<string>",
"partEquipmentVendorId": 123,
"currencyId": "<string>",
"createdByEmail": "<string>",
"totalCost": 123,
"id": 123,
"name": "<string>",
"description": "<string>",
"paymentTerms": "<string>",
"shippingTerms": "<string>",
"stockLocationId": 123,
"locationId": 123,
"brandId": 123,
"freightTotalBeforeTax": 123,
"miscTotalBeforeTax": 123,
"totalBeforeTax": 123,
"tax": 123,
"internalNotes": "<string>",
"incomingLineItems": [
{
"isEquipmentLine": true,
"partUomId": 123,
"partCurrencyId": "<string>",
"equipmentUomId": 123,
"equipmentCurrencyId": "<string>",
"id": 123,
"status": "<string>",
"viaStockLocationId": 123,
"partId": 123,
"partCatalogId": 123,
"partQuantity": 123,
"partCost": 123,
"equipmentTypeId": 123,
"equipmentCatalogId": 123,
"equipmentQuantity": 123,
"equipmentCost": 123,
"prLineItemIds": [
123
],
"warrantyAssetId": 123,
"glCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
]
}
'import requests
url = "https://api.useopenwrench.com/api/external/v1/supplier/inventory/purchase_orders"
payload = {
"status": "<string>",
"partEquipmentVendorId": 123,
"currencyId": "<string>",
"createdByEmail": "<string>",
"totalCost": 123,
"id": 123,
"name": "<string>",
"description": "<string>",
"paymentTerms": "<string>",
"shippingTerms": "<string>",
"stockLocationId": 123,
"locationId": 123,
"brandId": 123,
"freightTotalBeforeTax": 123,
"miscTotalBeforeTax": 123,
"totalBeforeTax": 123,
"tax": 123,
"internalNotes": "<string>",
"incomingLineItems": [
{
"isEquipmentLine": True,
"partUomId": 123,
"partCurrencyId": "<string>",
"equipmentUomId": 123,
"equipmentCurrencyId": "<string>",
"id": 123,
"status": "<string>",
"viaStockLocationId": 123,
"partId": 123,
"partCatalogId": 123,
"partQuantity": 123,
"partCost": 123,
"equipmentTypeId": 123,
"equipmentCatalogId": 123,
"equipmentQuantity": 123,
"equipmentCost": 123,
"prLineItemIds": [123],
"warrantyAssetId": 123,
"glCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
]
}
headers = {
"X-API-KEY": "<api-key>",
"OW-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-KEY': '<api-key>',
'OW-KEY': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
status: '<string>',
partEquipmentVendorId: 123,
currencyId: '<string>',
createdByEmail: '<string>',
totalCost: 123,
id: 123,
name: '<string>',
description: '<string>',
paymentTerms: '<string>',
shippingTerms: '<string>',
stockLocationId: 123,
locationId: 123,
brandId: 123,
freightTotalBeforeTax: 123,
miscTotalBeforeTax: 123,
totalBeforeTax: 123,
tax: 123,
internalNotes: '<string>',
incomingLineItems: [
{
isEquipmentLine: true,
partUomId: 123,
partCurrencyId: '<string>',
equipmentUomId: 123,
equipmentCurrencyId: '<string>',
id: 123,
status: '<string>',
viaStockLocationId: 123,
partId: 123,
partCatalogId: 123,
partQuantity: 123,
partCost: 123,
equipmentTypeId: 123,
equipmentCatalogId: 123,
equipmentQuantity: 123,
equipmentCost: 123,
prLineItemIds: [123],
warrantyAssetId: 123,
glCode: '<string>',
createdAt: '2023-11-07T05:31:56Z'
}
]
})
};
fetch('https://api.useopenwrench.com/api/external/v1/supplier/inventory/purchase_orders', 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.useopenwrench.com/api/external/v1/supplier/inventory/purchase_orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'status' => '<string>',
'partEquipmentVendorId' => 123,
'currencyId' => '<string>',
'createdByEmail' => '<string>',
'totalCost' => 123,
'id' => 123,
'name' => '<string>',
'description' => '<string>',
'paymentTerms' => '<string>',
'shippingTerms' => '<string>',
'stockLocationId' => 123,
'locationId' => 123,
'brandId' => 123,
'freightTotalBeforeTax' => 123,
'miscTotalBeforeTax' => 123,
'totalBeforeTax' => 123,
'tax' => 123,
'internalNotes' => '<string>',
'incomingLineItems' => [
[
'isEquipmentLine' => true,
'partUomId' => 123,
'partCurrencyId' => '<string>',
'equipmentUomId' => 123,
'equipmentCurrencyId' => '<string>',
'id' => 123,
'status' => '<string>',
'viaStockLocationId' => 123,
'partId' => 123,
'partCatalogId' => 123,
'partQuantity' => 123,
'partCost' => 123,
'equipmentTypeId' => 123,
'equipmentCatalogId' => 123,
'equipmentQuantity' => 123,
'equipmentCost' => 123,
'prLineItemIds' => [
123
],
'warrantyAssetId' => 123,
'glCode' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"OW-KEY: <api-key>",
"X-API-KEY: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useopenwrench.com/api/external/v1/supplier/inventory/purchase_orders"
payload := strings.NewReader("{\n \"status\": \"<string>\",\n \"partEquipmentVendorId\": 123,\n \"currencyId\": \"<string>\",\n \"createdByEmail\": \"<string>\",\n \"totalCost\": 123,\n \"id\": 123,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"paymentTerms\": \"<string>\",\n \"shippingTerms\": \"<string>\",\n \"stockLocationId\": 123,\n \"locationId\": 123,\n \"brandId\": 123,\n \"freightTotalBeforeTax\": 123,\n \"miscTotalBeforeTax\": 123,\n \"totalBeforeTax\": 123,\n \"tax\": 123,\n \"internalNotes\": \"<string>\",\n \"incomingLineItems\": [\n {\n \"isEquipmentLine\": true,\n \"partUomId\": 123,\n \"partCurrencyId\": \"<string>\",\n \"equipmentUomId\": 123,\n \"equipmentCurrencyId\": \"<string>\",\n \"id\": 123,\n \"status\": \"<string>\",\n \"viaStockLocationId\": 123,\n \"partId\": 123,\n \"partCatalogId\": 123,\n \"partQuantity\": 123,\n \"partCost\": 123,\n \"equipmentTypeId\": 123,\n \"equipmentCatalogId\": 123,\n \"equipmentQuantity\": 123,\n \"equipmentCost\": 123,\n \"prLineItemIds\": [\n 123\n ],\n \"warrantyAssetId\": 123,\n \"glCode\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("OW-KEY", "<api-key>")
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.post("https://api.useopenwrench.com/api/external/v1/supplier/inventory/purchase_orders")
.header("X-API-KEY", "<api-key>")
.header("OW-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"<string>\",\n \"partEquipmentVendorId\": 123,\n \"currencyId\": \"<string>\",\n \"createdByEmail\": \"<string>\",\n \"totalCost\": 123,\n \"id\": 123,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"paymentTerms\": \"<string>\",\n \"shippingTerms\": \"<string>\",\n \"stockLocationId\": 123,\n \"locationId\": 123,\n \"brandId\": 123,\n \"freightTotalBeforeTax\": 123,\n \"miscTotalBeforeTax\": 123,\n \"totalBeforeTax\": 123,\n \"tax\": 123,\n \"internalNotes\": \"<string>\",\n \"incomingLineItems\": [\n {\n \"isEquipmentLine\": true,\n \"partUomId\": 123,\n \"partCurrencyId\": \"<string>\",\n \"equipmentUomId\": 123,\n \"equipmentCurrencyId\": \"<string>\",\n \"id\": 123,\n \"status\": \"<string>\",\n \"viaStockLocationId\": 123,\n \"partId\": 123,\n \"partCatalogId\": 123,\n \"partQuantity\": 123,\n \"partCost\": 123,\n \"equipmentTypeId\": 123,\n \"equipmentCatalogId\": 123,\n \"equipmentQuantity\": 123,\n \"equipmentCost\": 123,\n \"prLineItemIds\": [\n 123\n ],\n \"warrantyAssetId\": 123,\n \"glCode\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useopenwrench.com/api/external/v1/supplier/inventory/purchase_orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["OW-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"<string>\",\n \"partEquipmentVendorId\": 123,\n \"currencyId\": \"<string>\",\n \"createdByEmail\": \"<string>\",\n \"totalCost\": 123,\n \"id\": 123,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"paymentTerms\": \"<string>\",\n \"shippingTerms\": \"<string>\",\n \"stockLocationId\": 123,\n \"locationId\": 123,\n \"brandId\": 123,\n \"freightTotalBeforeTax\": 123,\n \"miscTotalBeforeTax\": 123,\n \"totalBeforeTax\": 123,\n \"tax\": 123,\n \"internalNotes\": \"<string>\",\n \"incomingLineItems\": [\n {\n \"isEquipmentLine\": true,\n \"partUomId\": 123,\n \"partCurrencyId\": \"<string>\",\n \"equipmentUomId\": 123,\n \"equipmentCurrencyId\": \"<string>\",\n \"id\": 123,\n \"status\": \"<string>\",\n \"viaStockLocationId\": 123,\n \"partId\": 123,\n \"partCatalogId\": 123,\n \"partQuantity\": 123,\n \"partCost\": 123,\n \"equipmentTypeId\": 123,\n \"equipmentCatalogId\": 123,\n \"equipmentQuantity\": 123,\n \"equipmentCost\": 123,\n \"prLineItemIds\": [\n 123\n ],\n \"warrantyAssetId\": 123,\n \"glCode\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"data": {
"status": "new",
"partEquipmentVendorId": 123,
"currencyId": "<string>",
"supplierFacilityId": 123,
"supplierCompanyId": 123,
"createdByEmail": "<string>",
"isDeleted": true,
"id": 123,
"purchaseOrderUniqueId": 123,
"purchaseOrderUniqueIdWithPrefix": "<string>",
"purchaseOrderCustomIdentifier": "<string>",
"name": "<string>",
"description": "<string>",
"paymentTerms": "<string>",
"shippingTerms": "<string>",
"partEquipmentVendor": {
"name": "<string>",
"currencyId": "<string>",
"isActive": true,
"supplierFacilityId": 123,
"isDeleted": true,
"id": 123,
"vendorId": "<string>",
"address": {},
"email": "<string>",
"logoUrl": "<string>",
"phoneNumber": "<string>",
"paymentTerms": "<string>",
"shippingTerms": "<string>",
"orderingEmails": [
"<string>"
],
"accountManagerEmails": [
"<string>"
],
"accountManagerContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"salesRepEmails": [
"<string>"
],
"salesRepContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"accountsPayableEmails": [
"<string>"
],
"accountsPayableContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"defaultWarrantyMonths": 123,
"notes": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"stockLocationId": 123,
"stockLocation": {
"name": "<string>",
"isMobile": true,
"supplierFacilityId": 123,
"supplierCompanyId": 123,
"isActive": true,
"allowEquipmentForwarding": true,
"isDeleted": true,
"id": 123,
"warehouseId": "<string>",
"images": [
"<string>"
],
"description": "<string>",
"address": {},
"latitude": 123,
"longitude": 123,
"timeZoneId": "<string>",
"locationId": 123,
"burdenRates": [
{
"year": 123,
"rate": "<string>"
}
],
"taxRates": [
{
"year": 123,
"rate": "<string>"
}
],
"purchaseOrderPrefix": "<string>",
"glCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"locationId": 123,
"brandId": 123,
"freightTotalBeforeTax": 123,
"miscTotalBeforeTax": 123,
"totalBeforeTax": 123,
"tax": 123,
"totalCost": 123,
"actualCost": 123,
"partIds": "<string>",
"equipmentTypeIds": "<string>",
"purchaseRequestIds": "<string>",
"notes": [
{
"text": "<string>",
"noteAddedBy": "<string>",
"noteAddedAt": "2023-11-07T05:31:56Z",
"id": 123,
"photo": "<string>",
"video": "<string>",
"audio": "<string>",
"otherFile": "<string>",
"elements": [
{
"type": "<string>",
"value": "<string>",
"userObject": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteReadDetails": [
{
"readAt": "2023-11-07T05:31:56Z",
"readBy": "<string>",
"readByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteAddedByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"noteType": "<string>",
"noteAddedByType": "<string>",
"caption": "<string>",
"isNoteAwaitingResponse": true
}
],
"internalNotes": "<string>",
"partSupplierPurchaseOrderLineItems": [
{
"supplierPurchaseOrderId": 123,
"isEquipmentLine": true,
"partUomId": 123,
"partCurrencyId": "<string>",
"equipmentUomId": 123,
"equipmentCurrencyId": "<string>",
"supplierFacilityId": 123,
"supplierCompanyId": 123,
"isDeleted": true,
"id": 123,
"status": "new",
"stockLocationId": 123,
"locationId": 123,
"viaStockLocationId": 123,
"partId": 123,
"part": {
"name": "<string>",
"uomId": 123,
"isActive": true,
"isStocked": true,
"supplierCompanyId": 123,
"isDeleted": true,
"id": 123,
"partUUID": "<string>",
"manufacturerId": "<string>",
"manufacturerName": "<string>",
"partNumber": "<string>",
"aliasPartId": "<string>",
"images": [
"<string>"
],
"description": "<string>",
"cost": 123,
"defaultVendorId": 123,
"defaultVendor": {
"name": "<string>",
"currencyId": "<string>",
"isActive": true,
"supplierFacilityId": 123,
"isDeleted": true,
"id": 123,
"vendorId": "<string>",
"address": {},
"email": "<string>",
"logoUrl": "<string>",
"phoneNumber": "<string>",
"paymentTerms": "<string>",
"shippingTerms": "<string>",
"orderingEmails": [
"<string>"
],
"accountManagerEmails": [
"<string>"
],
"accountManagerContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"salesRepEmails": [
"<string>"
],
"salesRepContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"accountsPayableEmails": [
"<string>"
],
"accountsPayableContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"defaultWarrantyMonths": 123,
"notes": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"defaultPartCatalogId": 123,
"assetTypeId": 123,
"assetModelId": 123,
"glCode": "<string>",
"partEquipmentVendorCount": 123,
"labelIds": [
123
],
"labels": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"partCatalogId": 123,
"partQuantity": 123,
"partCost": 123,
"partReceivedQuantity": 123,
"partReceivedAverageCost": 123,
"equipmentTypeId": 123,
"equipmentType": {
"modelName": "<string>",
"isActive": true,
"supplierFacilityId": 123,
"supplierCompanyId": 123,
"isDeleted": true,
"id": 123,
"equipmentTypeNumber": "<string>",
"aliasEquipmentTypeNumber": "<string>",
"manufacturerId": "<string>",
"manufacturerName": "<string>",
"images": [
"<string>"
],
"description": "<string>",
"cost": 123,
"defaultVendorId": 123,
"defaultVendor": {
"name": "<string>",
"currencyId": "<string>",
"isActive": true,
"supplierFacilityId": 123,
"isDeleted": true,
"id": 123,
"vendorId": "<string>",
"address": {},
"email": "<string>",
"logoUrl": "<string>",
"phoneNumber": "<string>",
"paymentTerms": "<string>",
"shippingTerms": "<string>",
"orderingEmails": [
"<string>"
],
"accountManagerEmails": [
"<string>"
],
"accountManagerContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"salesRepEmails": [
"<string>"
],
"salesRepContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"accountsPayableEmails": [
"<string>"
],
"accountsPayableContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"defaultWarrantyMonths": 123,
"notes": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"defaultEquipmentCatalogId": 123,
"assetTypeId": 123,
"assetType": {
"name": "<string>",
"usesRefrigerant": true,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"primarySpendCategory": 123,
"attachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"allProblemTypeIds": [
123
],
"allProblemTypeIdsAsString": "<string>",
"allProblemTypes": [
{
"id": 123,
"name": "<string>",
"buyerCompanyId": 123,
"hasChildren": true
}
],
"allProblemTypesName": "<string>",
"allSpendCategories": [
123
],
"depreciationClassId": 123,
"depreciationClassName": "<string>",
"requiredFields": [
{}
],
"optionalFields": [
{}
],
"replaceMarkupOnOriginalCost": 123,
"replacementThreshold": 123,
"applianceCategory": "<string>",
"refrigerantTypeCode": "<string>",
"fullChargeLb": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"glCode": "<string>",
"partEquipmentVendorCount": 123,
"isAssociatedWithOtherEntities": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"equipmentCatalogId": 123,
"equipmentQuantity": 123,
"equipmentCost": 123,
"equipmentReceivedQuantity": 123,
"equipmentReceivedAverageCost": 123,
"prLineItemIds": [
123
],
"warrantyAssetId": 123,
"glCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"equipmentSupplierPurchaseOrderLineItems": [
{
"supplierPurchaseOrderId": 123,
"isEquipmentLine": true,
"partUomId": 123,
"partCurrencyId": "<string>",
"equipmentUomId": 123,
"equipmentCurrencyId": "<string>",
"supplierFacilityId": 123,
"supplierCompanyId": 123,
"isDeleted": true,
"id": 123,
"status": "new",
"stockLocationId": 123,
"locationId": 123,
"viaStockLocationId": 123,
"partId": 123,
"part": {
"name": "<string>",
"uomId": 123,
"isActive": true,
"isStocked": true,
"supplierCompanyId": 123,
"isDeleted": true,
"id": 123,
"partUUID": "<string>",
"manufacturerId": "<string>",
"manufacturerName": "<string>",
"partNumber": "<string>",
"aliasPartId": "<string>",
"images": [
"<string>"
],
"description": "<string>",
"cost": 123,
"defaultVendorId": 123,
"defaultVendor": {
"name": "<string>",
"currencyId": "<string>",
"isActive": true,
"supplierFacilityId": 123,
"isDeleted": true,
"id": 123,
"vendorId": "<string>",
"address": {},
"email": "<string>",
"logoUrl": "<string>",
"phoneNumber": "<string>",
"paymentTerms": "<string>",
"shippingTerms": "<string>",
"orderingEmails": [
"<string>"
],
"accountManagerEmails": [
"<string>"
],
"accountManagerContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"salesRepEmails": [
"<string>"
],
"salesRepContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"accountsPayableEmails": [
"<string>"
],
"accountsPayableContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"defaultWarrantyMonths": 123,
"notes": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"defaultPartCatalogId": 123,
"assetTypeId": 123,
"assetModelId": 123,
"glCode": "<string>",
"partEquipmentVendorCount": 123,
"labelIds": [
123
],
"labels": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"partCatalogId": 123,
"partQuantity": 123,
"partCost": 123,
"partReceivedQuantity": 123,
"partReceivedAverageCost": 123,
"equipmentTypeId": 123,
"equipmentType": {
"modelName": "<string>",
"isActive": true,
"supplierFacilityId": 123,
"supplierCompanyId": 123,
"isDeleted": true,
"id": 123,
"equipmentTypeNumber": "<string>",
"aliasEquipmentTypeNumber": "<string>",
"manufacturerId": "<string>",
"manufacturerName": "<string>",
"images": [
"<string>"
],
"description": "<string>",
"cost": 123,
"defaultVendorId": 123,
"defaultVendor": {
"name": "<string>",
"currencyId": "<string>",
"isActive": true,
"supplierFacilityId": 123,
"isDeleted": true,
"id": 123,
"vendorId": "<string>",
"address": {},
"email": "<string>",
"logoUrl": "<string>",
"phoneNumber": "<string>",
"paymentTerms": "<string>",
"shippingTerms": "<string>",
"orderingEmails": [
"<string>"
],
"accountManagerEmails": [
"<string>"
],
"accountManagerContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"salesRepEmails": [
"<string>"
],
"salesRepContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"accountsPayableEmails": [
"<string>"
],
"accountsPayableContacts": [
{
"email": "<string>",
"name": "<string>",
"vendorId": 123,
"supplierFacilityId": 123,
"phoneNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"defaultWarrantyMonths": 123,
"notes": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"defaultEquipmentCatalogId": 123,
"assetTypeId": 123,
"assetType": {
"name": "<string>",
"usesRefrigerant": true,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"primarySpendCategory": 123,
"attachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"allProblemTypeIds": [
123
],
"allProblemTypeIdsAsString": "<string>",
"allProblemTypes": [
{
"id": 123,
"name": "<string>",
"buyerCompanyId": 123,
"hasChildren": true
}
],
"allProblemTypesName": "<string>",
"allSpendCategories": [
123
],
"depreciationClassId": 123,
"depreciationClassName": "<string>",
"requiredFields": [
{}
],
"optionalFields": [
{}
],
"replaceMarkupOnOriginalCost": 123,
"replacementThreshold": 123,
"applianceCategory": "<string>",
"refrigerantTypeCode": "<string>",
"fullChargeLb": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"glCode": "<string>",
"partEquipmentVendorCount": 123,
"isAssociatedWithOtherEntities": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"equipmentCatalogId": 123,
"equipmentQuantity": 123,
"equipmentCost": 123,
"equipmentReceivedQuantity": 123,
"equipmentReceivedAverageCost": 123,
"prLineItemIds": [
123
],
"warrantyAssetId": 123,
"glCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"incomingLineItems": [
{
"isEquipmentLine": true,
"partUomId": 123,
"partCurrencyId": "<string>",
"equipmentUomId": 123,
"equipmentCurrencyId": "<string>",
"id": 123,
"status": "<string>",
"viaStockLocationId": 123,
"partId": 123,
"partCatalogId": 123,
"partQuantity": 123,
"partCost": 123,
"equipmentTypeId": 123,
"equipmentCatalogId": 123,
"equipmentQuantity": 123,
"equipmentCost": 123,
"prLineItemIds": [
123
],
"warrantyAssetId": 123,
"glCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"integratorName": "<string>",
"integratorStatus": "<string>",
"dueDate": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"status": "ok"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}Authorizations
OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key.
Body
application/json
Purchase-order create payload (verified against the shared purchase-order constructor). supplierCompanyId and supplierFacilityId are always overwritten from the API key's contact; caller values for them are ignored. dueDate is NOT consumed by this endpoint. Unknown fields are ignored.
REQUIRED. Status name, e.g. new / ordered / received / cancelled / closed / partially_received
REQUIRED. Vendor the order is placed with
REQUIRED
REQUIRED
Required unless the supplier company's inventory settings mark PO cost as not mandatory (isPoCostMandatory=false)
Existing purchase order id (update semantics); must exist when given
Show child attributes
Show child attributes
Response
Successful response
Entity type label, e.g. "SupplierPurchaseOrder". Endpoints that derive it via Scala reflection (most generic list/get endpoints) may return the fully qualified server class name instead (e.g. "models.workorder.WorkOrder"); treat this field as informational.
Supplier purchase order (hydrated location/brand/currency and deleted-line-item fields omitted).
Show child attributes
Show child attributes
"ok" on success
Available options:
ok