REST Services Overview

Updated 23 hours ago ​by nussi

Overview

SellerCloud has exposed REST API for client consumption that will help managing inventories, orders, warehouses etc. Endpoint where client API can be accessed depends on the server ID.

Example endpoint for clients hosted on TT server is: https://tt.api.sellercloud.com/rest/

Endpoint

Description

Tutorial

https://tt.api.sellercloud.com/token

Used for creating a new token.

Article

https://tt.api.sellercloud.com/rest/api/inventory/get

Used for retrieving metadata of single inventory.

Article

https://tt.api.sellercloud.com/rest/api/inventory/getall

Used for retrieving metadata of many inventories.

Article

https://tt.api.sellercloud.com/rest/api/order/get

Used for retrieving metadata of single sales order.

Article

https://tt.api.sellercloud.com/rest/api/order/getall

Used for retrieving metadata of many sales orders.

Article

https://tt.api.sellercloud.com/rest/api/purchaseorder/get

Used for retrieving metadata of single purchase order.

Article

https://tt.api.sellercloud.com/rest/api/purchaseorder/getall

Used for retrieving metadata of many purchase orders.

Article

https://tt.api.sellercloud.com/rest/api/Order/UpdateShippingStatus

Update shipping status with tracking information

Article

Swagger

Swagger gives us an option for providing the user beautiful and rich documentation for our RESTful web services. You can access swagger documentation by accessing the provided API endpoint with /swagger. The URL should look like the following example: https://tt.api.sellercloud.com/rest/swagger

If you have entered the URL you should be navigated to the documentation and test page. It will look similar to the following screenshot of mine.

On this page you can easily open every single controller we have defined in the API. Within every controller section you will find the available Http Methods(for example get, put, post, delete etc.), which you can test and execute immediately by using the "Try it out!" button from this swagger page.

Swagger Video

In this example you can see how user can do simple authentication and receives authorization token through Swagger UI. Then he uses that token and calls a method for receiving metadata for an order.

Postman Video

In this example you can see how user can do simple authentication through Postman. Then he uses that token and calls a method for receiving metadata for an order.


How did we do?