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

inventory/supplier/get

POST
/inventory/supplier/get
This returns the list of suppliers 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.
supplier_id
integer 
optional
The supplier ID to search for specifically.
filter_name
string 
optional
Filter the list of suppliers by name.
filter_date_modified
string 
optional
Filter the list of suppliers modified after the spcified date.
filter_deleted
boolean 
optional
Filter the list of suppliers to include deleted records.
filter_channel_group_id
integer 
optional
The channel group ID to search for, comma separated for multiple channel group IDs.
page
integer 
optional
Page number of the results.
sort
string 
optional
The key for the ordering of the results. Accepts "name", "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",
  "supplier_id": 0,
  "filter_name": "string",
  "filter_date_modified": "string",
  "filter_deleted": true,
  "filter_channel_group_id": 0,
  "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.
suppliers
array [object {16}] 
optional
The list of suppliers available.
supplier_id
integer 
required
The supplier ID.
channel_group_id
integer 
required
The channel group ID.
name
string 
required
The supplier name.
firstname
string 
required
The supplier first name.
lastname
string 
required
The supplier last name.
email
string 
required
The comment for the item reservation.
telephone
string 
required
The supplier telephone.
address_1
string 
required
The supplier address 1.
address_2
string 
required
The supplier address 2.
city
string 
required
The supplier city.
postcode
string 
required
The supplier postcode.
zone
string 
required
The supplier zone.
country
string 
required
The supplier country.
date_added
string 
required
The date time the supplier was created.
date_modified
string 
required
The date time the supplier was last modified.
deleted
boolean 
optional
Indicates if the supplier has been deleted. Only returned if filter_deleted is "1".
Example
{
  "error": [
    "string"
  ],
  "total": 0,
  "suppliers": [
    {
      "supplier_id": 0,
      "channel_group_id": 0,
      "name": "string",
      "firstname": "string",
      "lastname": "string",
      "email": "string",
      "telephone": "string",
      "address_1": "string",
      "address_2": "string",
      "city": "string",
      "postcode": "string",
      "zone": "string",
      "country": "string",
      "date_added": "string",
      "date_modified": "string",
      "deleted": true
    }
  ]
}
Previous
inventory/supplier/delete
Next
inventory/transfer_job/get
Built with