Edara API
  1. Warehouse
Edara API
  • Edara API Walk Through
  • Edara Webhooks
  • Accounting
    • Returns a list of Taxs
    • Returns a list of Accounts
    • Returns a list of NP Report
    • Returns a list of NR Report
    • Return a Tax by ID
    • Returns a list of Cost Centers
    • Returns an Account by Id
    • Return a Currency by ID
    • Delete an existing Currency
    • Return a Tax by Name
    • Return a Taxes by Rate
    • Return a Taxes by Scope
    • Returns an Cost Center by Id
    • Return a E-Invoice tax codes by country
    • Returns a list of Accounts by Account Type
    • Return a Currency by Code
    • Returns a list of Account Nodes
    • Returns a list of Currencies
    • Update an existing Currency
    • Create a new Currency
    • Return account by description
    • Return a Journal Entry by Code
    • Returns an Account
    • Returns an Account
    • Returns an Account by ClassificationCode
    • Returns an Account
    • Returns Account Balance
    • UpdateTax
    • Create a new Tax
    • Update an existing Currency
    • Update a Journal Entry By Code
    • Return a Journal Entry by Code
    • Create a Cash Out
    • Create a Journal Entry
    • Pay Sales Order By Journal Entry
    • Create a Taxable Sales Invoice
    • Delete an existing Tax
    • Delete an existing Currency
    • Delete a Journal Entry by Code
  • Common
    • Returns a list of Cities
    • Update an existing City
    • Create a new City
    • Returns a list of Countries
    • Update an existing Country
    • Create a new Country
    • Returns a list of Districts
    • Update an existing District
    • Create a new District
    • Return a City by ID
    • Delete an existing City
    • Return a Country by ID
    • Delete an existing Country
    • Return a District by ID
    • Delete an existing District
    • Find a City by Name
    • Returns a list of Districts by City Id
    • Returns a list of Cities by Country Id
    • Find a Country by Name
    • Find a District by Name
    • Return a Classification by ID
    • Return a Setting by Module and Key
    • Find a Classification by Name
    • Returns a list of Setting
    • Convert money from numeric value to Arabic words
    • Convert money from numeric value to English words
    • Ping
    • Notifications
  • Purchase
    • find supplier by Id
    • Delete supplier
    • Return a PurchaseOrder by ID
    • find supplier by name
    • Returns a list of Suppliers
    • update supplier
    • create supplier
    • Returns a list of PurchaseOrder
    • Return a PurchaseOrder by Code
  • Sales
    • Return a Customer by ID
    • Delete an existing Customer
    • Return a Bundle by ID
    • Delete an existing Bundle
    • Returns a list of Sales Order Print Templates
    • Return a SalesOrder by ID
    • Delete an existing SalesOrder
    • Return a SalesPerson by ID
    • Delete an existing SalesPerson
    • Return a ServiceItem by ID
    • Delete an existing ServiceItem
    • Return a Customer Addresses by Customer ID
    • Return a Customer by Code
    • Return a Customer by Name
    • Return a Customer by Email
    • Find a Customer
    • Return a Customer by ExternalId
    • Return a Customer by Mobile
    • Returns a list of Customers
    • Update an existing Customer
    • Create a new Customer
    • Return a SalesOrder by Code
    • Return a Sales Order Print Template by ID
    • GetCustomerBalance
    • Return a SalesPerson by Code
    • Return a SalesPerson by Name
    • Return a ServiceItem by Code
    • Return a ServiceItem by Name
    • Return a SalesPerson by ExternalId
    • Returns a list of SalesPersons
    • Update an existing SalesPerson
    • Create a new SalesPerson
    • Return a ServiceItem by ExternalId
    • Returns a list of ServiceItems
    • Update an existing ServiceItem
    • Create a new ServiceItem
    • Return Customers by ExternalIds
    • Returns a list of SalesOrder
    • Update an existing SalesOrder
    • Create a new SalesOrder
    • Returns a list of SalesStores
    • Create a new SalesStore
    • Returns a list of Bundles
    • Create a new Bundle
    • Return a list of sales documents by specific criteria
    • Update existing Customers
    • Update the Header an existing SalesOrder
    • Update existing Customers
    • Update existing Customers
    • Deactivate an existing Customer
    • Update an existing Customer
    • Cancel SalesOrder
    • Cancel SalesOrder
    • Update an existing SalesOrder
    • UnIssue SalesOrder
    • Deactivate an existing Customer
    • Update an existing SalesPerson
    • Update an existing ServiceItem
    • Update SalesOrder Status
    • Create a new SalesReturn
    • Create sales order and related IO/SI and return created SO code
    • Create cash-in for specified SO and update it with discount value and return created cash-in code
    • Create new Customers
    • Returns a list of SalesOrder Header
    • Delete an existing Customer
    • Delete an existing SalesPerson
    • Delete an existing ServiceItem
  • Warehouse
    • Return a Brand by ID
      GET
    • Returns a list of standard units of measure
      GET
    • Returns a list of StockItems Tree by User ID
      GET
    • Return a StockItem by ID
      GET
    • Deactivate an existing StockItem
      PUT
    • Delete an existing StockItem
      DELETE
    • Return a Warehouse by ID
      GET
    • Delete an existing warehouse
      DELETE
    • Return a WorkOrder by ID
      GET
    • Return a StockItem by SKU
      GET
    • Returns a list of StockItem Classifications
      GET
    • Create a new stockitem classification
      POST
    • Return StockItems by IDs
      GET
    • Return a StockItem balance by ID
      GET
    • Return a Warehouse balance by Warehouse ID
      GET
    • Return a Brand by Name
      GET
    • Returns a list of Warehouse Tree by User ID
      GET
    • GetStockItemGlobalBalanceBySKU
      GET
    • Returns a list of Brands
      GET
    • Create a new Brand
      POST
    • Return StockItems by Codes
      GET
    • Return a StockItem by Code
      GET
    • GetStockItemGlobalBalanceByCode
      GET
    • Return a Warehouse by Code
      GET
    • Return a Warehouse by Name
      GET
    • Return a WorkOrder by Code
      GET
    • Return stock item global balance object by id
      GET
    • Return a StockItem by Code or SKU
      GET
    • Returns a list of StockItems
      GET
    • Update an existing StockItem
      PUT
    • Create a new StockItem
      POST
    • Returns a list of Warehouses
      GET
    • Update an existing Warehouse
      PUT
    • Create a new Warehouse
      POST
    • Returns a list of DynamicProperty Tree by User ID
      GET
    • Get stock item cost (by id) on specific date
      GET
    • Search for StockItems
      GET
    • Returns a list of RMA Warehouses
      GET
    • Get bulk stock items cost (by SKUs) on specific date
      GET
    • Return a StockItem balance for a specific Warehouse
      GET
    • Return a StockItem by Part Number
      GET
    • Return a StockItem by Code
      GET
    • Return StockItems by External IDs
      GET
    • Return StockItems by Part Numbers
      GET
    • Get bulk stock items cost (by part numbers) on specific date
      GET
    • Validate Item Serial is Returned
      GET
    • Validate Item Serial for Returns
      GET
    • Return a all StockItems balances
      GET
    • Get stockitems balance by warehous
      GET
    • Update existing StockItems
      PUT
    • Update existing StockItems
      PUT
    • Update Stock Item External Id
      PUT
    • Update existing StockItems
      PUT
    • Update Supplies Request
      PUT
    • Update an existing StockItem
      PUT
    • Update an existing Warehouse
      PUT
    • Deactivate an existing StockItem
      PUT
    • Update an existing issue offering
      PUT
    • Update an existing receive supplies
      PUT
    • Create a new Unit Of Measure
      POST
    • Create StockItems
      POST
    • Create a new issue offering
      POST
    • Create a new receive supplies
      POST
    • Delete an existing StockItem
      DELETE
    • Delete an existing warehouse
      DELETE
    • Delete an issue offering by code
      DELETE
    • Delete an issue offering by code
      DELETE
  1. Warehouse

