Transfer Orders

Transfer order operations and management

List transfer orders

get

Returns a paginated list of transfer orders with comprehensive filtering options.

Authorizations

AuthorizationstringRequired

Use format: Token <your_token>

Query parameters

formatstring · enumOptional

Response format

Default: jsonPossible values:

pageintegerOptional

Page number

Default: 1

limitintegerOptional

Number of items per page

Default: 20

sortstring · enumOptional

Sorting field

Possible values:

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 source stock location ERP code

destination__erp_codestringOptional

Filter by destination stock location ERP code

retail_store__erp_codestringOptional

Filter by retail store ERP code

erp_codestringOptional

Filter by ERP code

order__customer__first_namestringOptional

Filter by customer first name

order__customer__last_namestringOptional

Filter by customer last name

order__date_placedstring · dateOptional

Filter by order date

id__gtintegerOptional

Filter IDs greater than this value

id__gteintegerOptional

Filter IDs greater than or equal to this value

id__ltintegerOptional

Filter IDs less than this value

id__lteintegerOptional

Filter IDs less than or equal to this value

pk__instringOptional

Filter by primary keys (comma-separated)

order__channelintegerOptional

Filter by channel ID

package__shipment__cargo_companyintegerOptional

Filter by shipment cargo company

destination__countrystringOptional

Filter by destination country

Responses

200

Successful operation

application/json

get

/transfer_orders/

GET /api/v1/oms/transfer_orders/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful operation

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "id": 1,
      "number": "text",
      "state": {},
      "order": {},
      "package": {},
      "source": {},
      "destination": {},
      "created_date": "2025-11-27T02:41:43.446Z",
      "modified_date": "2025-11-27T02:41:43.446Z",
      "extra_information": {}
    }
  ]
}

Get transfer order by ID

get

Retrieve a specific transfer order by its ID

Authorizations

AuthorizationstringRequired

Use format: Token <your_token>

Path parameters

idintegerRequired

Responses

200

Transfer order details

application/json

get

/transfer_orders/{id}/

GET /api/v1/oms/transfer_orders/{id}/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Transfer order details

{
  "id": 1,
  "number": "text",
  "state": {},
  "order": {},
  "package": {},
  "source": {},
  "destination": {},
  "created_date": "2025-11-27T02:41:43.446Z",
  "modified_date": "2025-11-27T02:41:43.446Z",
  "extra_information": {}
}

List transfer orders with short format

get

Get a list of transfer orders with minimal information

Authorizations

AuthorizationstringRequired

Use format: Token <your_token>

Query parameters

formatstring · enumOptional

Response format

Default: jsonPossible values:

pageintegerOptional

Page number

Default: 1

limitintegerOptional

Number of items per page

Default: 20

sortstring · enumOptional

Sorting field

Possible values:

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

Responses

200

Successful operation

application/json

get

/transfer_orders/short/

GET /api/v1/oms/transfer_orders/short/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful operation

{
  "count": 1,
  "results": [
    {
      "id": 1,
      "number": "text",
      "state": "text",
      "source_erp_code": "text",
      "destination_erp_code": "text"
    }
  ]
}

Get transfer order with short format

get

Get a single transfer order with minimal information

Authorizations

AuthorizationstringRequired

Use format: Token <your_token>

Path parameters

idintegerRequired

Responses

200

Successful operation

application/json

get

/transfer_orders/{id}/short/

GET /api/v1/oms/transfer_orders/{id}/short/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful operation

{
  "id": 1,
  "number": "text",
  "state": "text",
  "source_erp_code": "text",
  "destination_erp_code": "text"
}

Execute transfer order command

post

Execute a command on a specific transfer order

Authorizations

AuthorizationstringRequired

Use format: Token <your_token>

Path parameters

idintegerRequired

Body

commandstringOptional

Command to execute

paramsobjectOptional

Command parameters

Responses

200

Command executed successfully

No content

400

Invalid command or parameters

