Edara API
  1. Sales
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
      GET
    • Delete an existing Customer
      DELETE
    • Return a Bundle by ID
      GET
    • Delete an existing Bundle
      DELETE
    • Returns a list of Sales Order Print Templates
      GET
    • Return a SalesOrder by ID
      GET
    • Delete an existing SalesOrder
      DELETE
    • Return a SalesPerson by ID
      GET
    • Delete an existing SalesPerson
      DELETE
    • Return a ServiceItem by ID
      GET
    • Delete an existing ServiceItem
      DELETE
    • Return a Customer Addresses by Customer ID
      GET
    • Return a Customer by Code
      GET
    • Return a Customer by Name
      GET
    • Return a Customer by Email
      GET
    • Find a Customer
      GET
    • Return a Customer by ExternalId
      GET
    • Return a Customer by Mobile
      GET
    • Returns a list of Customers
      GET
    • Update an existing Customer
      PUT
    • Create a new Customer
      POST
    • Return a SalesOrder by Code
      GET
    • Return a Sales Order Print Template by ID
      GET
    • GetCustomerBalance
      GET
    • Return a SalesPerson by Code
      GET
    • Return a SalesPerson by Name
      GET
    • Return a ServiceItem by Code
      GET
    • Return a ServiceItem by Name
      GET
    • Return a SalesPerson by ExternalId
      GET
    • Returns a list of SalesPersons
      GET
    • Update an existing SalesPerson
      PUT
    • Create a new SalesPerson
      POST
    • Return a ServiceItem by ExternalId
      GET
    • Returns a list of ServiceItems
      GET
    • Update an existing ServiceItem
      PUT
    • Create a new ServiceItem
      POST
    • Return Customers by ExternalIds
      GET
    • Returns a list of SalesOrder
      GET
    • Update an existing SalesOrder
      PUT
    • Create a new SalesOrder
      POST
    • Returns a list of SalesStores
      GET
    • Create a new SalesStore
      POST
    • Returns a list of Bundles
      GET
    • Create a new Bundle
      POST
    • Return a list of sales documents by specific criteria
      GET
    • Update existing Customers
      PUT
    • Update the Header an existing SalesOrder
      PUT
    • Update existing Customers
      PUT
    • Update existing Customers
      PUT
    • Deactivate an existing Customer
      PUT
    • Update an existing Customer
      PUT
    • Cancel SalesOrder
      PUT
    • Cancel SalesOrder
      PUT
    • Update an existing SalesOrder
      PUT
    • UnIssue SalesOrder
      PUT
    • Deactivate an existing Customer
      PUT
    • Update an existing SalesPerson
      PUT
    • Update an existing ServiceItem
      PUT
    • Update SalesOrder Status
      PUT
    • Create a new SalesReturn
      POST
    • Create sales order and related IO/SI and return created SO code
      POST
    • Create cash-in for specified SO and update it with discount value and return created cash-in code
      POST
    • Create new Customers
      POST
    • Returns a list of SalesOrder Header
      POST
    • Delete an existing Customer
      DELETE
    • Delete an existing SalesPerson
      DELETE
    • Delete an existing ServiceItem
      DELETE
  • Warehouse
    • Return a Brand by ID
    • Returns a list of standard units of measure
    • Returns a list of StockItems Tree by User ID
    • Return a StockItem by ID
    • Deactivate an existing StockItem
    • Delete an existing StockItem
    • Return a Warehouse by ID
    • Delete an existing warehouse
    • Return a WorkOrder by ID
    • Return a StockItem by SKU
    • Returns a list of StockItem Classifications
    • Create a new stockitem classification
    • Return StockItems by IDs
    • Return a StockItem balance by ID
    • Return a Warehouse balance by Warehouse ID
    • Return a Brand by Name
    • Returns a list of Warehouse Tree by User ID
    • GetStockItemGlobalBalanceBySKU
    • Returns a list of Brands
    • Create a new Brand
    • Return StockItems by Codes
    • Return a StockItem by Code
    • GetStockItemGlobalBalanceByCode
    • Return a Warehouse by Code
    • Return a Warehouse by Name
    • Return a WorkOrder by Code
    • Return stock item global balance object by id
    • Return a StockItem by Code or SKU
    • Returns a list of StockItems
    • Update an existing StockItem
    • Create a new StockItem
    • Returns a list of Warehouses
    • Update an existing Warehouse
    • Create a new Warehouse
    • Returns a list of DynamicProperty Tree by User ID
    • Get stock item cost (by id) on specific date
    • Search for StockItems
    • Returns a list of RMA Warehouses
    • Get bulk stock items cost (by SKUs) on specific date
    • Return a StockItem balance for a specific Warehouse
    • Return a StockItem by Part Number
    • Return a StockItem by Code
    • Return StockItems by External IDs
    • Return StockItems by Part Numbers
    • Get bulk stock items cost (by part numbers) on specific date
    • Validate Item Serial is Returned
    • Validate Item Serial for Returns
    • Return a all StockItems balances
    • Get stockitems balance by warehous
    • Update existing StockItems
    • Update existing StockItems
    • Update Stock Item External Id
    • Update existing StockItems
    • Update Supplies Request
    • Update an existing StockItem
    • Update an existing Warehouse
    • Deactivate an existing StockItem
    • Update an existing issue offering
    • Update an existing receive supplies
    • Create a new Unit Of Measure
    • Create StockItems
    • Create a new issue offering
    • Create a new receive supplies
    • Delete an existing StockItem
    • Delete an existing warehouse
    • Delete an issue offering by code
    • Delete an issue offering by code
  1. Sales

