> For the complete documentation index, see [llms.txt](https://apidocs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.akinon.com/oms-openapis/packages/package-items.md). # 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.
```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 `"}},"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 `"}},"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"}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## 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, and the optional `goal` query parameter: ``` GET https://apidocs.akinon.com/oms-openapis/packages/package-items.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.