Stock Location Sender Address Services

Stock location sender addresses are utilized to designate identification for stock locations recognized by cargo companies. These companies could be Akinon-developed extensions or third-party entities that receive stock location data via webhooks.

Akinon extensions' sender addresses can be created via setup services and are subsequently automatically updated according to any changes to stock locations. Additionally, they can be created or modified through the services outlined in this document.

Sender addresses for third-party extensions can also be managed via the services detailed herein.

GET StockLocation Sender Addresses List

Returns API level details of StockLocation Sender Addresses List service.

Path: /api/v1/oms/stocklocations-senderaddress/

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 a list of saved sender addresses, a GET request should be sent to the /api/v1/oms/stocklocations-senderaddress/ 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:

import requests

url = "https://{domain_url}/api/v1/oms/stocklocations-senderaddress/"
token = "f532eXXXXXXXXXXXXXXXXX201XXXXX9332d"

headers = {
    'Content-Type': 'application/json',
    'Authorization': f'Token {token}'
}

response = requests.request("GET", url, headers=headers)

print(response.json())

Example Response (200 OK)

This example response serves as a reference to understand the structure and data format returned from this API service.

{
    "count": 25,
    "next": "{domain_url}/api/v1/oms/stocklocations-senderaddress/?limit=5&page=2",
    "previous": null,
    "results": [
        {
            "id": 265,
            "created_date": "2023-12-23T19:40:22.999050Z",
            "modified_date": "2023-12-23T19:40:22.999082Z",
            "origin_id": "9876549",
            "remote_id": null,
            "address_hash": null,
            "is_active": true,
            "stock_location": 199,
            "cargo_company": 1123
        },
        {
            "id": 233,
            "created_date": "2023-12-22T12:33:39.544390Z",
            "modified_date": "2023-12-23T19:40:14.288378Z",
            "origin_id": "9876549",
            "remote_id": null,
            "address_hash": null,
            "is_active": true,
            "stock_location": 100,
            "cargo_company": 826
        },
        {
            "id": 232,
            "created_date": "2023-12-22T12:24:17.305350Z",
            "modified_date": "2023-12-22T12:29:24.067583Z",
            "origin_id": "1234569",
            "remote_id": null,
            "address_hash": null,
            "is_active": true,
            "stock_location": 166,
            "cargo_company": 793
        },
        {
            "id": 199,
            "created_date": "2023-12-21T06:41:00.273722Z",
            "modified_date": "2023-12-22T12:23:53.653780Z",
            "origin_id": "9876540",
            "remote_id": null,
            "address_hash": null,
            "is_active": true,
            "stock_location": 166,
            "cargo_company": 991
        },
        {
            "id": 167,
            "created_date": "2023-12-20T12:07:53.853943Z",
            "modified_date": "2023-12-21T08:20:44.192105Z",
            "origin_id": "1234533",
            "remote_id": null,
            "address_hash": null,
            "is_active": true,
            "stock_location": 133,
            "cargo_company": 991
        }
    ]
}

GET StockLocation Sender Address Detail

Returns API level details of StockLocation Sender Address Detail service.

Path: /api/v1/oms/stocklocations-senderaddress/<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 details of a sender address record, a GET request should be sent to the /api/v1/oms/stocklocations-senderaddress/<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:

import requests

url = "https://{domain_url}/api/v1/oms/stocklocations-senderaddress/<id>"
token = "f532eXXXXXXXXXXXXXXXXX201XXXXX9332d"

headers = {
    'Content-Type': 'application/json',
    'Authorization': f'Token {token}'
}

response = requests.request("GET", url, headers=headers)

print(response.json())

Example Response (200 OK)

This example response serves as a reference to understand the structure and data format returned from this API service.

{
    "id": 265,
    "created_date": "2023-12-23T19:40:22.999050Z",
    "modified_date": "2023-12-23T19:40:22.999082Z",
    "origin_id": "9876549",
    "remote_id": null,
    "address_hash": null,
    "is_active": true,
    "stock_location": 199,
    "cargo_company": 1123
}

POST StockLocation Sender Address Create

Returns API level details of StockLocation Sender Address Create service.

Path: /api/v1/oms/stocklocations-senderaddress/

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 create a new sender address record, a POST request should be sent to the /api/v1/oms/stocklocations-senderaddress/ 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:

import requests

url = "https://{domain_url}/api/v1/oms/stocklocations-senderaddress/"
token = "f532eXXXXXXXXXXXXXXXXX201XXXXX9332d"

