> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.useopenwrench.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a purchase request > Retrieves one purchase request by id, subject to read permission. ## OpenAPI ````yaml /openapi/supplier.json get /v1/supplier/inventory/purchase_requests/{id} openapi: 3.1.0 info: title: OpenWrench Supplier API version: 1.0.0 description: >- External REST API for OpenWrench suppliers (service providers). ## Authentication Every request must carry a supplier API key in the `X-API-KEY` header. The key resolves to a supplier contact; all reads and writes are tenant-scoped to that contact's supplier facility/company. Missing or invalid keys are answered with 401. ## Rate limiting 10 requests per 20-second window per API key. Requests beyond that are answered with 429 and the standard error envelope. (A few endpoints, noted in their descriptions, are not rate-limited.) ## Response envelope Single entity: `{"type": "", "data": {...}, "status": "ok"}`. Lists: `{"type": "", "data": [...], "count": , "status": "ok"}`. count_by endpoints return the integer count in `data`. The `type` label is hard-coded on some endpoints (e.g. "WorkOrderNotes", "pingpong") and derived via Scala reflection on generic CRUD endpoints, where it may appear as the fully qualified server class name - treat it as informational. Errors: `{"message": "...", "type": "", "status": "error", "traceId": "..."}` with HTTP 400 (bad input, and also permission-denied reads/writes), 401 (missing/invalid key), 404 (not found), 429 (rate limit). ## Pagination List endpoints accept `offset`, `limit` (default 10, max 25 - the supplier locations list caps at 10), `sort_by` and `order` (`asc`|`desc`), plus entity-specific query-string filters on indexed columns. ## Data masking For third-party suppliers (keys whose supplier company is not a buyer's internal service team), work order, location and invoice responses are masked: buyer-private fields are blanked before the response is returned. ## Date formats Date-time fields serialize as strings in one of two shapes depending on the underlying type: ISO 8601 with offset (e.g. `2026-08-14T13:05:22.000-07:00`) for most timestamps, or `yyyy-MM-dd HH:mm:ss.S` (space-separated, no offset) for database timestamp fields. Plain dates are `yyyy-MM-dd`. When sending date-times, ISO 8601 is accepted. ## Required headers Every request must carry BOTH `X-API-KEY` (your API key) and `OW-KEY` (the OpenWrench shared secret issued with it). Requests missing either return 401. servers: - url: https://api.useopenwrench.com/api/external security: - ApiKeyAuth: [] OwKeyAuth: [] tags: - name: Ping - name: Buyer Companies - name: Locations - name: Regions - name: Asset Types - name: Assets - name: Asset Labels description: Read the asset label catalog and replace the labels applied to an asset. - name: Work Orders - name: Work Order Labels description: >- Read the work order label catalog visible to your key and replace the labels applied to a work order. - name: Service Calls - name: WrenchMode description: Read-only WrenchMode work logs and technician time analytics - name: Proposals - name: Invoices - name: Files - name: Purchase Requests - name: Purchase Orders - name: Purchase Order Receipts - name: Parts - name: Equipment Types - name: Stock Location Inventory - name: Vendors - name: Users paths: /v1/supplier/inventory/purchase_requests/{id}: get: tags: - Purchase Requests summary: Get a purchase request description: Retrieves one purchase request by id, subject to read permission. operationId: getPurchaseRequest parameters: - name: id in: path required: true schema: type: integer format: int64 description: Purchase request id responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/SupplierPurchaseRequestResponse' '400': description: >- Bad input, validation failure, or the API key's contact could not be resolved content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Missing or invalid X-API-KEY content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Entity not found (or not visible to this API key) content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Rate limit exceeded (10 requests per 20-second window) content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: SupplierPurchaseRequestResponse: type: object properties: type: type: string description: >- Entity type label, e.g. "SupplierPurchaseRequest". 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. data: $ref: '#/components/schemas/SupplierPurchaseRequest' status: type: string description: '"ok" on success' enum: - ok required: - type - data - status Error: type: object properties: message: type: string description: Human-readable error message type: type: string description: >- Exception type identifier. Known values (exact casing): "unauthorizedException", "authorizationException", "ParseException", "UnexpectedException", "NotFoundException", "BadRequestException", "PaymentRequiredException", "InvalidInputDataException", "ConflictException", "ForbiddenException", "InvalidInputException" status: type: string enum: - error traceId: type: string description: >- Server-generated trace identifier for support (11 alphanumeric characters) required: - message - type - status - traceId description: Standard error envelope returned for 4xx/5xx responses. SupplierPurchaseRequest: type: object properties: id: anyOf: - type: integer format: int64 - type: 'null' purchaseRequestUniqueId: anyOf: - type: integer - type: 'null' purchaseRequestCustomIdentifier: anyOf: - type: string - type: 'null' name: type: string description: anyOf: - type: string - type: 'null' status: type: string enum: - requested - denied - cancelled - approved - orderInProgress - ordered - partially_ordered - fulfilled - partially_fulfilled stockLocationId: anyOf: - type: integer format: int64 - type: 'null' stockLocation: anyOf: - $ref: '#/components/schemas/StockLocation' - type: 'null' locationId: anyOf: - type: integer format: int64 - type: 'null' location: anyOf: - $ref: '#/components/schemas/Location' - type: 'null' totalCost: anyOf: - type: number - type: 'null' currencyId: type: string workOrderId: anyOf: - type: integer format: int64 - type: 'null' warrantyAssetId: anyOf: - type: integer format: int64 - type: 'null' partIds: anyOf: - type: string description: Comma-separated ids - type: 'null' equipmentTypeIds: anyOf: - type: string description: Comma-separated ids - type: 'null' internalNotes: anyOf: - type: string - type: 'null' supplierFacilityId: type: integer supplierCompanyId: type: integer createdByEmail: type: string createdByContact: anyOf: - $ref: '#/components/schemas/Contact' - type: 'null' approvedOrDeclinedOrCancelledAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' approvedOrDeclinedOrCancelledByEmail: anyOf: - type: string - type: 'null' partSupplierPurchaseRequestLineItems: type: array items: $ref: '#/components/schemas/SupplierPurchaseRequestLineItem' equipmentSupplierPurchaseRequestLineItems: type: array items: $ref: '#/components/schemas/SupplierPurchaseRequestLineItem' incomingLineItems: type: array items: $ref: '#/components/schemas/SupplierPurchaseRequestIncomingLineItem' createdAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' updatedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' isDeleted: type: boolean deletedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' required: - name - status - currencyId - supplierFacilityId - supplierCompanyId - createdByEmail - isDeleted description: >- Supplier purchase request (approval-hierarchy and hydrated relation fields omitted). additionalProperties: true StockLocation: type: object properties: id: anyOf: - type: integer format: int64 - type: 'null' warehouseId: anyOf: - type: string - type: 'null' name: type: string images: type: array items: type: string description: anyOf: - type: string - type: 'null' isMobile: type: boolean address: anyOf: - $ref: '#/components/schemas/Address' - type: 'null' latitude: anyOf: - type: number - type: 'null' longitude: anyOf: - type: number - type: 'null' timeZoneId: anyOf: - type: string - type: 'null' locationId: anyOf: - type: integer format: int64 - type: 'null' supplierFacilityId: type: integer supplierCompanyId: type: integer burdenRates: anyOf: - type: array items: type: object properties: year: type: integer rate: type: string required: - year - rate - type: 'null' taxRates: anyOf: - type: array items: type: object properties: year: type: integer rate: type: string required: - year - rate - type: 'null' purchaseOrderPrefix: anyOf: - type: string - type: 'null' isActive: type: boolean glCode: anyOf: - type: string - type: 'null' allowEquipmentForwarding: type: boolean createdAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' updatedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' isDeleted: type: boolean deletedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' required: - name - isMobile - supplierFacilityId - supplierCompanyId - isActive - allowEquipmentForwarding - isDeleted additionalProperties: true Location: type: object properties: id: anyOf: - type: integer format: int64 - type: 'null' storeId: anyOf: - type: string - type: 'null' name: type: string brandId: anyOf: - type: integer - type: 'null' brandAssetGroupId: anyOf: - type: integer - type: 'null' description: anyOf: - type: string - type: 'null' isActive: type: boolean openDate: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' closeDate: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' operatingHours: anyOf: - type: object properties: {} description: Operating-hours object (shape abridged) additionalProperties: true - type: 'null' phoneNumber: anyOf: - type: string - type: 'null' locationTypeId: type: integer locationTypeDetails: type: array items: type: object properties: {} additionalProperties: true description: Field-type detail objects notes: anyOf: - type: string - type: 'null' internalNotes: anyOf: - type: string - type: 'null' images: type: array items: type: string internalAttachments: type: array items: $ref: '#/components/schemas/FileDetails' primaryContactsEmails: type: array items: type: string facilityInChargeEmails: type: array items: type: string sendApprovedInvoicesToEmails: type: array items: type: string sendApprovedQuotesToEmails: type: array items: type: string storeAssociateEmails: type: array items: type: string fieldTechEmails: type: array items: type: string timeZoneId: anyOf: - type: string - type: 'null' regionId: anyOf: - type: integer format: int64 - type: 'null' region: anyOf: - $ref: '#/components/schemas/Region' - type: 'null' purchaseOrderPrefix: anyOf: - type: string - type: 'null' isLeased: anyOf: - type: boolean - type: 'null' leaseStartDate: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' leaseEndDate: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' taxRate: anyOf: - type: string - type: 'null' countryCode: anyOf: - type: string - type: 'null' buyerFacilityId: type: integer buyerCompanyId: type: integer totalWOCount: anyOf: - type: integer format: int64 - type: 'null' totalNotClosedWOCount: anyOf: - type: integer format: int64 - type: 'null' createdAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' updatedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' isDeleted: type: boolean deletedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' description: >- Location (abridged - hydrated brand/buyer-facility/warranty/custom-field objects omitted). For third-party suppliers responses are masked (buyer-private fields blanked). additionalProperties: true Contact: type: object properties: email: type: string nameGiven: type: string nameFamily: type: string title: anyOf: - type: string - type: 'null' department: anyOf: - type: string - type: 'null' facilityId: anyOf: - type: integer - type: 'null' contactType: type: string description: '"buyer" or "supplier"' isSharedContact: type: boolean readOnlyAccess: anyOf: - type: boolean - type: 'null' invitedByEmail: anyOf: - type: string - type: 'null' invitedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' epaCertificationType: anyOf: - type: string - type: 'null' epaCertificationNumber: anyOf: - type: string - type: 'null' createdAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' updatedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' required: - email - nameGiven - nameFamily - contactType description: >- Contact record (abridged - the full Contact model carries additional fields). additionalProperties: true SupplierPurchaseRequestLineItem: type: object properties: id: anyOf: - type: integer format: int64 - type: 'null' status: type: string supplierPurchaseRequestId: type: integer format: int64 stockLocationId: anyOf: - type: integer format: int64 - type: 'null' locationId: anyOf: - type: integer format: int64 - type: 'null' isEquipmentLine: type: boolean partId: anyOf: - type: integer format: int64 - type: 'null' part: anyOf: - $ref: '#/components/schemas/Part' - type: 'null' partCatalogId: anyOf: - type: integer format: int64 - type: 'null' partQuantity: anyOf: - type: integer - type: 'null' partReceivedQuantity: anyOf: - type: integer - type: 'null' partUomId: type: integer partUnitCost: anyOf: - type: number - type: 'null' partCost: anyOf: - type: number - type: 'null' partCurrencyId: type: string equipmentTypeId: anyOf: - type: integer format: int64 - type: 'null' equipmentType: anyOf: - $ref: '#/components/schemas/EquipmentType' - type: 'null' equipmentCatalogId: anyOf: - type: integer format: int64 - type: 'null' equipmentQuantity: anyOf: - type: integer - type: 'null' equipmentReceivedQuantity: anyOf: - type: integer - type: 'null' equipmentUomId: type: integer equipmentUnitCost: anyOf: - type: number - type: 'null' equipmentCost: anyOf: - type: number - type: 'null' equipmentCurrencyId: type: string associatedPurchaseOrderLineItemId: anyOf: - type: integer format: int64 - type: 'null' glCodeForPurchaseOrderLineItem: anyOf: - type: string - type: 'null' supplierFacilityId: type: integer supplierCompanyId: type: integer createdAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' updatedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' isDeleted: type: boolean deletedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' required: - status - supplierPurchaseRequestId - isEquipmentLine - partUomId - partCurrencyId - equipmentUomId - equipmentCurrencyId - supplierFacilityId - supplierCompanyId - isDeleted description: >- Purchase-request line item (hydrated catalog/currency/uom relation objects omitted). additionalProperties: true SupplierPurchaseRequestIncomingLineItem: type: object properties: status: anyOf: - type: string - type: 'null' isEquipmentLine: type: boolean partId: anyOf: - type: integer format: int64 - type: 'null' partCatalogId: anyOf: - type: integer format: int64 - type: 'null' partQuantity: anyOf: - type: integer - type: 'null' partUomId: type: integer partUnitCost: anyOf: - type: number - type: 'null' partCost: anyOf: - type: number - type: 'null' partCurrencyId: type: string equipmentTypeId: anyOf: - type: integer format: int64 - type: 'null' equipmentCatalogId: anyOf: - type: integer format: int64 - type: 'null' equipmentQuantity: anyOf: - type: integer - type: 'null' equipmentUomId: type: integer equipmentUnitCost: anyOf: - type: number - type: 'null' equipmentCost: anyOf: - type: number - type: 'null' associatedPOLineItemId: anyOf: - type: integer format: int64 - type: 'null' equipmentCurrencyId: type: string createdAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' required: - isEquipmentLine - partUomId - partCurrencyId - equipmentUomId - equipmentCurrencyId Address: type: object properties: {} description: Postal address object (shape abridged - model source not available). additionalProperties: true FileDetails: type: object properties: fileName: type: string description: Original file name (non-ASCII characters removed on upload) fileId: type: string description: Server-assigned file identifier; use with the file download endpoint required: - fileName - fileId description: >- Uploaded-file reference, as returned by the file upload endpoint and used in all attachment fields. Region: type: object properties: id: anyOf: - type: integer format: int64 - type: 'null' name: type: string buyerCompanyId: type: integer hierarchyName: anyOf: - type: string - type: 'null' parentId: anyOf: - type: integer format: int64 - type: 'null' hasChildren: type: boolean createdAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' updatedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' isDeleted: type: boolean deletedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' required: - name - buyerCompanyId - hasChildren - isDeleted Part: type: object properties: id: anyOf: - type: integer format: int64 - type: 'null' partUUID: anyOf: - type: string - type: 'null' manufacturerId: anyOf: - type: string - type: 'null' manufacturerName: anyOf: - type: string - type: 'null' partNumber: anyOf: - type: string - type: 'null' aliasPartId: anyOf: - type: string - type: 'null' name: type: string images: type: array items: type: string description: anyOf: - type: string - type: 'null' cost: anyOf: - type: number - type: 'null' uomId: type: integer description: Unit-of-measure id defaultVendorId: anyOf: - type: integer - type: 'null' defaultVendor: anyOf: - $ref: '#/components/schemas/PartEquipmentVendor' - type: 'null' defaultPartCatalogId: anyOf: - type: integer format: int64 - type: 'null' assetTypeId: anyOf: - type: integer - type: 'null' assetModelId: anyOf: - type: integer - type: 'null' isActive: type: boolean glCode: anyOf: - type: string - type: 'null' partEquipmentVendorCount: type: integer format: int64 isStocked: type: boolean labelIds: anyOf: - type: array items: type: integer format: int64 - type: 'null' labels: anyOf: - type: array items: type: string - type: 'null' supplierCompanyId: type: integer createdAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' updatedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' isDeleted: type: boolean deletedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' required: - name - uomId - isActive - isStocked - supplierCompanyId - isDeleted additionalProperties: true EquipmentType: type: object properties: id: anyOf: - type: integer format: int64 - type: 'null' equipmentTypeNumber: anyOf: - type: string - type: 'null' aliasEquipmentTypeNumber: anyOf: - type: string - type: 'null' manufacturerId: anyOf: - type: string - type: 'null' manufacturerName: anyOf: - type: string - type: 'null' modelName: type: string images: type: array items: type: string description: anyOf: - type: string - type: 'null' cost: anyOf: - type: number - type: 'null' defaultVendorId: anyOf: - type: integer - type: 'null' defaultVendor: anyOf: - $ref: '#/components/schemas/PartEquipmentVendor' - type: 'null' defaultEquipmentCatalogId: anyOf: - type: integer format: int64 - type: 'null' assetTypeId: anyOf: - type: integer format: int64 - type: 'null' assetType: anyOf: - $ref: '#/components/schemas/AssetType' - type: 'null' isActive: type: boolean glCode: anyOf: - type: string - type: 'null' partEquipmentVendorCount: type: integer format: int64 supplierFacilityId: type: integer supplierCompanyId: type: integer isAssociatedWithOtherEntities: anyOf: - type: boolean - type: 'null' createdAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' updatedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' isDeleted: type: boolean deletedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' required: - modelName - isActive - supplierFacilityId - supplierCompanyId - isDeleted PartEquipmentVendor: type: object properties: id: anyOf: - type: integer - type: 'null' name: type: string vendorId: anyOf: - type: string - type: 'null' address: anyOf: - $ref: '#/components/schemas/Address' - type: 'null' currencyId: type: string email: anyOf: - type: string - type: 'null' logoUrl: anyOf: - type: string - type: 'null' phoneNumber: anyOf: - type: string - type: 'null' paymentTerms: anyOf: - type: string - type: 'null' shippingTerms: anyOf: - type: string - type: 'null' orderingEmails: anyOf: - type: array items: type: string - type: 'null' accountManagerEmails: anyOf: - type: array items: type: string - type: 'null' accountManagerContacts: anyOf: - type: array items: $ref: '#/components/schemas/VendorContact' - type: 'null' salesRepEmails: anyOf: - type: array items: type: string - type: 'null' salesRepContacts: anyOf: - type: array items: $ref: '#/components/schemas/VendorContact' - type: 'null' accountsPayableEmails: anyOf: - type: array items: type: string - type: 'null' accountsPayableContacts: anyOf: - type: array items: $ref: '#/components/schemas/VendorContact' - type: 'null' defaultWarrantyMonths: anyOf: - type: integer - type: 'null' notes: anyOf: - type: string - type: 'null' isActive: type: boolean supplierFacilityId: type: integer createdAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' updatedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' isDeleted: type: boolean deletedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' required: - name - currencyId - isActive - supplierFacilityId - isDeleted AssetType: type: object properties: id: anyOf: - type: integer - type: 'null' name: type: string primarySpendCategory: anyOf: - type: integer - type: 'null' attachments: type: array items: $ref: '#/components/schemas/FileDetails' allProblemTypeIds: type: array items: type: integer allProblemTypeIdsAsString: type: string allProblemTypes: anyOf: - type: array items: $ref: '#/components/schemas/ProblemType' - type: 'null' allProblemTypesName: anyOf: - type: string - type: 'null' allSpendCategories: type: array items: type: integer depreciationClassId: anyOf: - type: integer - type: 'null' depreciationClassName: anyOf: - type: string - type: 'null' requiredFields: type: array items: type: object properties: {} additionalProperties: true description: FieldType objects optionalFields: type: array items: type: object properties: {} additionalProperties: true description: FieldType objects replaceMarkupOnOriginalCost: anyOf: - type: number - type: 'null' replacementThreshold: anyOf: - type: number - type: 'null' usesRefrigerant: type: boolean applianceCategory: anyOf: - type: string - type: 'null' refrigerantTypeCode: anyOf: - type: string - type: 'null' fullChargeLb: anyOf: - type: number - type: 'null' buyerCompanyId: type: integer createdAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' updatedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' isDeleted: type: boolean deletedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' required: - name - usesRefrigerant - buyerCompanyId - isDeleted additionalProperties: true VendorContact: type: object properties: email: type: string name: type: string phoneNumber: anyOf: - type: string - type: 'null' vendorId: type: integer supplierFacilityId: type: integer createdAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' updatedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' required: - email - name - vendorId - supplierFacilityId ProblemType: type: object properties: id: anyOf: - type: integer - type: 'null' name: type: string buyerCompanyId: type: integer hasChildren: type: boolean description: >- Problem type (abridged - model source not available; fields inferred from controller usage). additionalProperties: true securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-KEY OwKeyAuth: type: apiKey in: header name: OW-KEY description: >- OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key. ````