index

FORMAT: 1A HOST: https://api.orderino.com/api

Orderino REST API

For more information visit https://orderino.com, https://orderino.com/docs or drop us a line to [email protected]

Overview

This documentation describes how users can interact with the resources of the Orderino API. Orderino API is a RESTful API that uses JSON as its main format of communication. It allows users (clients) to access the resources of the Orderino Platform.

Base Resources / Entities

Order - represents an Order object in Orderino Platform. Belongs to Company and Customer.
Customer - represents a Customer object in Orderino Platform. Belongs to Company.
Product - represents a Product object in Orderino Platform. Belongs to Company.
Company - represents a Company object in Orderino Platform

Base URL

The base URL of the API is https://api.orderino.com/api/ Each resource is accessible by requesting this URL + the recource path.

Each user / customer has access only to allowed resources / companies. Allowed companies are returned in companies field in case of successful authentication.

To access resources from specific company, resource path should have company numeric identifier, i.e. company/456784/customers/list

Allowed HTTP Requests

POST - Creates or updates a resource
GET - Retrieves a resource or list of resources

Typical Server Responses

200 OK - The request was successful
400 Bad Request - The request could not be processed due to invalid request parameters.
401 Unauthorized - Token expired (get new token)
403 Forbidden - Access denied, authentication is required
404 Not Found - Resource was not found.
405 Method Not Allowed - Requested method is not supported for the specified resource.
429 Too Many Requests - Exceeded API limits. Pause requests, wait a minute, and try again.
500 Internal Server Error
503 Service Unavailable - The service is temporary unavailable (e.g. scheduled Platform Maintenance). Try again later.

Authentication

Orderino API is a secure API, that requires client authentication using an API token. You can obtain it via authentication method described later in this document. Than use it in the header named Authentication as Authentication: token

Important: You should keep the API key secret and unreachable to third party users. Token can expire, in this case you'll get 401 response. Re-authenticate user in this case and get new token.

Request / Response Structure

POST Requests sent to API should be properly JSON formatted. Typical Response structure is

{
  "status": 1, // Can be 0 in case of an error, 1 - in case of success
  "count": 146, // Count of total objects if we are talking about collection
  "pagination": { // Pagination if we are talking about retrieving collection
    "next": 2,
    "current": 1,
    "pageCount": 6,
    "perPage": 25
  },
  data {}
}

Explanation of the fields is provided below:

Field

Description

status

1 in case of success, 0 in case of an error

count

Count of total objects if we are talking about retrieving collection

pagination

Pagination section if we are talking about retrieving collection

data

Requested object / collection

Sample Data Relevance

Provided in examples below response data may not be relevant / actual. Please check the real data returned by API.

Authentication [/auth]

Request (application/json)

    {
         "login" : "[email protected]",
         "password" : "TpqRY7"
    }

Response 200 (application/json)

    {
          "status": 1,
          "data": {
            "id": "124592",
            "email": null,
            "name": "Demo",
            "isPerformer": false,
            "isManager": false,
            "isAccount": true,
            "token": "token",
            "companies": [
              "25325"
            ]
          }
        }

Company [/company]

Get Company Info [GET /api/company/{company_id}/company/info]

Parameters
- company_id (required, number, 25325) Company Id
Request (application/json)
Headers
```
  Authorization: token
```
Response 200 (application/json)

Body

  {
    "status": 1,
    "data": {
      "order_statuses": {
        "1": {
          "internal_id": "1",
          "name": "New Order",
          "id": "102315",
          "company_id": "25325",
          "sort_order": "0",
          "is_performer": "0",
          "is_completed": "0",
          "is_default": "1",
          "is_canceled": "0",
          "color": "#0a703f",
          "increase_inventory": "0",
          "decrease_inventory": "0",
          "hide": "0"
        },
      },
      "customer_groups": [],
      "managers": [],
      "performers": [],
      "warehouses": [],
      "company": {
        "id": "25325",
        "user_id": "124592",
        "company_legal_name": "My Company",
        "company_legal_summary": "My Company",
        "company_use_vat": "0",
        "company_vat_value": "0",
        "company_currency_internal": "USD",
        "company_currency_payment": "",
        "company_currency_rate": "0",
        "company_is_default": "1",
        "company_added": "1608628643",
        "sms_enabled": "0",
        "sms_sender": "orderino",
        "language": "en",
        "email_sender": "[email protected]",
        "orderno_format": "{C6:0}",
        "orders_count": null,
        "is_deleted": "0",
        "deleted_date": "0000-00-00 00:00:00",
        "viber_sender": null,
        "email_inbox": null
      }
    }
  }

