All services related to stock_locations are listed in this document.
GET StockLocation List - Simple
Returns all stock_location with detailed information. It is added for business intelligence purposes.
Path:/api/v1/oms/stocklocations/list-simple/
Query Parameters
The following query parameters can be used to get the details of stock_locations.
Parameter
Data Type
In
Description
token
string
header
The API key of the customer account
Example Request
To get a detailed list of all stock_locations, a GET request should be sent to
the /api/v1/oms/stocklocations/list-simple/ endpoint. In the headers,
set the Authorization header to include the token for authentication.
Here's an example of how to make the request in python:
In a successful response with a status code of 200 OK, the API returns the
details of the stock_locations. The response body contains a JSON object with
the stock_locations and their attributes such as ID, name etc.
These parameters are described in the following table.
Parameter
Data Type
Description
id
integer
The primary key of the stock_location
created_date
date
The creation date of the stock_location
modified_date
date
The last modified date of the stock_location
omnitron_id
integer
The Omnitron ID of the stock_location
name
string
The name of the stock_location
stock_location_type
string
The stock_location_type of the stock_location
fax_number
string
The fax number of the stock_location
erp_code
string
The partner stock_location code
address
integer
The address id of the stock_location
is_fulfillment_center
boolean
The is_fulfillment_center of the stock_location
is_pickup_location
boolean
The is_pickup_location of the stock_location
is_delivery_location
boolean
The is_delivery_location of the stock_location
is_fast_delivery_available
boolean
The is_fast_delivery_available of the stock_location
is_return_available
boolean
The is_return_available of the stock_location
is_active
boolean
The status of the stock_location
priority
integer
The priority of the stock_location
conf
dict
The configuration info of the stock_location
daytime_phone
string
The daytime_phone of the stock_location
evening_phone
string
The evening_phone of the stock_location
email
string
The email of the stock_location
target_packing_interval
string
The packing interval of the stock_location
target_transfer_interval
string
The transfer interval of the stock_location
use_as_shipper_location
boolean
The shipper location info of the stock_location
quota
integer
The quota amount of the stock_location
max_quota
integer
The max_quota amount of the stock_location
engine
integer
The stock engine of the stock_location
tags
list
The tags of the stock_location
Max Quota & Quota Feature
Regardless of scenarios, the process of lowering and raising quotas continues, the quota amount continues to increase and decrease on a location basis. However, for these alterations to impact planning, the scenario rules must have the SELECT_BY_QUOTA value.
The maximum quota value specifies how many packages can be created from the respective location. The quota value is a user-unspecified parameter used for monitoring the maximum quota value and performing increase or decrease operations.
max_quota - quota = available_quota
If the available_quota value is 0, no packages can be created. (To encounter this scenario, the SELECT_BY_QUOTA value must be chosen in the scenario rules.)
For packages with a status below 400 and in the cancellation_waiting state, the quota value increases by 1. (During this stage, when the package is in the waiting state, the quota amount is considered to increase by 1.)
Upon packaging a package, the quota value decreases by 1. Consequently, the available_quota increases, enhancing the likelihood of packaging from the respective location.
In the event of a package cancellation, the quota amount decreases by 1 in a similar way.
How to Set Max_quota Condition
Navigate to Akinon OMS > Locations > x location: Enter the desired max_quota value in the max_quota field.
Navigate to Akinon OMS > Scenarios > Distribution Scenario > Rules > StockLocation Conditions: Ensure SELECT_BY_QUOTA is selected.
Once these steps are executed, the packaging process will factor in the max_quota amount.
After establishing this condition, it is crucial to note that the packaging process will occur based on the max_quota value.
In case of misuse, the packaging process may not occur. (For instance, if max_quota values are not entered for locations, and there is only one rule in the scenario with a quota condition, the packaging process will not occur.)
This example response serves as a reference to understand the structure and data format returned from this API service.
Returns API level details of StockLocation List Simple service.
Path:/api/v1/oms/stocklocations/list-simple/
Query Parameters
The following query parameters can be used to get the details of the service.
Parameter
Data Type
In
Description
token
string
header
The API key of the customer account
Example Request
To get API level details of the service, a OPTIONS request should be sent to
the /api/v1/oms/stocklocations/list-simple/ endpoint. In the headers,
set the Authorization header to include the token for authentication.
Here's an example of how to make the request in python:
In a successful response with a status code of 200 OK, it returns the
API level details of the service. The response body contains a JSON object
with the name, rendering types, filtering attributes etc.
These parameters are described in the following table.
Parameter
Data Type
Description
name
string
The name of the service
renders
list
The rendering types of the service
parses
list
The parsing types of the service
actions
json
The defined actions of the service
filters
list
The filtering attributes of the service
This example response serves as a reference to understand the structure and data format returned from this API service.
Returns API level details of StockLocation List service.
Path:/api/v1/oms/stocklocations/
Query Parameters
The following query parameters can be used to get the details of the service.
Parameter
Data Type
In
Description
token
string
header
The API key of the customer account
Example Request
To get API level details of the service, a GET request should be sent to
the /api/v1/oms/stocklocations/ endpoint. In the headers,
set the Authorization header to include the token for authentication.
Here's an example of how to make the request in python:
Returns API level details of StockLocation Detail service.
Path:/api/v1/oms/stocklocations/<id>
Query Parameters
The following query parameters can be used to get the details of the service.
Parameter
Data Type
In
Description
token
string
header
The API key of the customer account
Example Request
To get API level details of the service, a GET request should be sent to
the /api/v1/oms/stocklocations/<id> endpoint. In the headers,
set the Authorization header to include the token for authentication.
Here's an example of how to make the request in python:
Returns API level details of StockLocation Create service.
Path:/api/v1/oms/stocklocations/
Query Parameters
The following query parameters can be used to get the details of the service.
Parameter
Data Type
In
Description
token
string
header
The API key of the customer account
Example Request
To get API level details of the service, a POST request should be sent to
the /api/v1/oms/stocklocations/<id> endpoint. In the headers,
set the Authorization header to include the token for authentication.
Here's an example of how to make the request in python:
Returns API level details of StockLocation Update service.
Path:/api/v1/oms/stocklocations/<id>
Query Parameters
The following query parameters can be used to get the details of the service.
Parameter
Data Type
In
Description
token
string
header
The API key of the customer account
Example Request
To get API level details of the service, a PUT request should be sent to
the /api/v1/oms/stocklocations/<id> endpoint. In the headers,
set the Authorization header to include the token for authentication.
Here's an example of how to make the request in python:
Returns API level details of StockLocation Patch service.
Path:/api/v1/oms/stocklocations/<id>
Query Parameters
The following query parameters can be used to get the details of the service.
Parameter
Data Type
In
Description
token
string
header
The API key of the customer account
Example Request
To get API level details of the service, a PATCH request should be sent to
the /api/v1/oms/stocklocations/<id> endpoint. In the headers,
set the Authorization header to include the token for authentication.
Here's an example of how to make the request in python:
