circle-check
Akinon Release Notes 01/05/2026) are now live! Click here to learn what's new.
arrow-up-right
search
Docs Portal

Transfer Order Services

This document covers all services related to transfer orders, requests, and responses for these services.

hashtag
Status Codes

The following status codes returns in the response message body of the request.

  • 200 OK: The request was successful and the requested resource is returned in the response.

  • 204 No Content: The request was successful and there is no content to be returned.

  • 400 Bad Request: The request was malformed or missing, false given required parameters.

  • 401 Unauthorized: The requested user is not authorized to access the requested resource.

  • 403 Forbidden: The server understands the request, but the client is not authorized to access the requested resource.

  • 406 Not Acceptable: The server cannot produce a response matching the list of acceptable values defined in the request's headers.

  • 429 Too Many Requests: Made too many requests in a given amount of time and the server is rate limiting the request.

  • 500 Internal Server Error: An unexpected error occurred on the server.

hashtag
GET Transfer Order List

Returns a detailed list of transfer orders.

Path: /api/v1/oms/transfer_orders/

Request

  • Headers: -

  • Authorization: Token

  • Content-Type: application/json

  • Request Body: None

Response (200 OK)

Response Description:

A detailed information about transfer orders, transfer items, transfer shipments, available commands, state, transfer source and destination are transmitted in the message body.

hashtag
GET Transfer Order List - Simple

Returns less detailed information of transfer orders compared to Transfer Order List.

Path: /api/v1/oms/transfer_orders/list-simple/

Request

  • Headers: -

  • Authorization: Token

  • Content-Type: application/json

  • Request Body: None

Response (200 OK)

Response Description:

Instead of repeatedly transmitting information for all related objects, only their keys are transmitted in the message body.

hashtag
GET Transfer Order Detail

Returns the detailed information of a single transfer order specified with the pk (ID).

Path: /api/v1/oms/transfer_orders/pk/

Request

  • Headers: -

  • Authorization: Token

  • Content-Type: application/json

  • Request Body: None

Response (200 OK)

Response Description:

A detailed information of the transfer order, including transfer items, transfer shipment, available commands, state, transfer source and destination, and customer, is transmitted in the message body.

hashtag
GET Transfer Order State Transition Log List

Returns the list of transition logs for a single transfer order specified with the pk (ID).

Path: /api/v1/oms/transfer_orders/pk/transition_logs/

Request

  • Headers: -

  • Authorization: Token

  • Content-Type: application/json

  • Request Body: None

Response (200 OK)

Response Description:

State transition logs ID, old state, new state, user attributes, created date, object ID and content type are transmitted in the message body.

hashtag
GET Transfer Order State Transition Log List - Short

Returns less detailed list of transition logs. The object_id and content_type are omitted when compared to the Transfer Order State Transition Log List.

Path: /api/v1/oms/transfer_orders/pk/transition_logs/short/

Request

  • Headers: -

  • Authorization: Token

  • Content-Type: application/json

  • Request Body: None

Response (200 OK)

Response Description:

Same as the response in the Transfer Order State Transition Log List, except that the content_type and object_id parameters are not included.

hashtag
GET Transfer Order State Transition Log Detail

Returns details of a single state transition log with thelog_id of the transfer order specified with the pk (ID).

Path: /api/v1/oms/packages/pk/transition_logs/log_id/

Request

  • Headers: -

  • Authorization: Token

  • Content-Type: application/json

  • Request Body: None

Response (200 OK)

Response Description:

State transition log ID, old state, new state, user, attributes, created date object ID and content type are transmitted in the message body.

hashtag
GET Transfer Order Webhook Event List

Returns the list of webhook events of the transfer order specified with the pk (ID).

Path: /api/v1/oms/transfer_orders/pk/webhook_events/

Request

  • Headers: -

  • Authorization: Token

  • Content-Type: application/json

  • Request Body: None

Response (200 OK)

Response Description:

Detailed information about the webhook event of the transfer order is transmitted in the message body.

hashtag
GET Transfer Order Webhook Event List - Short

Returns less detailed webhook event data for the transfer order specified with the pk (ID). Compared to Transfer Order Webhook Event List less information about the webhook is transmitted and payload is excluded from the response.

Path: /api/v1/oms/transfer_orders/pk/webhook_events/short/

Request

  • Headers: -

  • Authorization: Token

  • Content-Type: application/json

  • Request Body: None

Response (200 OK)

Response Description:

Less detailed webhook data (id, target_url, is_active, event_type), id, created_date, modified_date and delivered status of the webhook event are transmitted in the message body.

hashtag
GET Transfer Order Webhook Event Detail

Returns the details for the single webhook event of the transfer order specified with the pk (ID).

Path: /api/v1/oms/transfer_orders/pk/webhook_events/webhook_event_id/

Request

  • Headers: -

  • Authorization: Token

  • Content-Type: application/json

  • Request Body: None

Response (200 OK)

Response Description:

Detailed information about the webhook event with the entire payload is transmitted in the message body.

hashtag
POST Transfer Order Command

Runs the command given in the request body for the transfer order specified with the pk (ID).

Path: /api/v1/oms/transfer_orders/pk/command/

Request

  • Headers: -

  • Authorization: Token

  • Content-Type: application/json

Body Parameters

Field
Data Type
Required
Description

transition

int

false*

Transition ID

slug

str

false*

Unique slug of transition

input_parameters

dict

true

Parameters ( {} is entered if there are no parameters)

*Either slug or transition is required.

Request Body Example 1

Request Body Example 2

Response (204 No Content)

Response Description:

There is no content to send for this request. If there is a content (depending on the command), the status code is 200 OK.

hashtag
POST Transfer Order - Set Invoice Number

Updates the invoice number of the transfer order specified with the pk (ID).

Path: /api/v1/oms/transfer_orders/pk/set_invoice_number/

Request

  • Headers: -

  • Authorization: Token

  • Content-Type: application/json

Body Parameters

Field
Data Type
Required
Descriptions

invoice_number

str

true

New invoice number of transfer order

Request Body Example

Response (204 No Content)

Response Description:

There is no content to send for this request.

hashtag
POST Transfer Order - Set Remote ID

Updates the remote ID of the transfer order specified with the pk (ID).

Path: /api/v1/oms/transfer_orders/pk/set_remote_id/

Request

  • Headers: -

  • Authorization: Token

  • Content-Type: application/json

Body Parameters

Property
Data Type
Required
Descriptions

remote_id

str

true

new remote id of the transfer order

Request Body Example

Response (204 No Content)

Response Description:

There is no content to send for this request.

PreviousOrder Item ServicesNextTransfer Item Services

Last updated

Was this helpful?