GET v1/purchaseOrder/detail/{purchaseOrderID}

Retrieve detailed information about a Purchase Order by unique identifier

Request Information

URI Parameters

NameDescriptionTypeAdditional information
purchaseOrderID

integer

Required

Body Parameters

None.

Response Information

Resource Description

PurchaseOrderModel
NameDescriptionTypeAdditional information
PurchaseOrderID

Unique identifier of a Purchase Order

integer

None.

PONumber

The Purchase Order number

string

None.

PODate

The Purchase Order date

date

None.

DeliveryDate

The Purchase Order delivery date

date

None.

POStatus

The status of the Purchase Order

PurchaseOrderStatusModel

None.

Supplier

The location associated with the source location

LocationModel

None.

Location

The location associated with the Purchase Order

LocationModel

None.

Total

The Purchase Order total

decimal number

None.

Currency

The currency of the Purchase Order

CurrencyModel

None.

Notes

Notes

string

None.

Items

List of Line Items on the Purchase Order

Collection of PurchaseOrderItemModel

None.

FileCount

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "purchaseOrderID": 1,
  "poNumber": "sample string 2",
  "poDate": "2025-11-08T08:24:32.2615365+00:00",
  "deliveryDate": "2025-11-08T08:24:32.2615365+00:00",
  "poStatus": {
    "purchaseOrderStatusID": 1,
    "purchaseOrderStatus": "sample string 2"
  },
  "supplier": {
    "locationID": 1,
    "company": {
      "companyID": 1,
      "companyName": "sample string 2",
      "companyCode": "sample string 3",
      "vatNumber": "sample string 4",
      "address1": "sample string 5",
      "address2": "sample string 6",
      "address3": "sample string 7",
      "address4": "sample string 8",
      "address5": "sample string 9",
      "email": "sample string 10",
      "currentRates": [
        {
          "companyRateID": 1,
          "rate": 2.0,
          "supportLevel": {
            "supportLevelID": 1,
            "supportLevel": "sample string 2"
          },
          "startDate": "2025-11-08T08:24:32.2615365+00:00"
        },
        {
          "companyRateID": 1,
          "rate": 2.0,
          "supportLevel": {
            "supportLevelID": 1,
            "supportLevel": "sample string 2"
          },
          "startDate": "2025-11-08T08:24:32.2615365+00:00"
        }
      ]
    },
    "isActive": true,
    "isKeyAccount": true,
    "locationCategory": {
      "locationCategoryID": 1,
      "locationCategory": "sample string 2",
      "isSystem": true
    },
    "locationName": "sample string 4",
    "address": "sample string 5",
    "address2": "sample string 6",
    "address3": "sample string 7",
    "city": "sample string 8",
    "state": {
      "stateID": 1,
      "stateShortName": "sample string 2",
      "stateLongName": "sample string 3"
    },
    "zipCode": "sample string 9",
    "country": {
      "countryID": 1,
      "countryShortName": "sample string 2",
      "countryLongName": "sample string 3"
    },
    "cityStateZipCountry": "sample string 10",
    "xCoordinate": "sample string 11",
    "yCoordinate": "sample string 12",
    "googlePlaceID": "sample string 13",
    "googleURL": "sample string 14",
    "term": {
      "termID": 1,
      "term": "sample string 2",
      "isActive": true
    },
    "bolTemplate": {
      "bolTemplateID": 1,
      "templateName": "sample string 2"
    },
    "isIntegrationControlled": true,
    "locationRules": {
      "locationRuleID": 1,
      "shipMethod": {
        "shipMethodID": 1,
        "shipMethod": "sample string 2"
      },
      "isLocked": true,
      "canSelfOrder": true,
      "additionalBillingDays": 4,
      "allowUDFAddress": true,
      "palletLabelQuantity": 6,
      "returnFlagType": {
        "flagTypeID": 1,
        "flagType": "sample string 2",
        "isActive": true,
        "isSystem": true,
        "isCleared": true,
        "isDefault": true,
        "isRepair": true,
        "isAdmin": true,
        "isRepairComponent": true
      },
      "returnFlagBarcodePrefix": "sample string 7"
    }
  },
  "location": {
    "locationID": 1,
    "company": {
      "companyID": 1,
      "companyName": "sample string 2",
      "companyCode": "sample string 3",
      "vatNumber": "sample string 4",
      "address1": "sample string 5",
      "address2": "sample string 6",
      "address3": "sample string 7",
      "address4": "sample string 8",
      "address5": "sample string 9",
      "email": "sample string 10",
      "currentRates": [
        {
          "companyRateID": 1,
          "rate": 2.0,
          "supportLevel": {
            "supportLevelID": 1,
            "supportLevel": "sample string 2"
          },
          "startDate": "2025-11-08T08:24:32.2615365+00:00"
        },
        {
          "companyRateID": 1,
          "rate": 2.0,
          "supportLevel": {
            "supportLevelID": 1,
            "supportLevel": "sample string 2"
          },
          "startDate": "2025-11-08T08:24:32.2615365+00:00"
        }
      ]
    },
    "isActive": true,
    "isKeyAccount": true,
    "locationCategory": {
      "locationCategoryID": 1,
      "locationCategory": "sample string 2",
      "isSystem": true
    },
    "locationName": "sample string 4",
    "address": "sample string 5",
    "address2": "sample string 6",
    "address3": "sample string 7",
    "city": "sample string 8",
    "state": {
      "stateID": 1,
      "stateShortName": "sample string 2",
      "stateLongName": "sample string 3"
    },
    "zipCode": "sample string 9",
    "country": {
      "countryID": 1,
      "countryShortName": "sample string 2",
      "countryLongName": "sample string 3"
    },
    "cityStateZipCountry": "sample string 10",
    "xCoordinate": "sample string 11",
    "yCoordinate": "sample string 12",
    "googlePlaceID": "sample string 13",
    "googleURL": "sample string 14",
    "term": {
      "termID": 1,
      "term": "sample string 2",
      "isActive": true
    },
    "bolTemplate": {
      "bolTemplateID": 1,
      "templateName": "sample string 2"
    },
    "isIntegrationControlled": true,
    "locationRules": {
      "locationRuleID": 1,
      "shipMethod": {
        "shipMethodID": 1,
        "shipMethod": "sample string 2"
      },
      "isLocked": true,
      "canSelfOrder": true,
      "additionalBillingDays": 4,
      "allowUDFAddress": true,
      "palletLabelQuantity": 6,
      "returnFlagType": {
        "flagTypeID": 1,
        "flagType": "sample string 2",
        "isActive": true,
        "isSystem": true,
        "isCleared": true,
        "isDefault": true,
        "isRepair": true,
        "isAdmin": true,
        "isRepairComponent": true
      },
      "returnFlagBarcodePrefix": "sample string 7"
    }
  },
  "total": 5.0,
  "currency": {
    "currencyID": 1,
    "currencyName": "sample string 2",
    "currencyCode": "sample string 3",
    "currencySymbol": "sample string 4"
  },
  "notes": "sample string 6",
  "items": [
    {
      "purchaseOrderItemID": 1,
      "lineNumber": "sample string 2",
      "sku": {
        "skuId": 1,
        "isActive": true,
        "partNumber": "sample string 3",
        "partDescription": "sample string 4",
        "skuCategory": {
          "skuCategoryID": 1,
          "isSystem": true,
          "isIntegrationControlled": true,
          "isActive": true,
          "skuCategory": "sample string 5"
        },
        "skuSubCategory": {
          "skuSubCategoryId": 1,
          "skuCategoryId": 2,
          "skuSubCategory": "sample string 3"
        },
        "imageURL": "sample string 5",
        "fileCount": 6,
        "isNonSerialized": true,
        "isLotTraceable": true,
        "receiveNonSerialized": true,
        "receivePreLabeled": true,
        "nonSerializedSKUID": 11,
        "numberPerPallet": 12,
        "purchaseUOM": {
          "unitOfMeasureID": 1,
          "unitOfMeasure": "sample string 2",
          "unitCode": "sample string 3"
        },
        "stockUOM": {
          "unitOfMeasureID": 1,
          "unitOfMeasure": "sample string 2",
          "unitCode": "sample string 3"
        },
        "conversionRatio": 13.0,
        "standardCost": 14.0,
        "vat": 15.0,
        "truckloadQuantity": 16,
        "mask": "sample string 17",
        "skuType": {
          "skuTypeID": 1,
          "skuType": "sample string 2"
        },
        "isIntegrationControlled": true,
        "weight": 19.0,
        "height": 20.0,
        "length": 21.0,
        "width": 22.0,
        "dimensionUOM": {
          "unitOfMeasureID": 1,
          "unitOfMeasure": "sample string 2",
          "unitCode": "sample string 3"
        },
        "weightUOM": {
          "unitOfMeasureID": 1,
          "unitOfMeasure": "sample string 2",
          "unitCode": "sample string 3"
        },
        "isCertified": true,
        "certificationDate": "2025-11-08T08:24:32.2625502+00:00"
      },
      "quantity": 3.0,
      "unitOfMeasure": {
        "unitOfMeasureID": 1,
        "unitOfMeasure": "sample string 2",
        "unitCode": "sample string 3"
      },
      "poStatus": {
        "purchaseOrderStatusID": 1,
        "purchaseOrderStatus": "sample string 2"
      },
      "cost": 4.0,
      "extendedCost": 5.0,
      "lot": "sample string 6",
      "receivedQuantity": 7.0,
      "other1": "sample string 8",
      "other2": "sample string 9"
    },
    {
      "purchaseOrderItemID": 1,
      "lineNumber": "sample string 2",
      "sku": {
        "skuId": 1,
        "isActive": true,
        "partNumber": "sample string 3",
        "partDescription": "sample string 4",
        "skuCategory": {
          "skuCategoryID": 1,
          "isSystem": true,
          "isIntegrationControlled": true,
          "isActive": true,
          "skuCategory": "sample string 5"
        },
        "skuSubCategory": {
          "skuSubCategoryId": 1,
          "skuCategoryId": 2,
          "skuSubCategory": "sample string 3"
        },
        "imageURL": "sample string 5",
        "fileCount": 6,
        "isNonSerialized": true,
        "isLotTraceable": true,
        "receiveNonSerialized": true,
        "receivePreLabeled": true,
        "nonSerializedSKUID": 11,
        "numberPerPallet": 12,
        "purchaseUOM": {
          "unitOfMeasureID": 1,
          "unitOfMeasure": "sample string 2",
          "unitCode": "sample string 3"
        },
        "stockUOM": {
          "unitOfMeasureID": 1,
          "unitOfMeasure": "sample string 2",
          "unitCode": "sample string 3"
        },
        "conversionRatio": 13.0,
        "standardCost": 14.0,
        "vat": 15.0,
        "truckloadQuantity": 16,
        "mask": "sample string 17",
        "skuType": {
          "skuTypeID": 1,
          "skuType": "sample string 2"
        },
        "isIntegrationControlled": true,
        "weight": 19.0,
        "height": 20.0,
        "length": 21.0,
        "width": 22.0,
        "dimensionUOM": {
          "unitOfMeasureID": 1,
          "unitOfMeasure": "sample string 2",
          "unitCode": "sample string 3"
        },
        "weightUOM": {
          "unitOfMeasureID": 1,
          "unitOfMeasure": "sample string 2",
          "unitCode": "sample string 3"
        },
        "isCertified": true,
        "certificationDate": "2025-11-08T08:24:32.2625502+00:00"
      },
      "quantity": 3.0,
      "unitOfMeasure": {
        "unitOfMeasureID": 1,
        "unitOfMeasure": "sample string 2",
        "unitCode": "sample string 3"
      },
      "poStatus": {
        "purchaseOrderStatusID": 1,
        "purchaseOrderStatus": "sample string 2"
      },
      "cost": 4.0,
      "extendedCost": 5.0,
      "lot": "sample string 6",
      "receivedQuantity": 7.0,
      "other1": "sample string 8",
      "other2": "sample string 9"
    }
  ],
  "fileCount": 7
}