Procurify Order Items API
The order-items API from Procurify — 1 operation(s) for order-items.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/procurify-order-items-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Procurify API Documentation Order Items API
version: ''
description: '# Disclaimer
- Procurify’s API is evolving and is subject to change at any time.'
servers:
- url: https://{user_domain}.procurify.com
description: Your Procurify domain
variables:
user_domain:
default: your-domain
description: Your procurify domain
tags:
- name: Order Items
paths:
/api/v3/order-items/:
get:
operationId: order_items_list
description: '**Order Item Status Codes**
| Order Item Type | Code | Description |
|--------------------------|-----------|-----------------------------------|
| PURCHASE_PENDING | 0 | Approved but not purchased. |
| PURCHASE_INUSE | 1 | Added to purchaser''s PO list. |
| RECEIVE_PENDING | 2 | Purchased but not yet received, i.e. receivedPassQty == 0. |
| RECEIVED | 3 | Fully received, i.e. receivedPassQty == quantity. |
| REJECTED_FOR_PURCHASE | 4 | Rejected at procurement, i.e. denied. |
| RECEIVE_PARTIAL | 5 | Partially received, i.e. receivedPassQty != quantity and receivedPassQty > 0. |
| FULFILLED | 6 | Received but unused. |
| APPROVAL_DENIED | 7 | Denied in approval routing (by approver). |
| REQUEST_DRAFT | 8 | Preparing for draft instead of using sessions. |'
summary: Get list of all order items
parameters:
- in: query
name: account
schema:
type: integer
- in: query
name: account_code
schema:
type: integer
description: Account Code
- in: query
name: active
schema:
type: boolean
- in: query
name: approved_datetime_0
schema:
type: string
format: date
description: Approved Date
- in: query
name: approved_datetime_1
schema:
type: string
format: date
description: Approved Date
- in: query
name: approved_price
schema:
type: number
- in: query
name: approved_quantity
schema:
type: number
- in: query
name: approver
schema:
type: number
- in: query
name: approver_id
schema:
type: number
- in: query
name: branch
schema:
type: integer
description: Location
- in: query
name: catalog
schema:
type: boolean
- in: query
name: catalog_item
schema:
type: string
description: A comma-separated list of integers.
- in: query
name: currency
schema:
type: integer
- in: query
name: department
schema:
type: integer
description: Department
- in: query
name: departments
schema:
type: string
description: A comma-separated list of integers.
- in: query
name: exclude
schema:
type: string
description: A comma-separated list of integers.
- in: query
name: exclude_punchout
schema:
type: boolean
- in: query
name: format
schema:
type: string
enum:
- csv
- json
- in: query
name: fulfilment_status
schema:
type: string
- in: query
name: is_purchased
schema:
type: boolean
- in: query
name: is_recurring
schema:
type: boolean
- in: query
name: last_changed_by
schema:
type: integer
- in: query
name: last_modified_0
schema:
type: string
format: date
description: Last Modified Date
- in: query
name: last_modified_1
schema:
type: string
format: date
description: Last Modified Date
- in: query
name: lineComment
schema:
type: string
- in: query
name: location
schema:
type: integer
description: Location
- in: query
name: locations
schema:
type: string
description: A comma-separated list of integers.
- in: query
name: name
schema:
type: string
- in: query
name: num
schema:
type: string
- in: query
name: orderNum
schema:
type: integer
- in: query
name: orderNum__status
schema:
type: integer
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
description: '* `0` - Pending
* `1` - Approved
* `2` - Denied
* `3` - Purchased
* `4` - Cancelled
* `5` - Received
* `6` - Draft'
- name: order_by
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: order_created_date_0
schema:
type: string
format: date
description: Order Created Date
- in: query
name: order_created_date_1
schema:
type: string
format: date
description: Order Created Date
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: po_created_date_0
schema:
type: string
format: date
description: Purchased Date
- in: query
name: po_created_date_1
schema:
type: string
format: date
description: Purchased Date
- in: query
name: po_vendor
schema:
type: integer
description: Purchased Vendor
- in: query
name: pref_vendor
schema:
type: integer
- in: query
name: price
schema:
type: number
- in: query
name: purchase_agreement
schema:
type: number
- in: query
name: purchased_date_0
schema:
type: string
format: date
description: Purchased Date
- in: query
name: purchased_date_1
schema:
type: string
format: date
description: Purchased Date
- in: query
name: purchaser
schema:
type: integer
- in: query
name: quantity
schema:
type: number
- in: query
name: receivedFailQty
schema:
type: number
- in: query
name: receivedPassQty
schema:
type: number
- in: query
name: requester
schema:
type: integer
description: Requester
- name: search
required: false
in: query
description: A search term.
schema:
type: string
- in: query
name: sku
schema:
type: string
- in: query
name: status
schema:
type:
- integer
- 'null'
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
description: '* `0` - Purchase Pending
* `1` - Purchaser In-Use
* `2` - Receive Pending
* `3` - Received
* `4` - Rejected for Purchase
* `5` - Partial Received
* `6` - Fulfilled
* `7` - Approval Denied
* `8` - Request Draft'
- in: query
name: type
schema:
type: integer
enum:
- 0
- 1
- 2
description: '* `0` - One Time
* `1` - Recurring
* `2` - Blanket'
- in: query
name: unit
schema:
type: string
tags:
- Order Items
security:
- RemoteAuthentication: []
- M2MAuthentication: []
- BasicAuthentication: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedOrderItemList'
text/csv:
schema:
$ref: '#/components/schemas/PaginatedOrderItemList'
description: ''
components:
schemas:
OrderItemTypeEnum:
enum:
- 0
- 1
- 2
type: integer
description: '* `0` - One Time
* `1` - Recurring
* `2` - Blanket'
OrderItemStatusEnum:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
type: integer
description: '* `0` - Purchase Pending
* `1` - Purchaser In-Use
* `2` - Receive Pending
* `3` - Received
* `4` - Rejected for Purchase
* `5` - Partial Received
* `6` - Fulfilled
* `7` - Approval Denied
* `8` - Request Draft'
PaginatedOrderItemList:
type: object
properties:
metadata:
type: object
properties:
pagination:
type: object
properties:
count:
type: integer
example: 10
next:
type:
- string
- 'null'
format: uri
example: null
previous:
type:
- string
- 'null'
format: uri
example: null
page_size:
type: integer
example: 10
num_pages:
type: integer
example: 1
current_page:
type: integer
example: 1
example:
pagination:
count: 10
next: null
previous: null
page_size: 10
num_pages: 1
current_page: 1
data:
type: array
items:
$ref: '#/components/schemas/OrderItem'
ReceiveMethodEnum:
enum:
- 0
- 1
type: integer
description: '* `0` - Quantity
* `1` - Currency amount'
OrderItem:
type: object
properties:
PO:
type: array
items:
type: integer
title: PO
PO_line_num:
type: integer
maximum: 2147483647
minimum: -2147483648
account:
type: integer
accountCode:
type: string
maxLength: 100
active:
type: boolean
approved_currency_rate:
type:
- string
- 'null'
format: decimal
pattern: ^-?\d{0,9}(?:\.\d{0,6})?$
approved_datetime:
type:
- string
- 'null'
format: date-time
approved_price:
type:
- string
- 'null'
format: decimal
pattern: ^-?\d{0,13}(?:\.\d{0,8})?$
approved_quantity:
type:
- string
- 'null'
format: decimal
pattern: ^-?\d{0,10}(?:\.\d{0,5})?$
approved_shipping_amount:
type:
- string
- 'null'
format: decimal
pattern: ^-?\d{0,13}(?:\.\d{0,8})?$
approved_tax_amount:
type:
- string
- 'null'
format: decimal
pattern: ^-?\d{0,13}(?:\.\d{0,8})?$
attachments:
type: string
catalog_item:
type:
- integer
- 'null'
created_at:
type: string
format: date-time
readOnly: true
currency:
type: integer
dateInvoiced:
type:
- string
- 'null'
format: date-time
external_id:
type: string
description: External id of the order item
maxLength: 100
hot:
type: boolean
id:
type: integer
readOnly: true
inventoryItem:
type:
- integer
- 'null'
is_active:
type: boolean
item_attachments:
type: array
items:
type: integer
last_changed_by:
type:
- integer
- 'null'
title: Last changed by user
last_modified:
type: string
format: date-time
readOnly: true
lineComment:
type:
- string
- 'null'
name:
type: string
maxLength: 255
num:
type: string
maxLength: 50
orderNum:
type:
- integer
- 'null'
order_number:
type:
- integer
- 'null'
readOnly: true
po_note:
type: string
title: Comment
po_version:
type: integer
maximum: 2147483647
minimum: -2147483648
pref_vendor:
type: integer
price:
type: string
format: decimal
pattern: ^-?\d{0,13}(?:\.\d{0,8})?$
purchase_order:
type:
- integer
- 'null'
title: Procurify PO Number
purchaser:
type:
- integer
- 'null'
quantity:
type: string
format: decimal
pattern: ^-?\d{0,10}(?:\.\d{0,5})?$
receivedFailQty:
type: string
format: decimal
pattern: ^-?\d{0,10}(?:\.\d{0,5})?$
title: Received Fail Quantity
receivedPassQty:
type: string
format: decimal
pattern: ^-?\d{0,10}(?:\.\d{0,5})?$
title: Received Pass Quantity
shipping_amount:
type:
- string
- 'null'
format: decimal
pattern: ^-?\d{0,13}(?:\.\d{0,8})?$
sku:
type: string
maxLength: 100
status:
minimum: -2147483648
maximum: 2147483647
oneOf:
- $ref: '#/components/schemas/OrderItemStatusEnum'
- $ref: '#/components/schemas/NullEnum'
type:
- integer
- 'null'
tax_amount:
type:
- string
- 'null'
format: decimal
pattern: ^-?\d{0,13}(?:\.\d{0,8})?$
total_cost:
type: string
format: decimal
pattern: ^-?\d{0,16}(?:\.\d{0,2})?$
unit:
type: string
maxLength: 30
updated_at:
type: string
format: date-time
readOnly: true
vendor:
type:
- string
- 'null'
maxLength: 100
receive_method:
allOf:
- $ref: '#/components/schemas/ReceiveMethodEnum'
minimum: 0
maximum: 65535
type:
allOf:
- $ref: '#/components/schemas/OrderItemTypeEnum'
minimum: 0
maximum: 65535
blanket:
allOf:
- $ref: '#/components/schemas/BlanketOrderItemRead'
readOnly: true
required:
- account
- approved_datetime
- currency
- name
- num
- pref_vendor
- price
- quantity
- unit
NullEnum:
enum:
- null
BlanketOrderItemRead:
type: object
properties:
price:
type: string
format: decimal
pattern: ^-?\d{0,13}(?:\.\d{0,8})?$
quantity:
type:
- number
- 'null'
format: double
readOnly: true
amount:
type:
- number
- 'null'
format: double
readOnly: true
required:
- price
securitySchemes:
BasicAuthentication:
type: http
scheme: basic
M2MAuthentication:
type: http
scheme: bearer
bearerFormat: JWT
RemoteAuthentication:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://<your-domain>.procurify.com/oauth/authorize
tokenUrl: https://<your-domain>.procurify.com/oauth/token
scopes: {}
cookieAuth:
type: apiKey
in: cookie
name: sessionid