Default
Returns a paginated list of transfer orders.
Authorizations
Query parameters
formatstring · enumOptionalDefault:
Response format
jsonPossible values: pageintegerOptionalDefault:
Page number
1limitintegerOptionalDefault:
Number of items per page
20sortstring · enumOptionalPossible values:
Sorting field
stateintegerOptional
Filter by state ID
state__enum_valuestringOptional
Filter by state enum value
orderintegerOptional
Filter by order ID
order__numberstringOptional
Filter by order number
packageintegerOptional
Filter by package ID
package_numberstringOptional
Filter by package number
product_skustringOptional
Filter by product SKU
product__barcodestringOptional
Filter by product barcode
source__erp_codestringOptional
Filter by erp code of the source stock location
destination__erp_codestringOptional
Filter by erp code of the destination stock location
retail_store__erp_codestringOptional
Filter all transfers to sent and to receive of the given location
erp_codestringOptional
Filter all transfers to sent and to receive of the given location
customer__first_namestringOptional
Filter by customer's first name
customer__last_namestringOptional
Filter by customer's last name
order__datestring · dateOptional
Filter by order date
id__gtintegerOptional
Filter by ID greater than given value
id__gteintegerOptional
Filter by ID greater than or equal to given value
id__ltintegerOptional
Filter by ID less than given value
id__lteintegerOptional
Filter by ID less than or equal to given value
pk__ininteger[]Optional
Filter by multiple IDs of the transfer order
channelintegerOptional
Filter by channel ID
shipment__cargo_companyintegerOptional
Filter by shipment cargo company ID (If transfer order has shipment)
countryintegerOptional
Filter by country ID
country__namestringOptional
Filter by country name
cityintegerOptional
Filter by city ID
city__namestringOptional
Filter by city name
townshipintegerOptional
Filter by township ID
township__namestringOptional
Filter by township name
awb_numberstringOptional
Filter by shipment awb number (If transfer order has shipment)
Responses
200
Successful operation
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
get
GET /api/v1/oms/transfer_orders/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: Bearer JWT
Accept: */*
{
"count": 1,
"next": "text",
"previous": "text",
"results": [
{
"id": 1,
"source": {
"id": 1,
"stock_location_type": "text",
"address": {
"id": 1,
"city": {},
"country": {},
"township": {},
"district": {},
"mapping": {},
"title": "text",
"is_active": true,
"line": "text",
"postcode": "text",
"notes": "text",
"latitude": "text",
"longitude": "text"
},
"erp_code": "text",
"engine": 1,
"tags": [
{}
],
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"omnitron_id": 1,
"name": "text",
"is_fulfillment_center": true,
"is_pickup_location": true,
"is_delivery_location": true,
"is_return_available": true,
"is_fast_delivery_available": true,
"is_active": true,
"priority": 1,
"conf": {},
"daytime_phone": "text",
"evening_phone": "text",
"fax_number": "text",
"email": "text",
"use_as_shipper_location": true,
"quota": 1,
"max_quota": 1
},
"destination": {
"id": 1,
"stock_location_type": "text",
"address": {
"id": 1,
"city": {},
"country": {},
"township": {},
"district": {},
"mapping": {},
"title": "text",
"is_active": true,
"line": "text",
"postcode": "text",
"notes": "text",
"latitude": "text",
"longitude": "text"
},
"erp_code": "text",
"engine": 1,
"tags": [
{}
],
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"omnitron_id": 1,
"name": "text",
"is_fulfillment_center": true,
"is_pickup_location": true,
"is_delivery_location": true,
"is_return_available": true,
"is_fast_delivery_available": true,
"is_active": true,
"priority": 1,
"conf": {},
"daytime_phone": "text",
"evening_phone": "text",
"fax_number": "text",
"email": "text",
"use_as_shipper_location": true,
"quota": 1,
"max_quota": 1
},
"transferitem_set": [
{
"id": 1,
"state": {
"id": 1,
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"name": "text",
"config": {},
"enum_class": "text",
"enum_value": "text",
"content_type": 1
},
"unit_type": "quantity",
"package_item": {
"id": 1,
"state": {
"id": 1,
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"name": "text",
"config": {},
"enum_class": "text",
"enum_value": "text",
"content_type": 1
},
"order_item": {},
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"selected_barcode": "text",
"serial_no": "text",
"unit_weight": "text",
"package": 1,
"denial_reason": {
"id": 1,
"title": "text",
"remote_id": "text",
"priority": 1,
"is_active": true
}
},
"product": {},
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"name": "text",
"quantity": "text",
"stock_code": "text",
"barcode": "text",
"transfer_order": 1
}
],
"number": "text",
"order": 1,
"order_number": "text",
"package": 1,
"package_number": "text",
"target_transfer_date": "2025-07-14T16:31:01.701Z",
"order_date_placed": "2025-07-14T16:31:01.701Z",
"state": {
"id": 1,
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"name": "text",
"config": {},
"enum_class": "text",
"enum_value": "text",
"content_type": 1
},
"commands": [
{}
],
"invoice_number": "text",
"remote_id": "text",
"transfer_shipment": {},
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"omnitron_order_id": 1,
"extra_information": {}
}
]
}Returns detailed information of a transfer order by its ID.
Authorizations
Path parameters
idintegerRequired
Query parameters
formatstring · enumOptionalDefault:
Response format
jsonPossible values: Responses
200
Successful operation
403
Forbidden
application/json
404
Not Found
application/json
get
GET /api/v1/oms/transfer_orders/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: Bearer JWT
Accept: */*
{
"id": 1,
"source": {
"id": 1,
"stock_location_type": "text",
"address": {
"id": 1,
"city": {},
"country": {},
"township": {},
"district": {},
"mapping": {},
"title": "text",
"is_active": true,
"line": "text",
"postcode": "text",
"notes": "text",
"latitude": "text",
"longitude": "text"
},
"erp_code": "text",
"engine": 1,
"tags": [
{}
],
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"omnitron_id": 1,
"name": "text",
"is_fulfillment_center": true,
"is_pickup_location": true,
"is_delivery_location": true,
"is_return_available": true,
"is_fast_delivery_available": true,
"is_active": true,
"priority": 1,
"conf": {},
"daytime_phone": "text",
"evening_phone": "text",
"fax_number": "text",
"email": "text",
"use_as_shipper_location": true,
"quota": 1,
"max_quota": 1
},
"destination": {
"id": 1,
"stock_location_type": "text",
"address": {
"id": 1,
"city": {},
"country": {},
"township": {},
"district": {},
"mapping": {},
"title": "text",
"is_active": true,
"line": "text",
"postcode": "text",
"notes": "text",
"latitude": "text",
"longitude": "text"
},
"erp_code": "text",
"engine": 1,
"tags": [
{}
],
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"omnitron_id": 1,
"name": "text",
"is_fulfillment_center": true,
"is_pickup_location": true,
"is_delivery_location": true,
"is_return_available": true,
"is_fast_delivery_available": true,
"is_active": true,
"priority": 1,
"conf": {},
"daytime_phone": "text",
"evening_phone": "text",
"fax_number": "text",
"email": "text",
"use_as_shipper_location": true,
"quota": 1,
"max_quota": 1
},
"transferitem_set": [
{
"id": 1,
"state": {
"id": 1,
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"name": "text",
"config": {},
"enum_class": "text",
"enum_value": "text",
"content_type": 1
},
"unit_type": "quantity",
"package_item": {
"id": 1,
"state": {
"id": 1,
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"name": "text",
"config": {},
"enum_class": "text",
"enum_value": "text",
"content_type": 1
},
"order_item": {},
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"selected_barcode": "text",
"serial_no": "text",
"unit_weight": "text",
"package": 1,
"denial_reason": {
"id": 1,
"title": "text",
"remote_id": "text",
"priority": 1,
"is_active": true
}
},
"product": {},
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"name": "text",
"quantity": "text",
"stock_code": "text",
"barcode": "text",
"transfer_order": 1
}
],
"number": "text",
"order": 1,
"order_number": "text",
"package": 1,
"package_number": "text",
"channel_name": "text",
"customer": {
"email": "text",
"first_name": "text",
"last_name": "text",
"phone_number": "text",
"erp_code": "text",
"pk": 1,
"channel": 1
},
"shipping_address": {
"id": 1,
"city": {},
"country": {},
"township": {},
"district": {},
"mapping": {},
"title": "text",
"is_active": true,
"line": "text",
"postcode": "text",
"notes": "text",
"latitude": "text",
"longitude": "text"
},
"target_transfer_date": "2025-07-14T16:31:01.701Z",
"state": {
"id": 1,
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"name": "text",
"config": {},
"enum_class": "text",
"enum_value": "text",
"content_type": 1
},
"commands": [
{}
],
"invoice_number": "text",
"remote_id": "text",
"transfer_shipment": {},
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"id_encrypted": "text",
"extra_information": {}
}Returns a paginated list of transfer orders with less detailed information.
Authorizations
Query parameters
formatstring · enumOptionalDefault:
Response format
jsonPossible values: pageintegerOptionalDefault:
Page number
1limitintegerOptionalDefault:
Number of items per page
20sortstring · enumOptionalPossible values:
Sorting field
stateintegerOptional
Filter by state ID
state__enum_valuestringOptional
Filter by state enum value
orderintegerOptional
Filter by order ID
order__numberstringOptional
Filter by order number
packageintegerOptional
Filter by package ID
package_numberstringOptional
Filter by package number
product_skustringOptional
Filter by product SKU
product__barcodestringOptional
Filter by product barcode
source__erp_codestringOptional
Filter by erp code of the source stock location
destination__erp_codestringOptional
Filter by erp code of the destination stock location
retail_store__erp_codestringOptional
Filter all transfers to sent and to receive of the given location
erp_codestringOptional
Filter all transfers to sent and to receive of the given location
customer__first_namestringOptional
Filter by customer's first name
customer__last_namestringOptional
Filter by customer's last name
order__datestring · dateOptional
Filter by order date
id__gtintegerOptional
Filter by ID greater than given value
id__gteintegerOptional
Filter by ID greater than or equal to given value
id__ltintegerOptional
Filter by ID less than given value
id__lteintegerOptional
Filter by ID less than or equal to given value
pk__ininteger[]Optional
Filter by multiple IDs of the transfer order
channelintegerOptional
Filter by channel ID
shipment__cargo_companyintegerOptional
Filter by shipment cargo company ID (If transfer order has shipment)
countryintegerOptional
Filter by country ID
country__namestringOptional
Filter by country name
cityintegerOptional
Filter by city ID
city__namestringOptional
Filter by city name
townshipintegerOptional
Filter by township ID
township__namestringOptional
Filter by township name
awb_numberstringOptional
Filter by shipment awb number (If transfer order has shipment)
Responses
200
Successful operation
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
get
GET /api/v1/oms/transfer_orders/short/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: Bearer JWT
Accept: */*
{
"count": 1,
"next": "text",
"previous": "text",
"results": [
{
"id": 1,
"source": {
"id": 1,
"name": "text",
"erp_code": "text",
"address": {
"line": "text",
"city": {},
"title": "text"
},
"available_quota": 1
},
"destination": {
"id": 1,
"name": "text",
"erp_code": "text",
"address": {
"line": "text",
"city": {},
"title": "text"
},
"available_quota": 1
},
"transfer_item_count": 1,
"number": "text",
"order": 1,
"order_number": "text",
"package": 1,
"package_number": "text",
"target_transfer_date": "2025-07-14T16:31:01.701Z",
"order_date_placed": "2025-07-14T16:31:01.701Z",
"state": {
"id": 1,
"name": "text",
"enum_class": "text",
"enum_value": "text"
},
"remote_id": "text",
"created_date": "2025-07-14T16:31:01.701Z",
"commands": [
{}
],
"extra_information": {}
}
]
}Returns a less detailed information of a transfer order by its ID.
Authorizations
Path parameters
idintegerRequired
Query parameters
formatstring · enumOptionalDefault:
Response format
jsonPossible values: Responses
200
Successful operation
403
Forbidden
application/json
404
Not Found
application/json
get
GET /api/v1/oms/transfer_orders/{id}/short/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: Bearer JWT
Accept: */*
{
"id": 1,
"source": {
"id": 1,
"name": "text",
"erp_code": "text",
"address": {
"line": "text",
"city": {},
"title": "text"
},
"available_quota": 1
},
"destination": {
"id": 1,
"name": "text",
"erp_code": "text",
"address": {
"line": "text",
"city": {},
"title": "text"
},
"available_quota": 1
},
"number": "text",
"order": 1,
"order_number": "text",
"package": 1,
"package_number": "text",
"channel_name": "text",
"customer": {
"email": "text",
"first_name": "text",
"last_name": "text",
"phone_number": "text",
"erp_code": "text",
"pk": 1,
"channel": 1
},
"shipping_address": {
"line": "text",
"city": {},
"title": "text"
},
"target_transfer_date": "2025-07-14T16:31:01.701Z",
"state": {
"id": 1,
"name": "text",
"enum_class": "text",
"enum_value": "text"
},
"commands": [
{}
],
"transfer_shipment": {},
"created_date": "2025-07-14T16:31:01.701Z",
"id_encrypted": "text",
"extra_information": {}
}Executes a specified command (e.g., in_transit, ready_to_shipment) for a transfer order with the given ID.
Authorizations
Path parameters
idintegerRequired
Body
transitionintegerRequired
ID of the state transition to execute
input_parametersobjectOptionalDefault:
Additional parameters for the command
{}Responses
200
Command executed successfully
204
Command executed successfully (no content)
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
406
Not Acceptable
application/json
post
POST /api/v1/oms/transfer_orders/{id}/command/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"transition": 1,
"input_parameters": {}
}No content
Partially updates the extra_information field for the specified transfer order.
Authorizations
Path parameters
idintegerRequired
Body
extra_informationobjectRequired
Additional information of the transfer order
Responses
200
Extra information updated successfully
400
Bad Request
application/json
403
Forbidden
application/json
404
Not Found
application/json
patch
PATCH /api/v1/oms/transfer_orders/{id}/extra_information/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"extra_information": {}
}No content
Assigns or updates the invoice number for the transfer order with the given ID.
Authorizations
Path parameters
idintegerRequired
Body
invoice_numberstring · max: 32Required
Responses
204
Invoice number set successfully
400
Bad Request
application/json
403
Forbidden
application/json
404
Not Found
application/json
post
POST /api/v1/oms/transfer_orders/{id}/set_invoice_number/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"invoice_number": "text"
}No content
Assigns or updates the remote ID of the transfer order with the specified ID.
Authorizations
Path parameters
idintegerRequired
Body
remote_idstring · max: 128Required
Responses
204
Remote ID set successfully
400
Bad Request
application/json
403
Forbidden
application/json
404
Not Found
application/json
post
POST /api/v1/oms/transfer_orders/{id}/set_remote_id/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 20
{
"remote_id": "text"
}No content
Returns a paginated list of all state transition logs for the specified transfer order.
Authorizations
Path parameters
idintegerRequired
Query parameters
formatstring · enumOptionalDefault:
Response format
jsonPossible values: Responses
200
Successful operation
application/json
403
Forbidden
application/json
404
Not Found
application/json
get
GET /api/v1/oms/transfer_orders/{id}/transition_logs/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: Bearer JWT
Accept: */*
{
"count": 1,
"next": "text",
"previous": "text",
"results": [
{
"id": 1,
"old_state": {
"id": 1,
"name": "text",
"enum_class": "text",
"enum_value": "text"
},
"new_state": {
"id": 1,
"name": "text",
"enum_class": "text",
"enum_value": "text"
},
"user": {
"pk": 1,
"first_name": "text",
"last_name": "text",
"email": "text",
"username": "text"
},
"attributes": {},
"created_date": "2025-07-14T16:31:01.701Z",
"object_id": 1,
"content_type": 1
}
]
}Returns detailed information about a single transition log for the specified transfer order.
Authorizations
Path parameters
idintegerRequired
log_idintegerRequired
Query parameters
formatstring · enumOptionalDefault:
Response format
jsonPossible values: Responses
200
Successful operation
403
Forbidden
application/json
404
Not Found
application/json
get
GET /api/v1/oms/transfer_orders/{id}/transition_logs/{log_id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: Bearer JWT
Accept: */*
{
"id": 1,
"old_state": {
"id": 1,
"name": "text",
"enum_class": "text",
"enum_value": "text"
},
"new_state": {
"id": 1,
"name": "text",
"enum_class": "text",
"enum_value": "text"
},
"user": {
"pk": 1,
"first_name": "text",
"last_name": "text",
"email": "text",
"username": "text"
},
"attributes": {},
"created_date": "2025-07-14T16:31:01.701Z",
"object_id": 1,
"content_type": 1
}Returns a paginated list of transition logs with less detailed information.
Authorizations
Path parameters
idintegerRequired
Query parameters
formatstring · enumOptionalDefault:
Response format
jsonPossible values: Responses
200
Successful operation
application/json
403
Forbidden
application/json
404
Not Found
application/json
get
GET /api/v1/oms/transfer_orders/{id}/transition_logs/short/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: Bearer JWT
Accept: */*
{
"count": 1,
"next": "text",
"previous": "text",
"results": [
{
"id": 1,
"old_state": {
"id": 1,
"name": "text",
"enum_class": "text",
"enum_value": "text"
},
"new_state": {
"id": 1,
"name": "text",
"enum_class": "text",
"enum_value": "text"
},
"user": {
"pk": 1,
"first_name": "text",
"last_name": "text",
"email": "text",
"username": "text"
},
"attributes": {},
"created_date": "2025-07-14T16:31:01.701Z"
}
]
}Returns less detailed information about a single transition log for the specified transfer order.
Authorizations
Path parameters
idintegerRequired
log_idintegerRequired
Query parameters
formatstring · enumOptionalDefault:
Response format
jsonPossible values: Responses
200
Successful operation
403
Forbidden
application/json
404
Not Found
application/json
get
GET /api/v1/oms/transfer_orders/{id}/transition_logs/short/{log_id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: Bearer JWT
Accept: */*
{
"id": 1,
"old_state": {
"id": 1,
"name": "text",
"enum_class": "text",
"enum_value": "text"
},
"new_state": {
"id": 1,
"name": "text",
"enum_class": "text",
"enum_value": "text"
},
"user": {
"pk": 1,
"first_name": "text",
"last_name": "text",
"email": "text",
"username": "text"
},
"attributes": {},
"created_date": "2025-07-14T16:31:01.701Z"
}Returns a paginated list of all webhook events for the specified transfer order.
Authorizations
Path parameters
idintegerRequired
Query parameters
formatstring · enumOptionalDefault:
Response format
jsonPossible values: Responses
200
Successful operation
403
Forbidden
application/json
404
Not Found
application/json
get
GET /api/v1/oms/transfer_orders/{id}/webhook_events/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: Bearer JWT
Accept: */*
{
"count": 1,
"next": "text",
"previous": "text",
"results": [
{
"id": 1,
"webhook": {
"id": 133,
"retry_countdown_config": {
"choice": "fixed",
"kwargs": {
"seconds": 60
}
},
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"target_url": "https://example.com",
"is_active": true,
"secret_key": "text",
"event_type": "transfer.status.created",
"callback": "text",
"additional_headers": {},
"config": {}
},
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"uuid": "text",
"request_payload": {
"event": {
"type": "text",
"uuid": "text"
},
"payload": {
"id": 1,
"source": {
"id": 1,
"stock_location_type": "text",
"address": {
"id": 1,
"city": {},
"country": {},
"township": {},
"district": {},
"mapping": {},
"title": "text",
"is_active": true,
"line": "text",
"postcode": "text",
"notes": "text",
"latitude": "text",
"longitude": "text"
},
"erp_code": "text",
"engine": 1,
"tags": [
{}
],
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"omnitron_id": 1,
"name": "text",
"is_fulfillment_center": true,
"is_pickup_location": true,
"is_delivery_location": true,
"is_return_available": true,
"is_fast_delivery_available": true,
"is_active": true,
"priority": 1,
"conf": {},
"daytime_phone": "text",
"evening_phone": "text",
"fax_number": "text",
"email": "text",
"use_as_shipper_location": true,
"quota": 1,
"max_quota": 1
},
"destination": {
"id": 1,
"stock_location_type": "text",
"address": {
"id": 1,
"city": {},
"country": {},
"township": {},
"district": {},
"mapping": {},
"title": "text",
"is_active": true,
"line": "text",
"postcode": "text",
"notes": "text",
"latitude": "text",
"longitude": "text"
},
"erp_code": "text",
"engine": 1,
"tags": [
{}
],
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"omnitron_id": 1,
"name": "text",
"is_fulfillment_center": true,
"is_pickup_location": true,
"is_delivery_location": true,
"is_return_available": true,
"is_fast_delivery_available": true,
"is_active": true,
"priority": 1,
"conf": {},
"daytime_phone": "text",
"evening_phone": "text",
"fax_number": "text",
"email": "text",
"use_as_shipper_location": true,
"quota": 1,
"max_quota": 1
},
"transferitem_set": [
{
"id": 1,
"state": {
"id": 1,
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"name": "text",
"config": {},
"enum_class": "text",
"enum_value": "text",
"content_type": 1
},
"unit_type": "quantity",
"package_item": {
"id": 1,
"state": {
"id": 1,
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"name": "text",
"config": {},
"enum_class": "text",
"enum_value": "text",
"content_type": 1
},
"order_item": {},
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"selected_barcode": "text",
"serial_no": "text",
"unit_weight": "text",
"package": 1,
"denial_reason": {
"id": 1,
"title": "text",
"remote_id": "text",
"priority": 1,
"is_active": true
}
},
"product": {},
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"name": "text",
"quantity": "text",
"stock_code": "text",
"barcode": "text",
"transfer_order": 1
}
],
"number": "text",
"order": 1,
"order_number": "text",
"package": 1,
"package_number": "text",
"channel_name": "text",
"customer": {
"email": "text",
"first_name": "text",
"last_name": "text",
"phone_number": "text",
"erp_code": "text",
"pk": 1,
"channel": 1
},
"shipping_address": {
"id": 1,
"city": {},
"country": {},
"township": {},
"district": {},
"mapping": {},
"title": "text",
"is_active": true,
"line": "text",
"postcode": "text",
"notes": "text",
"latitude": "text",
"longitude": "text"
},
"target_transfer_date": "2025-07-14T16:31:01.701Z",
"state": {
"id": 1,
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"name": "text",
"config": {},
"enum_class": "text",
"enum_value": "text",
"content_type": 1
},
"commands": [
{}
],
"invoice_number": "text",
"remote_id": "text",
"transfer_shipment": {},
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"id_encrypted": "text",
"extra_information": {}
}
},
"response_content": "text",
"response_http_status": 200,
"delivered": true,
"request_datetimes": [
"2025-07-14T16:31:01.701Z"
],
"retry_count": 1,
"object_id": "text",
"content_type": 1
}
]
}Returns detailed information about a single webhook event for the specified transfer order.
Authorizations
Path parameters
idintegerRequired
webhook_event_idintegerRequired
Query parameters
formatstring · enumOptionalDefault:
Response format
jsonPossible values: Responses
200
Successful operation
403
Forbidden
application/json
404
Not Found
application/json
get
GET /api/v1/oms/transfer_orders/{id}/webhook_events/{webhook_event_id} HTTP/1.1
Host: sandbox.akinon.com
Authorization: Bearer JWT
Accept: */*
{
"id": 1,
"webhook": {
"id": 133,
"retry_countdown_config": {
"choice": "fixed",
"kwargs": {
"seconds": 60
}
},
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"target_url": "https://example.com",
"is_active": true,
"secret_key": "text",
"event_type": "transfer.status.created",
"callback": "text",
"additional_headers": {},
"config": {}
},
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"uuid": "text",
"request_payload": {
"event": {
"type": "text",
"uuid": "text"
},
"payload": {
"id": 1,
"source": {
"id": 1,
"stock_location_type": "text",
"address": {
"id": 1,
"city": {},
"country": {},
"township": {},
"district": {},
"mapping": {},
"title": "text",
"is_active": true,
"line": "text",
"postcode": "text",
"notes": "text",
"latitude": "text",
"longitude": "text"
},
"erp_code": "text",
"engine": 1,
"tags": [
{}
],
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"omnitron_id": 1,
"name": "text",
"is_fulfillment_center": true,
"is_pickup_location": true,
"is_delivery_location": true,
"is_return_available": true,
"is_fast_delivery_available": true,
"is_active": true,
"priority": 1,
"conf": {},
"daytime_phone": "text",
"evening_phone": "text",
"fax_number": "text",
"email": "text",
"use_as_shipper_location": true,
"quota": 1,
"max_quota": 1
},
"destination": {
"id": 1,
"stock_location_type": "text",
"address": {
"id": 1,
"city": {},
"country": {},
"township": {},
"district": {},
"mapping": {},
"title": "text",
"is_active": true,
"line": "text",
"postcode": "text",
"notes": "text",
"latitude": "text",
"longitude": "text"
},
"erp_code": "text",
"engine": 1,
"tags": [
{}
],
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"omnitron_id": 1,
"name": "text",
"is_fulfillment_center": true,
"is_pickup_location": true,
"is_delivery_location": true,
"is_return_available": true,
"is_fast_delivery_available": true,
"is_active": true,
"priority": 1,
"conf": {},
"daytime_phone": "text",
"evening_phone": "text",
"fax_number": "text",
"email": "text",
"use_as_shipper_location": true,
"quota": 1,
"max_quota": 1
},
"transferitem_set": [
{
"id": 1,
"state": {
"id": 1,
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"name": "text",
"config": {},
"enum_class": "text",
"enum_value": "text",
"content_type": 1
},
"unit_type": "quantity",
"package_item": {
"id": 1,
"state": {
"id": 1,
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"name": "text",
"config": {},
"enum_class": "text",
"enum_value": "text",
"content_type": 1
},
"order_item": {},
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"selected_barcode": "text",
"serial_no": "text",
"unit_weight": "text",
"package": 1,
"denial_reason": {
"id": 1,
"title": "text",
"remote_id": "text",
"priority": 1,
"is_active": true
}
},
"product": {},
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"name": "text",
"quantity": "text",
"stock_code": "text",
"barcode": "text",
"transfer_order": 1
}
],
"number": "text",
"order": 1,
"order_number": "text",
"package": 1,
"package_number": "text",
"channel_name": "text",
"customer": {
"email": "text",
"first_name": "text",
"last_name": "text",
"phone_number": "text",
"erp_code": "text",
"pk": 1,
"channel": 1
},
"shipping_address": {
"id": 1,
"city": {},
"country": {},
"township": {},
"district": {},
"mapping": {},
"title": "text",
"is_active": true,
"line": "text",
"postcode": "text",
"notes": "text",
"latitude": "text",
"longitude": "text"
},
"target_transfer_date": "2025-07-14T16:31:01.701Z",
"state": {
"id": 1,
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"name": "text",
"config": {},
"enum_class": "text",
"enum_value": "text",
"content_type": 1
},
"commands": [
{}
],
"invoice_number": "text",
"remote_id": "text",
"transfer_shipment": {},
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"id_encrypted": "text",
"extra_information": {}
}
},
"response_content": "text",
"response_http_status": 200,
"delivered": true,
"request_datetimes": [
"2025-07-14T16:31:01.701Z"
],
"retry_count": 1,
"object_id": "text",
"content_type": 1
}Returns a paginated list of webhook events with less detailed information.
Authorizations
Path parameters
idintegerRequired
Query parameters
formatstring · enumOptionalDefault:
Response format
jsonPossible values: Responses
200
Successful operation
403
Forbidden
application/json
404
Not Found
application/json
get
GET /api/v1/oms/transfer_orders/{id}/webhook_events/short/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: Bearer JWT
Accept: */*
{
"count": 1,
"next": "text",
"previous": "text",
"results": [
{
"id": 1,
"webhook": {
"id": 133,
"target_url": "https://example.com",
"is_active": true,
"event_type": "transfer.status.created"
},
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"delivered": true
}
]
}Returns a simplified list of transfer orders, suitable for BI use cases.
Authorizations
Query parameters
formatstring · enumOptionalDefault:
Response format
jsonPossible values: Responses
200
Successful operation
403
Forbidden
application/json
404
Not Found
application/json
get
GET /api/v1/oms/transfer_orders/list-simple/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: Bearer JWT
Accept: */*
{
"count": 1,
"next": "text",
"previous": "text",
"results": [
{
"id": 133,
"created_date": "2025-07-14T16:31:01.701Z",
"modified_date": "2025-07-14T16:31:01.701Z",
"number": "text",
"target_transfer_date": "2025-07-14T16:31:01.701Z",
"invoice_number": "text",
"invoice_url": "https://example.com",
"extra_information": {},
"remote_id": "text",
"state": 1,
"source": 1,
"destination": 1,
"order": 1,
"plan_item": 1,
"invoice": "text"
}
]
}Was this helpful?