payload = {
    "origin_id": "98765498",
    "is_active": true,
    "stock_location": 199,
    "cargo_company": 1255
}
headers = {
    'Content-Type': 'application/json',
    'Authorization': f'Token {token}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.json())

Example Response (201 Created)

This example response serves as a reference to understand the structure and data format returned from this API service.

{
    "id": 298,
    "created_date": "2024-01-28T22:14:59.368424Z",
    "modified_date": "2024-01-28T22:14:59.368451Z",
    "origin_id": "98765498",
    "remote_id": null,
    "address_hash": null,
    "is_active": true,
    "stock_location": 199,
    "cargo_company": 1255
}

POST StockLocation Sender Address Bulk Create

Returns API level details of StockLocation Sender Address Bulk Create service.

Path: /api/v1/oms/stocklocations-senderaddress/bulk_create/

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 create multiple sender address records at a time, a POST request should be sent to the /api/v1/oms/stocklocations-senderaddress/ 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:

import requests

url = "https://{domain_url}/api/v1/oms/stocklocations-senderaddress/bulk_create/"
token = "f532eXXXXXXXXXXXXXXXXX201XXXXX9332d"

payload = [
    {
        "origin_id": "6565",
        "is_active": true,
        "stock_location": 133,
        "cargo_company": 1255
    },
    {
        "origin_id": "4445",
        "is_active": true,
        "stock_location": 100,
        "cargo_company": 1255
    },
    {
        "origin_id": "321232",
        "is_active": true,
        "stock_location": 166,
        "cargo_company": 1255
    }
]
headers = {
    'Content-Type': 'application/json',
    'Authorization': f'Token {token}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.json())

Example Response (201 Created)

There is no response body for this service.

PUT StockLocation Sender Address Update

Returns API level details of StockLocation Sender Address Update service.

Path: /api/v1/oms/stocklocations-senderaddress/<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 update a sender address record in its entirety, a PUT request should be sent to the /api/v1/oms/stocklocations-senderaddress/<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:

import requests

url = "https://{domain_url}/api/v1/oms/stocklocations-senderaddress/<id>"
token = "f532eXXXXXXXXXXXXXXXXX201XXXXX9332d"

payload = {
    "origin_id": "323232",
    "is_active": true,
    "stock_location": 199,
    "cargo_company": 1255
}
headers = {
    'Content-Type': 'application/json',
    'Authorization': f'Token {token}'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.json())

Example Response (200 OK)

This example response serves as a reference to understand the structure and data format returned from this API service.

{
    "id": 298,
    "created_date": "2024-01-28T22:14:59.368424Z",
    "modified_date": "2024-01-28T22:16:31.513940Z",
    "origin_id": "323232",
    "remote_id": null,
    "address_hash": null,
    "is_active": true,
    "stock_location": 199,
    "cargo_company": 1255
}

PATCH StockLocation Sender Addresses Patch

Returns API level details of StockLocation Sender Address Patch service.

Path: /api/v1/oms/stocklocations-senderaddress/<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 update a sender address record partially, a PATCH request should be sent to the /api/v1/oms/stocklocations-senderaddress/<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:

import requests

url = "https://{domain_url}/api/v1/oms/stocklocations-senderaddress/<id>"
token = "f532eXXXXXXXXXXXXXXXXX201XXXXX9332d"

payload = {
    "origin_id": "1212",
  ...
}
headers = {
    'Content-Type': 'application/json',
    'Authorization': f'Token {token}'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.json())

Example Response (200 OK)

This example response serves as a reference to understand the structure and data format returned from this API service.

{
    "id": 298,
    "created_date": "2024-01-28T22:14:59.368424Z",
    "modified_date": "2024-01-28T22:17:26.470714Z",
    "origin_id": "1212",
    "remote_id": null,
    "address_hash": null,
    "is_active": true,
    "stock_location": 199,
    "cargo_company": 1255
}

DELETE StockLocation Sender Addresses Delete

Returns API level details of StockLocation Sender Address Delete service.

Path: /api/v1/oms/stocklocations-senderaddress/<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 delete a sender address record, a DELETE request should be sent to the /api/v1/oms/stocklocations-senderaddress/<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:

import requests

url = "https://{domain_url}/api/v1/oms/stocklocations-senderaddress/<id>"
token = "f532eXXXXXXXXXXXXXXXXX201XXXXX9332d"


headers = {
    'Content-Type': 'application/json',
    'Authorization': f'Token {token}'
}

response = requests.request("DELETE", url, headers=headers,)

print(response.json())

Example Response (204 No Content)

There is no response body for this service.