Web Service API Specification: CloudMA Integration Guide

This documentation provides a comprehensive guide for developers to integrate with the CloudMA web services. The specification covers methods for sales, purchasing, and stock synchronization

Document Overview

1. General Conventions and Authentication

To ensure secure and standardized communication, the API follows specific protocols

2. API Methods

A. Push Sale

This endpoint allows the client to push sales records to the server

Url: https://testdev.cloudma.app/api/push-sale

• Method: POST

• Key Parameters:

token (String): '38iGm3yI86Hw

customer_name (String): Name of the customer

customer_email (String): Email of the customer 

reference_no (String): Unique sale reference 

shipping_cost (Double): Cost of shipping 

total_discount (Double): Total discount applied 

grand_total (Double): Grand total of the sale 

items (Array): A collection of objects containing code (String), qty (Integer), discount (Double), total (Double), and unit_price (Double)

B. Push Purchase (GRN)

This endpoint is used for recording purchase data/Goods Received Notes.

URL: https://testdev.cloudma.app/api/push-purchase 

• Method: POST

• Key Parameters:

token (String): '38iGm3yI86Hw' 

reference_no (String): Purchase reference identifier

items (Array): Contains code, qty, discount, total, and unit_cost (Double)

C. Sync Stock

Used to retrieve current stock levels for active products

URL: https://testdev.cloudma.app/api/sync-stock 31

Method: POST

Parameter: Requires only the security token.

3. Status Codes and Error Handling

The API utilizes standard HTTP status codes.