Stock List

This article provides comprehensive information and documentation on a set of API methods specifically designed to handle stock lists. By leveraging these methods, users can retrieve, search, and create stock lists, allowing for seamless integration and management of stock list data within the system.

The article includes detailed explanations, parameter descriptions, and usage examples for each API method, empowering developers to effectively utilize the capabilities provided by the stock list API.

Get Stock Lists

The stocks of the products are kept in the stock list. Therefore, before defining a stock for a product, if there is no stock list, it is necessary to define a stock list first.

Parameter	Data Type	Default	In	Description
api_token	string		header	The API key of the customer’s account
limit	integer	10	query	Amount of line items per page that will be returned
page	integer	1	query	Page number to return

Request GET

This request is used to retrieve stock lists according to page and limit parameters.

‘content_type’ header represents the response type.

‘Authorization’ header is a required header for authentication. You can retrieve api_token with login.

Path: stock_list/

import requests

url = "https://{customer_api_url}/api/i1/stock_list/"
api_token = "f532eXXXXXXXXXXXXXXXXX201XXXXX9332d"

headers = {
    'content-type': 'application/json',
    'Authorization': 'Token {}'.format(api_token)
}

response = requests.get(url, headers=headers)
print(response.text)

Response

Response contains all stock list data with given parameters. Resource properties are in Python format.

Property	Data Type	Description
name	string	Name of the stock list
code	string	The list id in ERP. It is necessary when ‘is_auto_sync’ is True.
is_auto_sync	string	Defines whether the list is synchronized with ERP. If True, the list will update automatically.

“count” shows how many stock lists exist in the system.

“next” shows the next cursor url to retrieve the desired stock lists.

“previous” shows the previous cursor url to retrieve the desired stock lists.

“results” shows every stock list detail.

{
  "count": 20,
  "next": "https://{customer_api_url}/api/i1/stock_list/?page=2",
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "Alpha Stock List",
      "code": null,
      "is_auto_sync": false
    },
    {
      "id": 2,
      "name": "Marketplace Stock List",
      "code": null,
      "is_auto_sync": false
    },
    {
      "id": 3,
      "name": "Warehouse Stock List",
      "code": null,
      "is_auto_sync": false
    },
    {
      "id": 4,
      "name": "E-Shop Stock List",
      "code": "shop112",
      "is_auto_sync": true
    }
  ]
}

Search Stock List

The stocks of the products are kept in the stock list. Therefore, before defining stock for a product, if there is no stock list, it is necessary to define a stock list first. After the stock lists are defined, it may be necessary to search the stock lists.

Parameter	Data Type	Default	In	Description
api_token	string		header	The API key of the customer’s account
name	string		query	Stock list's name
limit	integer	10	query	Amount of items per page that will be returned
page	integer	1	query	Page number to return

Request GET

This request is used to retrieve stock lists according to page, limit and given filter parameters.

Field	Description
name	Searches “name” field based on the value, case in-sensitive
code	Searches “code” field based on the value, case in-sensitive

‘content_type’ header represents the response type.

‘Authorization’ header is a required header for authentication. You can retrieve api_token with login.

Path: stock_list/

import requests

url = "https://{customer_api_url}/api/i1/stock_list/?{field}={value}"
api_token = "f532eXXXXXXXXXXXXXXXXX201XXXXX9332d"

headers = {
    'content-type': 'application/json',
    'Authorization': 'Token {}'.format(api_token)
}

response = requests.get(url, headers=headers)
print(response.text)

Response

Response contains all stock list data with search parameters. Resource properties are in Python format.

Property	Data Type	Description
name	string	Name of the stock list
code	string	The list ID in ERP. It is necessary when `is_auto_sync` is True
is_auto_sync	boolean	Defines whether the list is synchronized with ERP. If True, the list will update automatically

“count” shows how many stock lists exist in the system.

“next” shows the next cursor url to retrieve the desired stock lists.

“previous” shows the previous cursor url to retrieve the desired stock lists.

“results” shows matched stock list’s in detail.

{
  "count": 20,
  "next": "https://{customer_api_url}/api/i1/stock_list/?page=2",
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "Alpha Stock List",
      "code": null,
      "is_auto_sync": false
    },
    {
      "id": 2,
      "name": "Marketplace Stock List",
      "code": null,
      "is_auto_sync": false
    },
    {
      "id": 3,
      "name": "Warehouse Stock List",
      "code": null,
      "is_auto_sync": false
    },
    {
      "id": 4,
      "name": "E-Shop Stock List",
      "code": "shop112",
      "is_auto_sync": true
    }
  ]
}

Create Stock List

The stocks of the products are kept in the stock list. Therefore, before defining stock for a product, if there is no stock list, it is necessary to create a stock list first.

Parameter	Data Type	In	Required	Description
api_token	string	header	YES	The API key of the customer’s account
name	float	body	YES	List name
code	string	body	NO	The list ID in ERP
is_auto_sync	id	body	NO	Specifies whether the list will have synchronization with ERP. If the parameter is True, the list will be automatically updated by ERP. If it is False, stock creation and updating processes are managed in Omnitron with excel.

Request POST

This request is used to create a new stock list according to the given body. “name” and “code” fields are unique.

‘content_type’ header represents the response type.

‘Authorization’ header is a required header for authentication. You can retrieve api_token with login.

Path:v1/stock_list/

import requests
import json

url = "https://{customer_api_url}/api/v1/stock_list/"
api_token = "f532eXXXXXXXXXXXXXXXXX201XXXXX9332d"

headers = {
    'content-type': 'application/json',
    'Authorization': 'Token {}'.format(api_token)
}

data = {
    'name': 'shop_stock_list_v01',
    'code': 'shop_stock_list_v01',
    'is_auto_sync': False
}

Response

Returns the created stock list data. Successful response status is expected to be HTTP-201 Created.

Resource properties are in Python format.

Property	Data Type	Description
pk	int	Primary key of the created list
name	string	Name of the created list
code	string	The list ID in ERP
is_auto_sync	boolean	Specifies whether the list will have synchronization with ERP. If the parameter is True, the list will be automatically updated by ERP.
modified_date	date	Last modified date of the stock list
created_date	date	Shows the date when the stock list was created

{
  "pk": 565,
  "name": "shop_stock_list_v01",
  "code": "shop_stock_list_v01",
  "is_auto_sync": false,
  "modified_date": "2021-07-12T15:06:48.122196Z",
  "created_date": "2021-07-12T15:06:48.122171Z"
}

If the name field is already defined in Omnitron, there will be a bad request response.

{
  "name": [
       "stock list with this name already exists."
   ]
}

The same bad request response is applicable if the code field is already defined in Omnitron.

{
   "code": [
       "stock list with this code already exists."
   ]
}