Transfer Items

Operations related to transfer items

List transfer items

get

Returns a paginated list of transfer items with 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:
transfer_orderintegerOptional

Filter by transfer order ID

productintegerOptional

Filter by product ID

quantityintegerOptional

Filter by exact quantity

quantity__gtintegerOptional

Filter quantities greater than this value

quantity__gteintegerOptional

Filter quantities greater than or equal to this value

quantity__ltintegerOptional

Filter quantities less than this value

quantity__lteintegerOptional

Filter quantities less than or equal to this value

Responses
200

Successful operation

application/json
get
/transfer-items/
GET /api/v1/oms/transfer-items/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful operation

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "id": 1,
      "transfer_order": {},
      "product": {},
      "quantity": 1,
      "state": {},
      "created_date": "2025-12-01T15:07:49.449Z",
      "modified_date": "2025-12-01T15:07:49.449Z"
    }
  ]
}

Get transfer item by ID

get

Retrieve a specific transfer item by its ID

Authorizations
AuthorizationstringRequired

Use format: Token <your_token>

Path parameters
idintegerRequired
Responses
200

Transfer item details

application/json
get
/transfer-items/{id}/
GET /api/v1/oms/transfer-items/{id}/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
200

Transfer item details

{
  "id": 1,
  "transfer_order": {},
  "product": {},
  "quantity": 1,
  "state": {},
  "created_date": "2025-12-01T15:07:49.449Z",
  "modified_date": "2025-12-01T15:07:49.449Z"
}

List transfer items (simplified)

get

Returns a simplified list of transfer items 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:
transfer_orderintegerOptional

Filter by transfer order ID

productintegerOptional

Filter by product ID

Responses
200

Successful operation

application/json
get
/transfer-items/list-simple/
GET /api/v1/oms/transfer-items/list-simple/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful operation

{
  "count": 1,
  "results": [
    {
      "id": 1,
      "transfer_order": 1,
      "product": 1,
      "quantity": 1,
      "state": 1,
      "created_date": "2025-12-01T15:07:49.449Z",
      "modified_date": "2025-12-01T15:07:49.449Z"
    }
  ]
}

Last updated

Was this helpful?