Customers [/api/company/{company_id}/customers]

Parameters
- company_id (required, number, 25325) Company Id

List [GET /api/company/{company_id}/customers/list]

Request (application/json)
Headers
```
  Authorization: token value here
```
Response 200 (application/json)

Body

  {
    "status": 1,
    "count": 146,
    "pagination": {
      "next": 2,
      "current": 1,
      "pageCount": 6,
      "perPage": 25
    },
    "data": [
      {
        "id": "208963",
        "name": "",
        "contact_name": "Name",
        "contact_phone": "9533631296",
        "contact_email": "",
        "legal": "",
        "group_id": "",
        "comment": "",
        "customer_companies": [
          "25325"
        ],
        "customer_type": "",
        "user_id": "",
        "added_at": "1487085158",
        "customer_address": "",
        "photo": "",
        "account_id": "",
        "settings": "",
        "login_allowed": "",
        "timezone": "Europe\/London",
        "idevice": "",
        "adevice": "",
        "last_login": "",
        "is_deleted": "",
        "deleted_date": "0000-00-00 00:00:00",
        "customer_legal": "",
        "performer_id": "9761",
        "user_permissions": "000000000000",
        "contact_phone_clean": "",
        "dob": "",
        "bonus_card": "",
        "bonus_card_balance": "",
        "discount": "",
        "total_sum": "",
        "last_order_date": "",
        "last_followup_date": "",
        "telegram_chat_id": "",
        "telegram": "",
        "manager_name": "",
        "orders_count": "",
        "revenue": "",
        "added_at_string": "2017-02-14 15:12"
      }
      ]
  }

Get Status Breakdown [GET /api/company/{company_id}/customers/pipeline]

For currently authenticated user

Parameters
- company_id (required, number, 25325) Company Id
Request (application/json)
Headers
```
  Authorization: token value here
```
Response 200 (application/json)

Body

  {
    "status": 1,
    "data": [
      {
        "order_status": "1",
        "cnt": "1",
        "sum": "800.00",
        "internal_id": "1",
        "name": "Status Name",
        "id": "1136",
        "company_id": "288",
        "sort_order": "0",
        "is_performer": "1",
        "is_completed": "0",
        "is_default": "1",
        "is_canceled": "0",
        "color": "#0a703f",
        "increase_inventory": "0",
        "decrease_inventory": "0",
        "hide": "0"
      }
    ]
  }

Search Customer [GET /api/company/{company_id}/customers/search-customer?query={query}]

Parameters
- query (required, string, Query String) Search String
Request (application/json)
Headers
```
  Authorization: token value here
```
Response 200 (application/json)

Body

  {
    "status": 1,
    "count": 146,
    "pagination": {
      "next": 2,
      "current": 1,
      "pageCount": 6,
      "perPage": 25
    },
    "data": [
      {
        "id": "208963",
        "name": "",
        "contact_name": "Name",
        "contact_phone": "9533631296",
        "contact_email": "",
        "legal": "",
        "group_id": "",
        "comment": "",
        "customer_companies": [
          "25325"
        ],
        "customer_type": "",
        "user_id": "",
        "added_at": "1487085158",
        "customer_address": "",
        "photo": "",
        "account_id": "",
        "settings": "",
        "login_allowed": "",
        "timezone": "Europe\/London",
        "idevice": "",
        "adevice": "",
        "last_login": "",
        "is_deleted": "",
        "deleted_date": "0000-00-00 00:00:00",
        "customer_legal": "",
        "performer_id": "9761",
        "user_permissions": "000000000000",
        "contact_phone_clean": "",
        "dob": "",
        "bonus_card": "",
        "bonus_card_balance": "",
        "discount": "",
        "total_sum": "",
        "last_order_date": "",
        "last_followup_date": "",
        "telegram_chat_id": "",
        "telegram": "",
        "manager_name": "",
        "orders_count": "",
        "revenue": "",
        "added_at_string": "2017-02-14 15:12"
      }
      ]
  }

Add / Edit Customer [POST /api/company/{company_id}/customers/edit]

Parameters
- company_id (required, number, 25325) Company Id
Request (application/json)
Headers
```
  Authorization: token value here
```

Body

  {
    "comments": [
      {
        "comment": "Item Name"
      }
    ],
    "attributes": [
      {
        "value": "666",
        "attribute_id": 285
      },
      {
        "value": "766,770",
        "attribute_id": 285
      }
    ],
    "customer": {
      "id" : 167828, // Put here customer ID in case of editing, remove it in case of adding new one
      "contact_name": "Alex ",
      "contact_email": "[email protected]",
      "name": "Customer Name",
      "contact_phone": "1123456778",
      "photoUrl": "url to photo to download"
    }
  }