Return a SalesOrder by ID

GET
/v{version}/salesOrders/{salesOrderId}
Sales
Return a SalesOrder by ID...

Request

Path Params
salesOrderId
integer <int32>
required
version
string 
required
The requested API version
Default:
2.0

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/salesOrders/'

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
object (SalesOrderViewModel) 
optional
order_status
string 
optional
Gets or Sets OrderStatus
id
integer <int32>
optional
Gets or Sets Id
document_code
string 
optional
Gets DocumentCode
document_type
string 
optional
paper_number
string 
optional
Gets or Sets PaperNumber
run_sheet_id
string 
optional
/// Gets or Sets RunSheetId
customer_id
integer <int32>
required
Gets or Sets CustomerId
salesPerson_id
integer <int32>
optional
Gets or Sets SalesPersonId
warehouse_id
integer <int32>
optional
Gets or Sets WarehouseId
salesstore_id
integer <int32>
optional
Gets or Sets WarehouseId
shippment_cost
number <double>
optional
Gets or Sets ShippmentCost
document_date
string <date-time>
required
Gets or Sets DocumentDate
shipping_date
string <date-time>
optional
Gets or Sets ShippingDate
gross_total
number <double>
optional
Gets or Sets GrossTotal
sub_total
number <double>
optional
Gets or Sets SubTotal
net_total
number <double>
optional
Gets or Sets NetTotal
total_item_discounts
number <double>
optional
Gets or Sets TotalItemsDiscounts
discount
number <double>
optional
Gets or Sets Discount
discount_rate
number <double>
optional
Gets or Sets Discount rate
taxable
boolean 
optional
Gets or Sets Taxable
apply_tax_after_discount
boolean 
optional
Gets or Sets ApplyTaxAfterDiscount
tax
number <double>
optional
Gets or Sets Tax
cash_amount
number <double>
optional
Gets or Sets CashAmount
currency_id
integer <int32>
optional
Gets or Sets CurrencyId
exchange_rate
number <double>
optional
Gets or Sets ExchangeRate
channel
string 
optional
Gets or Sets Channel
notes
string 
optional
Gets or Sets Notes
external_id
string 
optional
Gets or Sets External ID
related_workorder_code
string 
optional
Gets or Sets RelatedWorkOrderCode
related_workorder_value
number <double>
optional
Gets or Sets RelatedWorkOrderValue
related_salesreturn_codes
array[string]
optional
Gets or Sets RelatedSalesReturnCodes
related_salesorder_codes
array[string]
optional
Gets or Sets RelatedSalesOrderCodes
payment_information
object 
optional
Gets or Sets PaymentInformation
salesOrder_details
array[object (SalesOrderItemViewModel) {22}] 
required
Gets or Sets SalesOrderDetails
salesOrder_installments
array[object (SalesOrderInstallmentViewModel) {7}] 
optional
Gets or Sets SalesOrderInstallments
insert_user_id
integer <int32>
optional
Gets or Sets InsertUserID
insert_date
string <date-time>
optional
Gets or Sets InsertDate
update_user_id
integer <int32>
optional
Gets or Sets UpdateUserID
update_date
string <date-time>
optional
Gets or Sets UpdateDate
address_id
integer <int32>
optional
Gets or Sets AddressId
payment_status
string 
optional
Gets or Sets PaymentStatus
other_credit_amount
number <double>
optional
Gets or Sets OtherCreditAmount
total_count
integer <int32>
optional
Example
{
  "status_code": 0,
  "error_message": "string",
  "result": {
    "order_status": "string",
    "id": 0,
    "document_code": "string",
    "document_type": "string",
    "paper_number": "string",
    "run_sheet_id": "string",
    "customer_id": 0,
    "salesPerson_id": 0,
    "warehouse_id": 0,
    "salesstore_id": 0,
    "shippment_cost": 0,
    "document_date": "2019-08-24T14:15:22Z",
    "shipping_date": "2019-08-24T14:15:22Z",
    "gross_total": 0,
    "sub_total": 0,
    "net_total": 0,
    "total_item_discounts": 0,
    "discount": 0,
    "discount_rate": 0,
    "taxable": true,
    "apply_tax_after_discount": true,
    "tax": 0,
    "cash_amount": 0,
    "currency_id": 0,
    "exchange_rate": 0,
    "channel": "string",
    "notes": "string",
    "external_id": "string",
    "related_workorder_code": "string",
    "related_workorder_value": 0,
    "related_salesreturn_codes": [
      "string"
    ],
    "related_salesorder_codes": [
      "string"
    ],
    "payment_information": {
      "property1": 0,
      "property2": 0
    },
    "salesOrder_details": [
      {
        "id": 0,
        "document_id": 0,
        "quantity": 0,
        "Issuedquantity": 0,
        "unit_price": 0,
        "price": 0,
        "tax_id": 0,
        "item_discount": 0,
        "item_discount_type": 0,
        "warehouse_id": 0,
        "bundle_id": 0,
        "service_item_id": 0,
        "stock_item_id": 0,
        "stock_item_code": "string",
        "stock_item_description": "string",
        "comments": "string",
        "returned_quantity": 0,
        "insert_user_id": 0,
        "insert_date": "2019-08-24T14:15:22Z",
        "update_user_id": 0,
        "update_date": "2019-08-24T14:15:22Z",
        "bundle_quantity": 0
      }
    ],
    "salesOrder_installments": [
      {
        "id": 0,
        "document_id": 0,
        "days_limit": 0,
        "amount": 0,
        "due_date": "2019-08-24T14:15:22Z",
        "account_id": 0,
        "payment_type": "string"
      }
    ],
    "insert_user_id": 0,
    "insert_date": "2019-08-24T14:15:22Z",
    "update_user_id": 0,
    "update_date": "2019-08-24T14:15:22Z",
    "address_id": 0,
    "payment_status": "string",
    "other_credit_amount": 0
  },
  "total_count": 0
}
🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Modified at 2025-02-10 16:54:43
Previous
Returns a list of Sales Order Print Templates
Next
Delete an existing SalesOrder
Built with