order-items

Get list of all order items

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.
SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
account
integer
account_code
integer

Account Code

active
boolean
approved_datetime_0
string <date>

Approved Date

approved_datetime_1
string <date>

Approved Date

approved_price
number
approved_quantity
number
approver
number
approver_id
number
branch
integer

Location

catalog
boolean
catalog_item
string

A comma-separated list of integers.

currency
integer
department
integer

Department

departments
string

A comma-separated list of integers.

exclude
string

A comma-separated list of integers.

exclude_punchout
boolean
format
string
Enum: "csv" "json"
fulfilment_status
string
is_purchased
boolean
is_recurring
boolean
last_changed_by
integer
last_modified_0
string <date>

Last Modified Date

last_modified_1
string <date>

Last Modified Date

lineComment
string
location
integer

Location

locations
string

A comma-separated list of integers.

name
string
num
string
orderNum
integer
orderNum__status
integer
  • 0 - Pending
  • 1 - Approved
  • 2 - Denied
  • 3 - Purchased
  • 4 - Cancelled
  • 5 - Received
  • 6 - Draft
Enum: 0 1 2 3 4 5 6
order_by
string

Which field to use when ordering the results.

order_created_date_0
string <date>

Order Created Date

order_created_date_1
string <date>

Order Created Date

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

po_created_date_0
string <date>

Purchased Date

po_created_date_1
string <date>

Purchased Date

po_vendor
integer

Purchased Vendor

pref_vendor
integer
price
number
purchase_agreement
number
purchased_date_0
string <date>

Purchased Date

purchased_date_1
string <date>

Purchased Date

purchaser
integer
quantity
number
receivedFailQty
number
receivedPassQty
number
requester
integer

Requester

search
string

A search term.

sku
string
status
integer or null
  • 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
Enum: 0 1 2 3 4 5 6 7 8
type
integer
  • 0 - One Time
  • 1 - Recurring
  • 2 - Blanket
Enum: 0 1 2
unit
string
Responses
200
Response Schema:
object
Array of objects (OrderItem)
get/api/v3/order-items/
Response samples
{
  • "metadata": {
    },
  • "data": [
    ]
}
➔ Next to ap