Carisastock.com - Web API V1.0

Web Api

All of these web services include authentication for security purposes. In order to reach our web api, it is necessary to first register with carisastock.com and run the web api.

It is mandatory to include this ApiKey in the headers of all web APIs. Otherwise, he will not be able to get a response from the services.


1) View all product list and details.



This web api is the service that gives the details of all the products in the whole system. It works with the get method.

http://carisastock.com/api/StockWebService/

How To Use:

The only requirement is to pass a valid apiKey in the header.

curl -X GET "http://carisastock.com/api/StockWebService/" -H "apiKey: YOUR_API_KEY"




2) Single product detail view.


This web api is the service that exports the details of the product corresponding to a sku code. It works with the get method.

http://carisastock.com/api/StockWebService/skucode

How To Use:

In order for the web service to respond, the api key must be sent in the header. For product details, the product stock code must be sent.

curl -X GET "http://carisastock.com/api/StockWebService/10AND06000495051010" -H "apiKey: YOUR_API_KEY"




3) Create Order.


It is the web api that creates an order on carisastock.com in line with the parameters sent. It works with the post method.

http://carisastock.com/api/StockWebService/CreateOrder

How To Use:

Valid apiKey and Content-Type must be passed as application/json in Header. In addition, the following steps must be conveyed in the body.

{ "ApiKey": " YOUR_API_KEY ", "S_FirstName": "John", "S_LastName": "Doe", "S_Company": "ABC Company", "S_Email": "john.doe@example.com", "S_AddressInfo": "123 Main St", "S_StateProvince": "CA", "S_ZipPostalCode": "12345", "S_Telephone": "555-1234", "S_Fax": "555-5678", "S_MobileNumber": "555-9876", "B_FirstName": "Jane", "B_LastName": "Smith", "B_Company": "XYZ Inc", "B_Email": "jane.smith@example.com", "B_AddressInfo": "456 Elm St", "B_StateProvince": "NY", "B_ZipPostalCode": "54321", "B_Telephone": "555-4321", "B_Fax": "555-8765", "B_MobileNumber": "555-6789", "ReferenceNumber": "test", "Products": [{ "ProductCode": "10AND06000495051010", "Quantity": 1 }] }

Curl Example: curl -X POST "http://carisastock.com/api/StockWebService/CreateOrder" \ -H "apiKey: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "ApiKey": " YOUR_API_KEY ", "S_FirstName": "John", "S_LastName": "Doe", "S_Company": "ABC Company", "S_Email": "john.doe@example.com", "S_AddressInfo": "123 Main St", "S_StateProvince": "CA", "S_ZipPostalCode": "12345", "S_Telephone": "555-1234", "S_Fax": "555-5678", "S_MobileNumber": "555-9876", "B_FirstName": "Jane", "B_LastName": "Smith", "B_Company": "XYZ Inc", "B_Email": "jane.smith@example.com", "B_AddressInfo": "456 Elm St", "B_StateProvince": "NY", "B_ZipPostalCode": "54321", "B_Telephone": "555-4321", "B_Fax": "555-8765", "B_MobileNumber": "555-6789", "ReferenceNumber": "test", "Products": [{ "ProductCode": "10AND06000495051010", "Quantity": 1 }] }'




4) See order details.


It is the web api that sends the details of all orders belonging to the requesting user. It works with the post method.

http://carisastock.com/api/StockWebService/GetConsignmentDetail

How To Use:

apiKey and Content-Type must be sent in Header. Also, ApiKey must be sent in the body.

curl -X POST "http://carisastock.com/api/StockWebService/ GetConsignmentDetail" \ -H "apiKey: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "ApiKey": " YOUR_API_KEY " }'