Skip to content

armsoft/trade-public-api-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ArmSoft Trade Public API Documentation

API Version .NET OpenAPI

Official documentation for the ArmSoft Trade Public API.

📋 Overview

The ArmSoft Trade Public API provides programmatic access to:

  • Products: Product catalog management with CRUD operations
  • Product Measure Units: Alternative measurement units management
  • Multi-language Support: Armenian (hy-AM), English (en-US), Russian (ru-RU)

Key Features

✅ RESTful design with JSON responses
✅ API Key authentication (header-based)
✅ Comprehensive error handling
✅ OpenAPI/Swagger specification
✅ Multi-language support
✅ Built on ASP.NET Core 10 / C# 13

🚀 Quick Start

1. Get Your API Key

Contact your ArmSoft administrator to obtain an API key.

2. Make Your First Request

curl -X GET "https://api.armsoft.am/trade/v1/directories/products/PROD001" -H "apiKey: your-api-key-here" -H "Accept-Language: hy-AM"

3. Response

{ "id": 12345, "code": "PROD001", "name": "Sample Product", "baseUnitMeasure": "PCS", "vat": true, "showInPriceLists": true }

🔐 Authentication

All API requests require an API key in the request header:

apiKey: your-api-key-here Accept-Language: hy-AM

API Key Types:

  • Full Access: Complete CRUD operations on all resources
  • Limited Access: Restricted to specific operations (e.g., online store)

📖 Full Authentication Guide

📚 API Reference

Base URL

https://api.armsoft.am/trade/v{version}

Current version: v1

Products Endpoints

Method Endpoint Description
POST /directories/products/list Get all products with filters
GET /directories/products/{code} Get product by code
POST /directories/products Create new product
PUT /directories/products/{code} Update product
DELETE /directories/products/{code} Delete product

Product Measure Units Endpoints

Method Endpoint Description
POST /directories/products/measureunits/list Get all measure units
GET /directories/products/{productCode}/measureunits/{unitCode} Get measure unit
POST /directories/products/measureunits Create measure unit
PUT /directories/products/{productCode}/measureunits/{unitCode} Update measure unit
DELETE /directories/products/{productCode}/measureunits/{unitCode} Delete measure unit

📖 Code Examples

📖 Documentation

Document Description
Getting Started Installation and setup guide
Authentication API key authentication details
API Reference Complete endpoint documentation
Products API Detailed Products endpoint reference
Error Handling Error codes and responses

🛠️ OpenAPI Specification

Interactive API documentation available via Swagger:

  • Swagger UI: https://api.armsoft.am/trade/swagger
  • OpenAPI Spec: openapi.yaml

Import the OpenAPI specification into:

  • Postman
  • SwaggerHub
  • Any OpenAPI-compatible tool

🌍 Multi-Language Support

Set the Accept-Language header to receive localized responses:

Language Code Example
Armenian hy-AM Accept-Language: hy-AM
English en-US Accept-Language: en-US
Russian ru-RU Accept-Language: ru-RU

📊 HTTP Status Codes

Code Description
200 OK - Successful request
201 Created - Resource created successfully
400 Bad Request - Invalid request data
401 Unauthorized - Invalid or missing API key
403 Forbidden - Insufficient permissions
404 Not Found - Resource doesn't exist
405 Method Not Allowed
409 Conflict - Resource conflict (e.g., duplicate)
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error
503 Service Unavailable

🔄 Versioning

API version is specified in the URL:

/api/v1/directories/products

  • Current version: v1
  • Backward compatibility maintained within major versions

📜 License

© 2026 ArmSoft - Armenian Software. All rights reserved.

This documentation is provided for API integration purposes. For licensing of the ArmSoft Trade system, contact ArmSoft.

🏢 About ArmSoft

ArmSoft is a leading provider of enterprise resource planning (ERP) solutions for businesses in Armenia and beyond. The Trade system is designed for small and medium enterprises to manage their trade operations efficiently.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •