getPurchaseOrdersByPage

get

https://webservices-test.net-chef.com/purchaseorder/v1/getPurchaseOrdersByPage

Retrieves all vendor orders with the accompanying information by page number.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

actualDeliveryDateEnd

string

Retrieve orders with actual delivery date equal to this date or earlier (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.

actualDeliveryDateStart

string

Retrieve orders with actual delivery date equal to this date or later (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.

expectedDeliveryDateEnd

string

Retrieve orders with expected delivery date equal to this date or earlier (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.

expectedDeliveryDateStart

string

Retrieve orders with expected delivery date equal to this date or later (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.

includeDetails

boolean

Defaults to false

show order details or not. Default to False, if not provided.

invoiceDateEnd

string

Retrieve orders with invoice date equal to this date or earlier (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.

invoiceDateStart

string

Retrieve orders with invoice date equal to this date or later (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.

locationCode

string

The Code that identifies the Location in Crunchtime.

orderDateEnd

string

Retrieve orders with create date equal to this date or earlier (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.

orderDateStart

string

Retrieve orders with create date equal to this date or later (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.

orderType

string

The type of order to retrieve (optional; case sensitive)

pageNumber

int32

Defaults to 1

Retrieve one or more records by pageNumber. \n Use to retrieve data in smaller chunks. \n If left blank, the default is 1.

postDate

string

Retrieve orders with post date equal this date (optional)

purchaseOrderNumber

string

The system-assigned PO# of the order to retrieve (optional; case sensitive)

reconcileDateEnd

string

Retrieve orders with reconcile date equal to this date or earlier (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.

reconcileDateStart

string

Retrieve orders with reconcile date equal to this date or later (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.

status

string

enum

Retrieve orders with inventory type status (New Order (Not sent) [1], Submitted [2], Confirmation of Receipt [6], Confirmation of Terms [7], Consolidated [8], Reconciled [3], Cancelled [4]) equal to this number (optional)

Allowed:

submitDateEnd

string

Retrieve orders with submit date equal to this date or earlier (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.

submitDateStart

string

Retrieve orders with submit date equal to this date or later (optional). Must be entered together with the start date and the range between the start and end must be no more than 31 days.

vendorCode

string

The Code number for the vendor's orders to retrieve (optional; case sensitive)"

vendorInvoiceNumber

string

The vendor's Invoice # for the order to retrieve (optional; case sensitive)

pageSize

int32

Number of items to display per page.

minutesSinceUpdate

int32

The number of minutes since a record was last updated. Use to set how far back to search. Must be more than 0 and less than 10080 (7 days). Can be standalone parameter.

sortBy

string

enum

Specifies the field used to sort the Purchase Orders. Default is 'lastUpdated' if not provided (Optional)

Allowed:

sortOrder

string

enum

Specifies the sort direction for Purchase Orders: ascending (ASC) or descending (DESC). Default is ASC if not specified (Optional)

Allowed:

includeNull

boolean

Specify 'true' to output null data elements.

Headers

authenticationtoken

string

required

Secure token for API authentication.

password

string

required

Password for the Crunchtime Application User.

sitename

string

required

Crunchtime site identifier. (test or production)

userid

string

required

"User ID for the Crunchtime Application User.

X-B3-TraceId

string

Optional trace identifier for troubleshooting.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Success

400Validation Error

401Authorization

404purchase orders not found

429Too Many Requests

500Unexpected Error

503System under maintenance

504Timeout