# Transfer Items

Operations related to transfer items

## List transfer items

> Returns a paginated list of transfer items with filtering options.

```json
{"openapi":"3.0.3","info":{"title":"OMS Transfers Module API","version":"1.0.0"},"tags":[{"name":"transfer-items","description":"Operations related to transfer items"}],"servers":[{"url":"https://{domain}/api/v1/oms","variables":{"domain":{"default":"domain.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Use format: `Token <your_token>`"}},"parameters":{"format":{"name":"format","in":"query","description":"Response format","schema":{"type":"string","enum":["json","html","csv","xls"],"default":"json"}},"page":{"name":"page","in":"query","description":"Page number","schema":{"type":"integer","default":1}},"limit":{"name":"limit","in":"query","description":"Number of items per page","schema":{"type":"integer","default":20}},"sort":{"name":"sort","in":"query","description":"Sorting field","schema":{"type":"string","enum":["id","-id","modified_date","-modified_date","created_date","-created_date","order_id","-order_id"]}},"transfer_order":{"name":"transfer_order","in":"query","description":"Filter by transfer order ID","schema":{"type":"integer"}},"product":{"name":"product","in":"query","description":"Filter by product ID","schema":{"type":"integer"}},"quantity":{"name":"quantity","in":"query","description":"Filter by exact quantity","schema":{"type":"integer"}},"quantity_gt":{"name":"quantity__gt","in":"query","description":"Filter quantities greater than this value","schema":{"type":"integer"}},"quantity_gte":{"name":"quantity__gte","in":"query","description":"Filter quantities greater than or equal to this value","schema":{"type":"integer"}},"quantity_lt":{"name":"quantity__lt","in":"query","description":"Filter quantities less than this value","schema":{"type":"integer"}},"quantity_lte":{"name":"quantity__lte","in":"query","description":"Filter quantities less than or equal to this value","schema":{"type":"integer"}}},"schemas":{"TransferItem":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"transfer_order":{"type":"object","description":"Associated transfer order information"},"product":{"type":"object","description":"Product information"},"quantity":{"type":"integer","description":"Quantity of items to transfer"},"state":{"type":"object","description":"Transfer item state information"},"created_date":{"type":"string","format":"date-time","description":"Creation timestamp"},"modified_date":{"type":"string","format":"date-time","description":"Last modification timestamp"}}}}},"paths":{"/transfer-items/":{"get":{"tags":["transfer-items"],"summary":"List transfer items","description":"Returns a paginated list of transfer items with filtering options.","parameters":[{"$ref":"#/components/parameters/format"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/transfer_order"},{"$ref":"#/components/parameters/product"},{"$ref":"#/components/parameters/quantity"},{"$ref":"#/components/parameters/quantity_gt"},{"$ref":"#/components/parameters/quantity_gte"},{"$ref":"#/components/parameters/quantity_lt"},{"$ref":"#/components/parameters/quantity_lte"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/TransferItem"}}}}}}}}}}}}
```

## Get transfer item by ID

> Retrieve a specific transfer item by its ID

```json
{"openapi":"3.0.3","info":{"title":"OMS Transfers Module API","version":"1.0.0"},"tags":[{"name":"transfer-items","description":"Operations related to transfer items"}],"servers":[{"url":"https://{domain}/api/v1/oms","variables":{"domain":{"default":"domain.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Use format: `Token <your_token>`"}},"schemas":{"TransferItem":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"transfer_order":{"type":"object","description":"Associated transfer order information"},"product":{"type":"object","description":"Product information"},"quantity":{"type":"integer","description":"Quantity of items to transfer"},"state":{"type":"object","description":"Transfer item state information"},"created_date":{"type":"string","format":"date-time","description":"Creation timestamp"},"modified_date":{"type":"string","format":"date-time","description":"Last modification timestamp"}}}}},"paths":{"/transfer-items/{id}/":{"get":{"tags":["transfer-items"],"summary":"Get transfer item by ID","description":"Retrieve a specific transfer item by its ID","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Transfer item details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferItem"}}}}}}}}}
```

## List transfer items (simplified)

> Returns a simplified list of transfer items with basic model fields

```json
{"openapi":"3.0.3","info":{"title":"OMS Transfers Module API","version":"1.0.0"},"tags":[{"name":"transfer-items","description":"Operations related to transfer items"}],"servers":[{"url":"https://{domain}/api/v1/oms","variables":{"domain":{"default":"domain.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Use format: `Token <your_token>`"}},"parameters":{"page":{"name":"page","in":"query","description":"Page number","schema":{"type":"integer","default":1}},"limit":{"name":"limit","in":"query","description":"Number of items per page","schema":{"type":"integer","default":20}},"sort":{"name":"sort","in":"query","description":"Sorting field","schema":{"type":"string","enum":["id","-id","modified_date","-modified_date","created_date","-created_date","order_id","-order_id"]}},"transfer_order":{"name":"transfer_order","in":"query","description":"Filter by transfer order ID","schema":{"type":"integer"}},"product":{"name":"product","in":"query","description":"Filter by product ID","schema":{"type":"integer"}}},"schemas":{"TransferItemSimple":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"transfer_order":{"type":"integer","description":"Transfer order ID"},"product":{"type":"integer","description":"Product ID"},"quantity":{"type":"integer","description":"Quantity of items to transfer"},"state":{"type":"integer","description":"State ID"},"created_date":{"type":"string","format":"date-time","description":"Creation timestamp"},"modified_date":{"type":"string","format":"date-time","description":"Last modification timestamp"}}}}},"paths":{"/transfer-items/list-simple/":{"get":{"tags":["transfer-items"],"summary":"List transfer items (simplified)","description":"Returns a simplified list of transfer items with basic model fields","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/transfer_order"},{"$ref":"#/components/parameters/product"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TransferItemSimple"}}}}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidocs.akinon.com/oms-openapis/transfer/transfer-items.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.