Stock Location Address Services
All services related to StockLocationAddress are listed in this page.
OPTIONS List StockLocationAddress - Simple
OPTIONS List StockLocationAddress - SimpleThis service is used to retrieve a simple list of data types for Stock Location Address.
Path: /api/v1/oms/stock_location_addresses/list-simple/
Query Parameters
The following query parameters can be used to get simple information about StockLocationAddress.
token
string
header
The API key of the customer account
Example Request
To get a simple list of StockLocationAddress, a OPTIONS request should be sent to /api/v1/oms/stock_location_addresses/list-simple/ endpoint. No query parameters or request body are required.
Here's an example of how to make the request in python:
import requests
url = "https://{oms_base_url}/api/v1/oms/stock_location_addresses/list-simple/"
api_token = "f532eXXXXXXXXXXXXXXXXX201XXXXX9332d"
headers = {
'Accept': 'application/json',
'Authorization': 'Token {}'.format(api_token)
}
response = requests.request("OPTIONS", url, headers=headers)
print(response.json())Example Response (200 OK)
In a successful response with a status code of 200 OK, the API returns a simple list of StockLocationAddress information.
This example response serves as a reference to understand the structure and data format of StockLocationAddress.
GET List StockLocationAddress
GET List StockLocationAddressThis service used to get a list of the StockLocationAddress.
Path: /api/v1/oms/stock_location_addresses/
Query Parameters
The following query parameters can be used to get the information about StockLocationAddress.
token
string
header
The API key of the customer account
Example Request
To get a list of StockLocationAddress, a GET request should be sent to /api/v1/oms/stock_location_addresses/ endpoint. No query parameter or request body are required.
Here's an example of how to make the request in python:
Example Response (200 OK)
In a successful response with a status code of 200 OK, the API returns stock_location_addresses information.
pk
integer
The ID of the s_location address
name
string
The name of the s_location address
country
integer
The country ID of the s_location address
township
integer
The status of the s_location address
district
integer
The district value of the s_location address
mapping
json
The mapping value of the s_location address
title
string
The title value of the s_location address
is_active
boolean
The status of the s_location address
line
string
The line value of the s_location address
postcode
string
The postcode value of the s_location address
notes
string
The notes value of the s_location address
longitude
decimal
The longitude value of the s_location address
latitude
decimal
The latitude value of the s_location address
This example response serves as a reference to understand the structure and data format of stock_location_addresses.
Was this helpful?