Equotix One API
  1. Flow
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
        POST
    • 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
      • inventory/purchase_order/edit
      • inventory/purchase_order/delete
      • inventory/purchase_order/get
    • 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. Flow

inventory/flow/get

POST
/inventory/flow/get
This returns the list of item stock flow 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.
filter_item_id
integer 
optional
The item ID stock flow to search for specifically.
filter_location_id
integer 
optional
Filter the list by location ID.
filter_date_added_start
string 
optional
Filter the list by records added after the specified date time.
filter_date_added_end
string 
optional
Filter the list by records added before the specified date time.
page
integer 
optional
Page number of the results.
sort
string 
optional
The key for the ordering of the results. Accepts "item_flow_id", "date_added"
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",
  "filter_item_id": 0,
  "filter_location_id": 0,
  "filter_date_added_start": "string",
  "filter_date_added_end": "string",
  "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.
flows
array [object {16}] 
optional
The list of item flows available.
item_flow_id
integer 
required
The item flow ID.
item_id
integer 
required
The user ID that created this item flow.
name
string 
required
The item name.
model
string 
required
The item model code.
sku
string 
required
The item SKU code.
cost
number 
optional
The current cost of the item. Only available if API has view cost permission.
average_cost
number 
optional
The current average cost of the item. Only available if API has view cost permission.
pool_cost
number 
optional
The current pool cost of the item. Only available if API has view cost permission.
user_id
integer 
required
The user ID that created this stock flow.
user
string 
required
The username of the user.
location_id
integer 
required
The location ID the stock flow was created at.
location
string 
required
The location name.
quantity
integer 
required
The quantity added or subtracted.
balance
integer 
required
The balance quantity as at point.
comment
string 
required
The comment for the stock flow.
date_added
string 
required
The date time the stock flow was created.
Example
{
  "error": [
    "string"
  ],
  "total": 0,
  "flows": [
    {
      "item_flow_id": 0,
      "item_id": 0,
      "name": "string",
      "model": "string",
      "sku": "string",
      "cost": 0,
      "average_cost": 0,
      "pool_cost": 0,
      "user_id": 0,
      "user": "string",
      "location_id": 0,
      "location": "string",
      "quantity": 0,
      "balance": 0,
      "comment": "string",
      "date_added": "string"
    }
  ]
}
Previous
inventory/deduction/get
Next
inventory/item/add
Built with