Marketplace APIs

Modified on Wed, 1 Oct at 8:40 PM

This article is not available in Arabic, view it in English

Register

Endpoint URL

POST https://api.tryoto.com/rest/v2/register

Example Request Body

Here is an example of a request body:

{
    "mobileNumber":"966559665498",
    "fullName":"test vendor",
    "email":"test987654@example.com",
    "companyName":"test company 987654"}

Request Parameters

Name	Required	Type	Description
companyName	yes	string	Company name of your vendor
email	yes	string	Email of your vendor.(e.g., [test@example.com](https://mailto:test@example.com))
fullName	yes	string	Full name of your vendor
mobileNumber	yes	string	Mobile number of your vendor
crNumber	no	string	CR number of your vendor
vatNumber	no	string	Vat number of your vendor
billingAddress	no	string	Billing address of your vendor
companyLogoURL	no	string	Company logo URL of your vendor
webhookURL	no	string	Webhook URL of your vendor
webhookMethod	no	string	`POST`,`GET`
webhookSecretKey	no	string	Webhook secret key of your vendor
currency	no	string	ISO 4217 three-letter code: SAR, USD

Available Packages: Marketplaces

This API endpoint is just for marketplaces with multiple vendors . Marketplaces can register their vendors to OTO with this endpoint. It requires a special kind of token provided by OTO. Regular refresh tokens will not work here.

If you are a market place you can use register endpoint to create an OTO account for your vendors.

Request Parameters: |

Client Info

Endpoint URL

POST https://api.tryoto.com/rest/v2/clientInfo

Example Request Body

Here is an example of a request body:

{
  "email": "test30@tryoto.com"
}

Request Parameters

Name	Required	Type	Description
email	yes	string	registered email of client

Available Packages: Marketplaces

This API endpoint is just for marketplaces. Marketplaces can register their vendors to OTO with a special kind of token provided by OTO. Regular refresh tokens will not work here.

If you are a marketplace and used register endpoint to create an OTO account for your vendors , you can get the information about the client you have registered.

Request Parameters: |

Client Info

Endpoint URL

GET https://api.tryoto.com/rest/v2/clientInfo

Available Packages: Marketplaces

This API endpoint provides detailed information about a vendor's account and its current status. This endpoint returns essential client related data, including contact details, account balances, and service validity, enabling seamless integration for managing and monitoring client activities.

Request Parameters: No request body parameters are required for this GET request.

Response: ``` json

{

"remainingCredit": 10,

"phone": "+966567130000",

"validityDate": "11 01 2028",

"success": true,

"name": "test Company",

"email": "test@example.com"

}

```