Returns a list of StockItems

GET
/v{version}/stockItems
Warehouse
Returns a list of StockItems...

Request

Path Params
version
string 
required
The requested API version
Default:
2.0
Query Params
offset
integer <int32>
required
The number of items to skip before starting to collect the result
limit
integer <int32>
required
The numbers of items to return.

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v/stockItems?offset&limit'

Responses

🟢200OK
application/json
OK
Body
status_code
integer <int32>
optional
Gets or sets the status_code.
error_message
string 
optional
Gets or sets the error_message.
result
array[object (StockItemViewModel) {44}] 
optional
Gets or sets the result.
id
integer <int32>
optional
Gets or Sets Id
description
string 
required
Gets or Sets Description
other_lang_description
string 
optional
Gets or Sets Description
code
string 
required
Gets or Sets Code
sku
string 
optional
Gets or Sets Sku
price
number <double>
optional
Gets or Sets Price
purchase_price
number <double>
optional
Gets or Sets PurchasePrice
dealer_price
number <double>
optional
Gets or Sets DealerPrice
supper_dealer_price
number <double>
optional
Gets or Sets SupperDealerPrice
minimum_price
number <double>
optional
Gets or Sets MinimumPrice
part_number
string 
optional
Gets or Sets PartNumber
tax_id
integer <int32>
optional
Gets or Sets TaxRate
withholding_tax_id
integer <int32>
optional
Gets or Sets WithholdingTaxId
classification_id
integer <int32>
optional
Gets or Sets ClassificationId
brand_id
integer <int32>
optional
Gets or Sets BrandId
warranty
number <double>
optional
Gets or Sets Warranty
external_id
string 
optional
Gets or Sets External ID
dynamic_properties_info
array[object (DynamicPropertyInfoViewModel) {4}] 
optional
Gets or Sets Dynamic Properties Info
unitofmeasure_chain_id
integer <int32>
optional
Gets or Sets UnitOfMeasureChainID
default_unitofmeasure_id
integer <int32>
optional
Gets or Sets DefaultUnitOfMeasureID
unitofmeasures_info
array[object (StockItemUnitOfMeasuresViewModel) {7}] 
optional
Gets or Sets Dynamic Properties Info
sales_price_discount
number <double>
optional
Gets or Sets Dynamic Properties Info
sales_price_discount_type
integer <int32>
optional
Gets or Sets Dynamic Properties Info
sales_price_discount_is_limited
boolean 
optional
Gets or Sets Dynamic Properties Info
sales_price_discount_date_from
string <date-time>
optional
Gets or Sets Dynamic Properties Info
sales_price_discount_date_to
string <date-time>
optional
Gets or Sets Dynamic Properties Info
dealer_price_discount
number <double>
optional
Gets or Sets Dynamic Properties Info
dealer_price_discount_type
integer <int32>
optional
Gets or Sets Dynamic Properties Info
dealer_price_discount_is_limited
boolean 
optional
Gets or Sets Dynamic Properties Info
dealer_price_discount_date_from
string <date-time>
optional
Gets or Sets Dynamic Properties Info
dealer_price_discount_date_to
string <date-time>
optional
Gets or Sets Dynamic Properties Info
super_dealer_price_discount
number <double>
optional
Gets or Sets Dynamic Properties Info
super_dealer_price_discount_type
integer <int32>
optional
Gets or Sets Dynamic Properties Info
super_dealer_price_discount_is_limited
boolean 
optional
Gets or Sets Dynamic Properties Info
super_dealer_price_discount_date_from
string <date-time>
optional
Gets or Sets Dynamic Properties Info
super_dealer_price_discount_date_to
string <date-time>
optional
Gets or Sets Dynamic Properties Info
weight
number <double>
optional
Gets or Sets Weight
data_sheet
string 
optional
Gets or Sets Datasheet
note
string 
optional
Gets or Sets Note
standard_uom_id
integer <int32>
optional
Gets or Sets StandardUomId
is_grouping_item
boolean 
optional
Gets or Sets IsGroupingItem
parent_item_id
integer <int32>
optional
Gets or Sets ParentItemId
child_items
array[object (StockItemViewModel) {44}] 
optional
tags
array[string]
optional
Gets or Sets Tags
total_count
integer <int32>
optional
Example
{
  "status_code": 0,
  "error_message": "string",
  "result": [
    {
      "id": 0,
      "description": "string",
      "other_lang_description": "string",
      "code": "string",
      "sku": "string",
      "price": 0,
      "purchase_price": 0,
      "dealer_price": 0,
      "supper_dealer_price": 0,
      "minimum_price": 0,
      "part_number": "string",
      "tax_id": 0,
      "withholding_tax_id": 0,
      "classification_id": 0,
      "brand_id": 0,
      "warranty": 0,
      "external_id": "string",
      "dynamic_properties_info": [
        {
          "dynamic_property_id": 0,
          "dynamic_property": "string",
          "dynamic_value_id": 0,
          "dynamic_value": "string"
        }
      ],
      "unitofmeasure_chain_id": 0,
      "default_unitofmeasure_id": 0,
      "unitofmeasures_info": [
        {
          "id": 0,
          "stock_item_id": 0,
          "unit_of_measure_id": 0,
          "uom_name": "string",
          "uom_code": "string",
          "uom_part_number": "string",
          "uom_price": 0
        }
      ],
      "sales_price_discount": 0,
      "sales_price_discount_type": 0,
      "sales_price_discount_is_limited": true,
      "sales_price_discount_date_from": "2019-08-24T14:15:22Z",
      "sales_price_discount_date_to": "2019-08-24T14:15:22Z",
      "dealer_price_discount": 0,
      "dealer_price_discount_type": 0,
      "dealer_price_discount_is_limited": true,
      "dealer_price_discount_date_from": "2019-08-24T14:15:22Z",
      "dealer_price_discount_date_to": "2019-08-24T14:15:22Z",
      "super_dealer_price_discount": 0,
      "super_dealer_price_discount_type": 0,
      "super_dealer_price_discount_is_limited": true,
      "super_dealer_price_discount_date_from": "2019-08-24T14:15:22Z",
      "super_dealer_price_discount_date_to": "2019-08-24T14:15:22Z",
      "weight": 0,
      "data_sheet": "string",
      "note": "string",
      "standard_uom_id": 0,
      "is_grouping_item": true,
      "parent_item_id": 0,
      "child_items": [
        {}
      ],
      "tags": [
        "string"
      ]
    }
  ],
  "total_count": 0
}
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
Modified at 2025-02-10 16:54:43
Previous
Return a StockItem by Code or SKU
Next
Update an existing StockItem
Built with