Response 200 (application/json)

Body

  {
    "status": 1,
    "data": [
      {
        "id": "208963",
        "name": "",
        "contact_name": "Name",
        "contact_phone": "9533631296",
        "contact_email": "",
        "legal": "",
        "group_id": "",
        "comment": "",
        "customer_type": "",
        "user_id": "",
        "added_at": "1487085158",
        "customer_address": "",
        "photo": "",
        "account_id": "",
        "settings": "",
        "login_allowed": "",
        "timezone": "Europe\/London",
        "idevice": "",
        "adevice": "",
        "last_login": "",
        "is_deleted": "",
        "deleted_date": "0000-00-00 00:00:00",
        "customer_legal": "",
        "performer_id": "9761",
        "user_permissions": "000000000000",
        "contact_phone_clean": "",
        "dob": "",
        "bonus_card": "",
        "bonus_card_balance": "",
        "discount": "",
        "total_sum": "",
        "last_order_date": "",
        "last_followup_date": "",
        "telegram_chat_id": "",
        "telegram": "",
        "manager_name": "",
        "orders_count": "",
        "revenue": "",
        "added_at_string": "2017-02-14 15:12"
      }
  }

Upload Customer Image [POST /api/company/{company_id}/customers/image?customer_id={customer_id}]

Parameters
- customer_id (required, number, 208963) Customer Id
- company_id (required, number, 25325) Company Id
Request (application/json)
Headers
```
  Authorization: token value here
```
Body
```
  Multipart File Upload
```
Response 200 (application/json)

Body

  {
    "status": 1,
    "data": [
      {
        "id": "208963",
        "name": "",
        "contact_name": "Name",
        "contact_phone": "9533631296",
        "contact_email": "",
        "legal": "",
        "group_id": "",
        "comment": "",
        "customer_type": "",
        "user_id": "",
        "added_at": "1487085158",
        "customer_address": "",
        "photo": "",
        "account_id": "",
        "settings": "",
        "login_allowed": "",
        "timezone": "Europe\/London",
        "idevice": "",
        "adevice": "",
        "last_login": "",
        "is_deleted": "",
        "deleted_date": "0000-00-00 00:00:00",
        "customer_legal": "",
        "performer_id": "9761",
        "user_permissions": "000000000000",
        "contact_phone_clean": "",
        "dob": "",
        "bonus_card": "",
        "bonus_card_balance": "",
        "discount": "",
        "total_sum": "",
        "last_order_date": "",
        "last_followup_date": "",
        "telegram_chat_id": "",
        "telegram": "",
        "manager_name": "",
        "orders_count": "",
        "revenue": "",
        "added_at_string": "2017-02-14 15:12"
      }
  }

Add Comment To Customer [POST /api/company/{company_id}/customers/add-comment]

Parameters
- company_id (required, number, 25325) Company Id
Request (application/json)
Headers
```
  Authorization: token value here
```

Body

  {
    "etype": "customers",
    "id": 208962,
    "comment": "Good Boy"
  }

Response 200 (application/json)
Body
```
  {
    "status": 1
  } 
```

Get Customer Comments [GET /api/company/{company_id}/customers/get-comments?etype={etype}&id={id}]

Parameters
- company_id (required, number, 25325) Company Id
- etype (required, string, customers)
- id (required, number, 208962) Customer Id
Request (application/json)
Headers
```
  Authorization: token value here
```
Response 200 (application/json)

Body

 {
"status": 1,
"data": [
  {
    "id": "1",
    "customer_id": "20162",
    "comment": "Good Boy",
    "user_id": "32",
    "added": "2020-04-18 16:54:21",
    "company_id": "25325",
    "uname": "User added comment",
    "uphoto": ""
  }
]

}

Orders [/api/company/{company_id}/orders]

Parameters
- company_id (required, number, 25325) Company Id

List [GET /api/company/{company_id}/orders/list]

Request (application/json)
Headers
```
  Authorization: token value here
```
Response 200 (application/json)

Body

  {
    "status": 1,
    "data": {
      "order_statuses": {
        "1": {
          "internal_id": "1",
          "name": "Новый заказ",
          "id": "12808",
          "company_id": "25325",
          "sort_order": "0",
          "is_performer": "0",
          "is_completed": "0",
          "is_default": "1",
          "is_canceled": "0",
          "color": "#0a703f",
          "increase_inventory": "0",
          "decrease_inventory": "0",
          "hide": "0"
        },
        "2": {
          "internal_id": "2",
          "name": "Готов к исполнению",
          "id": "12809",
          "company_id": "25325",
          "sort_order": "1",
          "is_performer": "1",
          "is_completed": "0",
          "is_default": "0",
          "is_canceled": "0",
          "color": "#a6981b",
          "increase_inventory": "0",
          "decrease_inventory": "0",
          "hide": "0"
        },
        "3": {
          "internal_id": "3",
          "name": "Завершен",
          "id": "12810",
          "company_id": "25325",
          "sort_order": "2",
          "is_performer": "0",
          "is_completed": "1",
          "is_default": "0",
          "is_canceled": "0",
          "color": "#5db3ad",
          "increase_inventory": "0",
          "decrease_inventory": "0",
          "hide": "0"
        },
        "4": {
          "internal_id": "4",
          "name": "Отменен",
          "id": "12811",
          "company_id": "25325",
          "sort_order": "3",
          "is_performer": "0",
          "is_completed": "0",
          "is_default": "0",
          "is_canceled": "1",
          "color": "#700a4d",
          "increase_inventory": "0",
          "decrease_inventory": "0",
          "hide": "0"
        }
      },
      "customer_groups": [],
      "managers": {
        "14305": "Demo Manager"
      },
      "performers": [],
      "warehouses": [],
      "company": {
        "id": "25325",
        "user_id": "32",
        "company_legal_name": "Demo Company",
        "company_legal_summary": "",
        "company_use_vat": "0",
        "company_vat_value": "0",
        "company_currency_internal": "USD",
        "company_currency_payment": "",
        "company_currency_rate": "0",
        "company_settings": "a:3:{s:15:\"company_address\";s:0:\"\";s:17:\"email_sender_name\";s:12:\"Demo Company\";s:17:\"customer_language\";s:2:\"ru\";}",
        "company_is_default": "0",
        "company_added": "1498484813",
        "sms_enabled": "0",
        "sms_sender": "orderino",
        "language": "ru",
        "email_sender": null,
        "orderno_format": "{C6:0}",
        "orders_count": null,
        "is_deleted": "0",
        "deleted_date": "0000-00-00 00:00:00"
      }
    }
  }

Orders [/api/company/{company_id}/orders]

Parameters
- company_id (required, number, 25325) Company Id

List [GET /api/company/{company_id}/orders/list]

Request (application/json)
Headers
```
  Authorization: token value here
```
Response 200 (application/json)

Body

  {
    "status": 1,
    "data": {
      "order_statuses": {
        "1": {
          "internal_id": "1",
          "name": "Новый заказ",
          "id": "12808",
          "company_id": "25325",
          "sort_order": "0",
          "is_performer": "0",
          "is_completed": "0",
          "is_default": "1",
          "is_canceled": "0",
          "color": "#0a703f",
          "increase_inventory": "0",
          "decrease_inventory": "0",
          "hide": "0"
        },
        "2": {
          "internal_id": "2",
          "name": "Готов к исполнению",
          "id": "12809",
          "company_id": "25325",
          "sort_order": "1",
          "is_performer": "1",
          "is_completed": "0",
          "is_default": "0",
          "is_canceled": "0",
          "color": "#a6981b",
          "increase_inventory": "0",
          "decrease_inventory": "0",
          "hide": "0"
        },
        "3": {
          "internal_id": "3",
          "name": "Завершен",
          "id": "12810",
          "company_id": "25325",
          "sort_order": "2",
          "is_performer": "0",
          "is_completed": "1",
          "is_default": "0",
          "is_canceled": "0",
          "color": "#5db3ad",
          "increase_inventory": "0",
          "decrease_inventory": "0",
          "hide": "0"
        },
        "4": {
          "internal_id": "4",
          "name": "Отменен",
          "id": "12811",
          "company_id": "25325",
          "sort_order": "3",
          "is_performer": "0",
          "is_completed": "0",
          "is_default": "0",
          "is_canceled": "1",
          "color": "#700a4d",
          "increase_inventory": "0",
          "decrease_inventory": "0",
          "hide": "0"
        }
      },
      "customer_groups": [],
      "managers": {
        "14305": "Demo Manager"
      },
      "performers": [],
      "warehouses": [],
      "company": {
        "id": "25325",
        "user_id": "32",
        "company_legal_name": "Demo Company",
        "company_legal_summary": "",
        "company_use_vat": "0",
        "company_vat_value": "0",
        "company_currency_internal": "USD",
        "company_currency_payment": "",
        "company_currency_rate": "0",
        "company_settings": "a:3:{s:15:\"company_address\";s:0:\"\";s:17:\"email_sender_name\";s:12:\"Demo Company\";s:17:\"customer_language\";s:2:\"ru\";}",
        "company_is_default": "0",
        "company_added": "1498484813",
        "sms_enabled": "0",
        "sms_sender": "orderino",
        "language": "ru",
        "email_sender": null,
        "orderno_format": "{C6:0}",
        "orders_count": null,
        "is_deleted": "0",
        "deleted_date": "0000-00-00 00:00:00"
      }
    }
  }

Orders [/api/company/{company_id}/orders]

Parameters
- company_id (required, number, 25325) Company Id

List [GET /api/company/{company_id}/orders/list]

Request (application/json)
Headers
```
  Authorization: token value here
```
Response 200 (application/json)

Body

  {
    "status": 1,
    "data": {
      "order_statuses": {
        "1": {
          "internal_id": "1",
          "name": "Новый заказ",
          "id": "12808",
          "company_id": "25325",
          "sort_order": "0",
          "is_performer": "0",
          "is_completed": "0",
          "is_default": "1",
          "is_canceled": "0",
          "color": "#0a703f",
          "increase_inventory": "0",
          "decrease_inventory": "0",
          "hide": "0"
        },
        "2": {
          "internal_id": "2",
          "name": "Готов к исполнению",
          "id": "12809",
          "company_id": "25325",
          "sort_order": "1",
          "is_performer": "1",
          "is_completed": "0",
          "is_default": "0",
          "is_canceled": "0",
          "color": "#a6981b",
          "increase_inventory": "0",
          "decrease_inventory": "0",
          "hide": "0"
        },
        "3": {
          "internal_id": "3",
          "name": "Завершен",
          "id": "12810",
          "company_id": "25325",
          "sort_order": "2",
          "is_performer": "0",
          "is_completed": "1",
          "is_default": "0",
          "is_canceled": "0",
          "color": "#5db3ad",
          "increase_inventory": "0",
          "decrease_inventory": "0",
          "hide": "0"
        },
        "4": {
          "internal_id": "4",
          "name": "Отменен",
          "id": "12811",
          "company_id": "25325",
          "sort_order": "3",
          "is_performer": "0",
          "is_completed": "0",
          "is_default": "0",
          "is_canceled": "1",
          "color": "#700a4d",
          "increase_inventory": "0",
          "decrease_inventory": "0",
          "hide": "0"
        }
      },
      "customer_groups": [],
      "managers": {
        "14305": "Demo Manager"
      },
      "performers": [],
      "warehouses": [],
      "company": {
        "id": "25325",
        "user_id": "32",
        "company_legal_name": "Demo Company",
        "company_legal_summary": "",
        "company_use_vat": "0",
        "company_vat_value": "0",
        "company_currency_internal": "USD",
        "company_currency_payment": "",
        "company_currency_rate": "0",
        "company_settings": "a:3:{s:15:\"company_address\";s:0:\"\";s:17:\"email_sender_name\";s:12:\"Demo Company\";s:17:\"customer_language\";s:2:\"ru\";}",
        "company_is_default": "0",
        "company_added": "1498484813",
        "sms_enabled": "0",
        "sms_sender": "orderino",
        "language": "ru",
        "email_sender": null,
        "orderno_format": "{C6:0}",
        "orders_count": null,
        "is_deleted": "0",
        "deleted_date": "0000-00-00 00:00:00"
      }
    }
  }

PreviousTest Page NextOrders

Last updated 4 years ago

Was this helpful?

Orderino REST API

Overview

Base Resources / Entities

Base URL

Allowed HTTP Requests

Typical Server Responses

Authentication

Request / Response Structure

Sample Data Relevance

Authentication [/auth]

Get Token [POST /auth/login]

Company [/company]

Get Company Info [GET /api/company/{company_id}/company/info]

Customers [/api/company/{company_id}/customers]

List [GET /api/company/{company_id}/customers/list]

Get Status Breakdown [GET /api/company/{company_id}/customers/pipeline]

Search Customer [GET /api/company/{company_id}/customers/search-customer?query={query}]

Add / Edit Customer [POST /api/company/{company_id}/customers/edit]

Upload Customer Image [POST /api/company/{company_id}/customers/image?customer_id={customer_id}]

Add Comment To Customer [POST /api/company/{company_id}/customers/add-comment]

Get Customer Comments [GET /api/company/{company_id}/customers/get-comments?etype={etype}&id={id}]

Orders [/api/company/{company_id}/orders]

List [GET /api/company/{company_id}/orders/list]

Orders [/api/company/{company_id}/orders]

List [GET /api/company/{company_id}/orders/list]

Orders [/api/company/{company_id}/orders]

List [GET /api/company/{company_id}/orders/list]