post

/transfer_orders/{id}/command/

POST /api/v1/oms/transfer_orders/{id}/command/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "command": "text",
  "params": {}
}

No content

Get transfer order extra information

get

Retrieve extra information for a specific transfer order

Authorizations

AuthorizationstringRequired

Use format: Token <your_token>

Path parameters

idintegerRequired

Responses

200

Extra information retrieved successfully

application/json

Responseobject

get

/transfer_orders/{id}/extra_information/

GET /api/v1/oms/transfer_orders/{id}/extra_information/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Extra information retrieved successfully

{}

Set invoice number for transfer order

patch

Set or update the invoice number for a specific transfer order

Authorizations

AuthorizationstringRequired

Use format: Token <your_token>

Path parameters

idintegerRequired

Body

invoice_numberstringOptional

Invoice number to set

Responses

200

Invoice number updated successfully

No content

patch

/transfer_orders/{id}/set_invoice_number/

PATCH /api/v1/oms/transfer_orders/{id}/set_invoice_number/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "invoice_number": "text"
}

200

Invoice number updated successfully

No content

Set remote ID for transfer order

patch

Set or update the remote ID for a specific transfer order

Authorizations

AuthorizationstringRequired

Use format: Token <your_token>

Path parameters

idintegerRequired

Body

remote_idstringOptional

Remote ID to set

Responses

200

Remote ID updated successfully

No content

patch

/transfer_orders/{id}/set_remote_id/

PATCH /api/v1/oms/transfer_orders/{id}/set_remote_id/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "remote_id": "text"
}

200

Remote ID updated successfully

No content

Get transfer order transition logs

get

Retrieve state transition logs for a specific transfer order

Authorizations

AuthorizationstringRequired

Use format: Token <your_token>

Path parameters

idintegerRequired

Query parameters

pageintegerOptional

Page number

Default: 1

limitintegerOptional

Number of items per page

Default: 20

Responses

200

Transition logs retrieved successfully

application/json

get

/transfer_orders/{id}/transition_logs/

GET /api/v1/oms/transfer_orders/{id}/transition_logs/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Transition logs retrieved successfully

{
  "count": 1,
  "results": [
    {
      "id": 1,
      "content_object": {},
      "old_state": {},
      "new_state": {},
      "created_date": "2025-11-27T02:41:43.446Z",
      "extra_data": {}
    }
  ]
}

Get specific transition log

get

Retrieve a specific transition log by ID

Authorizations

AuthorizationstringRequired

Use format: Token <your_token>

Path parameters

idintegerRequired

log_idintegerRequired

Responses

200

Transition log retrieved successfully

application/json

get

/transfer_orders/{id}/transition_logs/{log_id}/

GET /api/v1/oms/transfer_orders/{id}/transition_logs/{log_id}/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Transition log retrieved successfully

{
  "id": 1,
  "content_object": {},
  "old_state": {},
  "new_state": {},
  "created_date": "2025-11-27T02:41:43.446Z",
  "extra_data": {}
}

List transfer orders (simplified)

get

Returns a simplified list of transfer orders with basic model fields

Authorizations

AuthorizationstringRequired

Use format: Token <your_token>

Query parameters

pageintegerOptional

Page number

Default: 1

limitintegerOptional

Number of items per page

Default: 20

sortstring · enumOptional

Sorting field

Possible values:

Responses

200

Successful operation

application/json

get

/transfer_orders/list-simple/

GET /api/v1/oms/transfer_orders/list-simple/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful operation

{
  "count": 1,
  "results": [
    {
      "id": 1,
      "number": "text",
      "state": 1,
      "order": 1,
      "package": 1,
      "source": 1,
      "destination": 1,
      "created_date": "2025-11-27T02:41:43.446Z",
      "modified_date": "2025-11-27T02:41:43.446Z"
    }
  ]
}

PreviousTransfer NextTransfer Items

Last updated 1 month ago

Was this helpful?