# Package Items

Operations related to package items

## List package items

> Returns a paginated list of package items with detailed information including \
> order item details, transfer orders, denial reasons, and discrepancy information.\
> \
> Supports comprehensive filtering by package, dates, and ordering options.<br>

```json
{"openapi":"3.0.3","info":{"title":"OMS Packages Module API","version":"1.0.0"},"tags":[{"name":"package-items","description":"Operations related to package 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":{"PaginatedPackageItemResponse":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of items"},"next":{"type":"string","nullable":true,"description":"URL for the next page"},"previous":{"type":"string","nullable":true,"description":"URL for the previous page"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PackageItem"}}}},"PackageItem":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"package":{"type":"object","description":"Associated package information"},"order_item":{"type":"object","description":"Associated order item information"},"state":{"type":"object","description":"Package item state information"},"quantity":{"type":"integer","description":"Quantity of items"},"unit_weight":{"type":"number","format":"decimal","description":"Unit weight of the item"},"created_date":{"type":"string","format":"date-time","description":"Creation timestamp"},"modified_date":{"type":"string","format":"date-time","description":"Last modification timestamp"}}}}},"paths":{"/packages/package-items/":{"get":{"tags":["package-items"],"summary":"List package items","description":"Returns a paginated list of package items with detailed information including \norder item details, transfer orders, denial reasons, and discrepancy information.\n\nSupports comprehensive filtering by package, dates, and ordering options.\n","operationId":"listPackageItems","parameters":[{"in":"query","name":"page","schema":{"type":"integer","default":1,"minimum":1},"description":"Page number for pagination"},{"in":"query","name":"page_size","schema":{"type":"integer","default":20,"minimum":1,"maximum":100},"description":"Number of items per page"},{"in":"query","name":"sort","schema":{"type":"string","enum":["id","-id","created_date","-created_date","modified_date","-modified_date"]},"description":"Ordering field"},{"in":"query","name":"package","schema":{"type":"integer"},"description":"Filter by package ID"},{"in":"query","name":"package__number","schema":{"type":"string"},"description":"Filter by package number"},{"in":"query","name":"state","schema":{"type":"integer"},"description":"Filter by state ID"},{"in":"query","name":"state__enum_value","schema":{"type":"string"},"description":"Filter by state enum value"}],"responses":{"200":{"description":"Successful response with package items","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedPackageItemResponse"}}}},"400":{"description":"Bad request - invalid filter parameters"},"401":{"description":"Authentication credentials were not provided"},"403":{"description":"You do not have permission to perform this action"}}}}}}
```

## Retrieve package item

> Retrieves a single package item by its ID with all details.

```json
{"openapi":"3.0.3","info":{"title":"OMS Packages Module API","version":"1.0.0"},"tags":[{"name":"package-items","description":"Operations related to package 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":{"PackageItem":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"package":{"type":"object","description":"Associated package information"},"order_item":{"type":"object","description":"Associated order item information"},"state":{"type":"object","description":"Package item state information"},"quantity":{"type":"integer","description":"Quantity of items"},"unit_weight":{"type":"number","format":"decimal","description":"Unit weight of the item"},"created_date":{"type":"string","format":"date-time","description":"Creation timestamp"},"modified_date":{"type":"string","format":"date-time","description":"Last modification timestamp"}}}}},"paths":{"/packages/package-items/{id}/":{"get":{"tags":["package-items"],"summary":"Retrieve package item","description":"Retrieves a single package item by its ID with all details.","operationId":"retrievePackageItem","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"},"description":"The unique identifier of the package item"}],"responses":{"200":{"description":"Successful response with package item details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageItem"}}}},"401":{"description":"Authentication credentials were not provided"},"403":{"description":"You do not have permission to perform this action"},"404":{"description":"Package item not found"}}}}}}
```
