RTOne APIs

Retrieve RTO Score

Last updated October 20, 2023

Retrieves the RTO score to calculate the probability of an order return.

POSThttps://api.getos1.com/rtone/v1/predict

Headers

x-api-keystringrequired

This key is used for authentication and billing.

Content-typestringrequired

application/json

Body

bodyobjectrequired

The request payload in JSON format.

orderobjectoptional

clstringrequired

Example: ABC SURFACE

order_idstringoptional

Example: amz-126-fba

order_datestringrequired

Example: 12-05-2023

order_valuenumber<float>required

Example: 1024

total_discountnumber<float>required

Example: 200

total_line_item_quantitynumber<float>required

Example: 2

line_itemsarrayrequired

item_idstringrequired

Example: ajio-smh-smj

product_descriptionstringrequired

Example: green_tshirt

item_colourstringoptional

Example: green

item_quantityintegerrequired

Example: 1

item_discountnumber<float>optional

Example: 0

item_pricenumber<float>optional

Example: 524

seller_origin_citystringoptional

Example: bhiwandi

seller_origin_pincodestringoptional

Example: 410889

seller_pickup_locationstringoptional

promised_delivery_datestringoptional

Example: 22-08-2023

shipping_addressobjectrequired

first_namestringoptional

Example: Kalpana

last_namestringoptional

Example: Razdan

address1stringrequired

Example: plt4 sec44

address2stringoptional

citystringoptional

Example: ggn

statestringoptional

Example: Haryana

pincodestringrequired

Example: 122003

billing_addressobjectoptional

first_namestringoptional

Example: Kalpana

last_namestringoptional

Example: Razdan

address1stringoptional

Example: plt4 sec44

address2stringoptional

citystringoptional

Example: ggn

statestringoptional

Example: Haryana

pincodestringoptional

Example: 122003

customerobjectoptional

customer_ipstringoptional

Example: 192.168.0.1

customer_browserstringoptional

Example: Chrome

new_customerstringoptional

Example: 1

device_typestringoptional

Example: laptop

ph_nostringrequired

Example: 9999999999

genderstringoptional

Example: f

Request example

curl --request POST \
     --url https://api.getos1.com/rtone/v1/predict \
     --header 'accept: application/json' \
     --header 'content-type: string' \
     --header 'x-api-key: string' \
     --data '{
     "order": {
     "cl": "ABC SURFACE",
     "order_date": "12-05-2023",
     "order_value": 1024,
     "total_discount": 200,
     "total_line_item_quantity": 2
     },
     "line_items": [
     {
     "item_id": "ajio-smh-smj",
     "product_description": "green_tshirt",
     "item_quantity": 1
     }
     ],
     "shipping_address": {
     "address1": "plt4 sec44",
     "pincode": "122003"
     },
     "customer": {
     "ph_no": "9999999999"
     }
     }'

Responses

200401403422429500

200Success

status_codeintegeroptional

Example: 200

request_idstringoptional

Example: rto_pred|abcde

messagestringoptional

Example: Success

dataobjectoptional

rto_scorenumber<float>optional

Example: 0.35

additional_infoobjectoptional

errorobjectoptional

401Unauthorized

403Forbidden

422Unprocessable content

429Too many requests

500Internal Server Error

Response samples

// Success
{
  "status_code": 200,
  "request_id": "rto_pred|abcde",
  "message": "Success",
  "data": {
    "rto_score": 0.35,
    "additional_info": {}
  },
  "error": {}
}