Purchase Orders API

How to list existing purchase orders

• GET /api/purchase_orders

• GET /api/purchase_orders/<id>

GET /api/purchase_orders

• limit - limit of number of results to return (default: 100)

• offset - offset (default: 0)

• order_by - field name to order by (for example:  "txn_opened_on")

• order_type -  How do you want the order_by sorted “desc” or “asc”

• fields - A list of the available fields that you want to be returned. This can greatly reduce the result set and is highly recommended to be be utilized.

• fields_include = lines - Include child lines as part of the initial result set. (See the 3rd example below)

  • This may return a much larger data recordset

This resource returns a list of Purchase Order records sorted according to passed arguments.

Returned fields:

• address_line1 - The address line 1 of the supplier address

• address_line2 - The address line 2 of the supplier address

• city - The city of the supplier address

• closed_by_user_id - The user ID this purchase order was closed by

• closed_date_tz - The timezone in which this purchase order was closed

• closed_device_id - The device this purchase order was closed from

• closed_on - The timestamp this purchase order was closed

• deleted - MFD Flag: true is deleted/not available

• disclaimer_text - Any disclaimer associated with this purchase order

• discount_total - The total discount applied to this purchase order

• email - The email address of the supplier to send the purchase order to

• entity_id - The supplier ID

• entity_name - The supplier name

• expires_on - If this purchase order has an expiration date

• fee_total - The total fees applied to this purchase order

• freight_total - The total freight applied to this purchase order

• grand_total - The grand total for this purchase order

• id - The primary key of this purchase order

• is_open - True/False flag: is the purchase order still open

• location_id - The location ID

• location_receipt_name - The name of the location for which the purchase order was placed

• notes - Any notes for the order

• number - This is the actual purchase order number. ie. PO #

• opened_by_user_id - The user ID this purchase order was created by

• opened_device_id - The device this purchase order was created on

• opened_on - The timestamp this purchase order was created

• options - The supplier details specific to this location. This should be treated as a read-only list of values

  • "Lead Time Days": How many days to be received after purchase order is placed with supplier

  • "Location": The location ID

  • "Min Sale Period": How many days (minimum) used in the sales period for evaluation

  • "Only Cheapest": Was the cheapest supplier only flag set when the purchase order was created,

  • "Order Method": Which generation method was used to create the purchase order

  • "Purchase Without Sales": Can items be ordered without sales

  • "Safety Stock Max Days": Safety stock maximum days to have on hand

  • "Safety Stock Min Days": Safety stock minimum days to have on hand

• other_total - The other total for this purchase order

• phone_number - The phone number of the supplier

• reason - null

• receiving_batch - null

• region_full_name - The full name of the supplier state code

• region_iso_code - The 2 character abbreviation for the supplier state code

• session_id - null

• status - The current status of the purchase order

• subtotal - The subtotal

• tax_total - The tax total

• timezone - The timezone this purchase order was created in

• tray_session_id - The tray session associated with this purchase order

• type - The type of order this is. Will be "Purchase"

• zipcode - The zip code of the supplier address

GET /api/purchase_orders
GET /api/purchase_orders {'limit': '2', 'order_by': 'txn_opened_on', 'order_type': 'desc'}
Response

How to obtain specific transaction information

GET /api/purchase_orders/<id>
GET /api/purchase_orders/6738
Response

How to obtain specific transaction information AND include details

GET /api/purchase_orders/6738 {'fields_include': 'lines'}
Response