Equotix One API
  1. Purchase Order
Equotix One API
  • Getting Started
    • Introduction
    • Authentication
    • API Example
    • Rate Limits
    • API Terms of Use
  • Extension
    • Dashboard
      • Announcement
        • extension/dashboard/announcement/get
    • Module
      • Invoice Copy
        • extension/module/invoice/get
    • Report
      • Channel Payout
        • extension/report/channel_payout/get
    • Total
      • Promotion
        • extension/total/promotion/get
        • extension/total/promotion/getCategory
        • extension/total/promotion/getHistory
      • Tax
        • extension/module/tax/get
  • Integration
    • Channel
      • integration/channel/get
    • Extension
      • integration/extension/get
    • Profile
      • integration/profile/get
  • Inventory
    • Addition
      • inventory/addition/add
      • inventory/addition/edit
      • inventory/addition/delete
      • inventory/addition/get
    • Brand
      • inventory/brand/add
      • inventory/brand/edit
      • inventory/brand/delete
      • inventory/brand/get
    • Category
      • inventory/category/add
      • inventory/category/edit
      • inventory/category/delete
      • inventory/category/get
    • Deduction
      • inventory/deduction/add
      • inventory/deduction/edit
      • inventory/deduction/delete
      • inventory/deduction/get
    • Flow
      • inventory/flow/get
    • Item
      • inventory/item/add
      • inventory/item/edit
      • inventory/item/delete
      • inventory/item/get
      • inventory/item/editStock
    • Location
      • inventory/location/add
      • inventory/location/edit
      • inventory/location/delete
      • inventory/location/get
    • Purchase Order
      • inventory/purchase_order/add
        POST
      • inventory/purchase_order/edit
        POST
      • inventory/purchase_order/delete
        POST
      • inventory/purchase_order/get
        POST
    • Reservation
      • inventory/reservation/add
      • inventory/reservation/edit
      • inventory/reservation/delete
      • inventory/reservation/get
    • Stock Take Job
      • inventory/stock_take_job/get
    • Supplier
      • inventory/supplier/add
      • inventory/supplier/edit
      • inventory/supplier/delete
      • inventory/supplier/get
    • Transfer Job
      • inventory/transfer_job/get
    • Transfer
      • inventory/transfer/add
      • inventory/transfer/edit
      • inventory/transfer/delete
      • inventory/transfer/get
  • Sale
    • Credit Note
      • sale/credit_note/add
      • sale/credit_note/edit
      • sale/credit_note/delete
      • sale/credit_note/get
      • sale/credit_note/getHistory
      • sale/credit_note/addHistory
    • Customer Group
      • sale/customer_group/add
      • sale/customer_group/edit
      • sale/customer_group/delete
      • sale/customer_group/get
    • Customer
      • sale/customer/add
      • sale/customer/edit
      • sale/customer/delete
      • sale/customer/get
      • sale/customer/addReward
      • sale/customer/getReward
    • Order
      • sale/order/add
      • sale/order/edit
      • sale/order/delete
      • sale/order/get
      • sale/order/getHistory
      • sale/order/addHistory
  • Setting
    • Channel Group
      • setting/channel_group/add
      • setting/channel_group/edit
      • setting/channel_group/delete
      • setting/channel_group/get
    • Company
      • setting/company/get
    • Credit Note Status
      • setting/credit_note_status/add
      • setting/credit_note_status/edit
      • setting/credit_note_status/delete
      • setting/credit_note_status/get
    • Currency
      • setting/currency/get
    • Language
      • setting/language/get
    • Order Status
      • setting/order_status/add
      • setting/order_status/edit
      • setting/order_status/delete
      • setting/order_status/get
    • Payment Method
      • setting/payment_method/add
      • setting/payment_method/edit
      • setting/payment_method/delete
      • setting/payment_method/get
    • User Group
      • setting/user_group/get
    • User
      • setting/user/get
  1. Purchase Order

inventory/purchase_order/get

POST
/inventory/purchase_order/get
This returns the list of purchase orders available in the Equotix One account.

Request

Body Params application/json
domain
string 
required
The domain you are assigned to authenticate your Equotix One account.
api_key
string 
required
The email address assigned to the user account in your Equotix One.
auth_timestamp
integer 
required
The unix timestamp used to sign this API request.
auth_signature
string 
required
The calculated signature for this API request.
purchase_order_id
integer 
optional
The purchase order ID to search for specifically.
filter_date_modified
string 
optional
Filter the list of purchase orders modified after the spcified date.
filter_deleted
boolean 
optional
Filter the list of purchase orders to include deleted records.
page
integer 
optional
Page number of the results.
sort
string 
optional
The key for the ordering of the results. Accepts "purchase_order_id", "user", "location", "supplier", "total", "date_estimated_arrival", "date_received", "date_added", "date_modified".
order
string 
optional
The direction for the ordering of the results. Accepts "ASC", "DESC"
limit
integer 
optional
The number of results per page. Accepts 1 to 100.
Example
{
  "domain": "string",
  "api_key": "string",
  "auth_timestamp": 0,
  "auth_signature": "string",
  "purchase_order_id": 0,
  "filter_date_modified": "string",
  "filter_deleted": true,
  "page": 0,
  "sort": "string",
  "order": "string",
  "limit": 0
}

Responses

🟢200Success
application/json
Body
error
array[string]
optional
Returns only if there is an error.
total
integer 
optional
The total number of results available.
purchase_orders
array [object {14}] 
optional
The list of purchase orders available.
purchase_order_id
integer 
required
The purchase order ID.
user_id
integer 
required
The user ID last modified the purchase order.
location_id
integer 
required
The location ID.
supplier_id
integer 
required
The supplier ID.
total
number 
required
The purchase order total.
comment
string 
required
The comment for the purchase order.
currency
string 
required
The currency code.
currency_value
number 
required
The currency value.
date_estimated_arrival
string 
required
The date estimated arrival.
date_received
string 
required
The date received.
date_added
string 
required
The date time the purchase order was created.
date_modified
string 
required
The date time the purchase order was last modified.
items
array [object {4}] 
required
The list of items for the purchase order.
deleted
boolean 
optional
Indicates if the purchase order has been deleted. Only returned if filter_deleted is "1".
Example
{
  "error": [
    "string"
  ],
  "total": 0,
  "purchase_orders": [
    {
      "purchase_order_id": 0,
      "user_id": 0,
      "location_id": 0,
      "supplier_id": 0,
      "total": 0,
      "comment": "string",
      "currency": "string",
      "currency_value": 0,
      "date_estimated_arrival": "string",
      "date_received": "string",
      "date_added": "string",
      "date_modified": "string",
      "items": [
        {
          "item_id": 0,
          "name": "string",
          "quantity": 0,
          "cost": 0
        }
      ],
      "deleted": true
    }
  ]
}
Previous
inventory/purchase_order/delete
Next
inventory/reservation/add
Built with