> 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/models.md).

# Models

## The Package object

```json
{"openapi":"3.0.3","info":{"title":"OMS Packages Module API","version":"1.0.0"},"components":{"schemas":{"Package":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"number":{"type":"string","description":"Package number"},"state":{"type":"object","description":"Package state information"},"order":{"type":"object","description":"Associated order information"},"stock_location":{"type":"object","description":"Stock location information"},"created_date":{"type":"string","format":"date-time","description":"Creation timestamp"},"modified_date":{"type":"string","format":"date-time","description":"Last modification timestamp"}}}}}}
```

## The PackageShort object

```json
{"openapi":"3.0.3","info":{"title":"OMS Packages Module API","version":"1.0.0"},"components":{"schemas":{"PackageShort":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"number":{"type":"string","description":"Package number"},"state":{"type":"string","description":"Package state enum value"},"stock_location_erp_code":{"type":"string","description":"Stock location ERP code"}}}}}}
```

## The PackageDenialReason object

```json
{"openapi":"3.0.3","info":{"title":"OMS Packages Module API","version":"1.0.0"},"components":{"schemas":{"PackageDenialReason":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier","readOnly":true},"title":{"type":"string","description":"Human-readable title/name of the denial reason","maxLength":255},"remote_id":{"type":"string","nullable":true,"description":"External system identifier","maxLength":100},"priority":{"type":"integer","nullable":true,"description":"Priority level for sorting denial reasons","minimum":0},"is_active":{"type":"boolean","description":"Whether the denial reason is active and can be used","default":true}},"required":["id","title","is_active"]}}}}
```

## The PackageDenialReasonCreate object

```json
{"openapi":"3.0.3","info":{"title":"OMS Packages Module API","version":"1.0.0"},"components":{"schemas":{"PackageDenialReasonCreate":{"type":"object","properties":{"title":{"type":"string","description":"Human-readable title/name of the denial reason","maxLength":255},"remote_id":{"type":"string","nullable":true,"description":"External system identifier","maxLength":100},"priority":{"type":"integer","nullable":true,"description":"Priority level for sorting denial reasons","minimum":0},"is_active":{"type":"boolean","description":"Whether the denial reason is active and can be used","default":true}},"required":["title"]}}}}
```

## The PackageDenialReasonUpdate object

```json
{"openapi":"3.0.3","info":{"title":"OMS Packages Module API","version":"1.0.0"},"components":{"schemas":{"PackageDenialReasonUpdate":{"type":"object","properties":{"title":{"type":"string","description":"Human-readable title/name of the denial reason","maxLength":255},"remote_id":{"type":"string","nullable":true,"description":"External system identifier","maxLength":100},"priority":{"type":"integer","nullable":true,"description":"Priority level for sorting denial reasons","minimum":0},"is_active":{"type":"boolean","description":"Whether the denial reason is active and can be used"}},"required":["title","is_active"]}}}}
```

## The PackageDenialReasonPartialUpdate object

```json
{"openapi":"3.0.3","info":{"title":"OMS Packages Module API","version":"1.0.0"},"components":{"schemas":{"PackageDenialReasonPartialUpdate":{"type":"object","properties":{"title":{"type":"string","description":"Human-readable title/name of the denial reason","maxLength":255},"remote_id":{"type":"string","nullable":true,"description":"External system identifier","maxLength":100},"priority":{"type":"integer","nullable":true,"description":"Priority level for sorting denial reasons","minimum":0},"is_active":{"type":"boolean","description":"Whether the denial reason is active and can be used"}}}}}}
```

## The PaginatedPackageDenialReasonResponse object

```json
{"openapi":"3.0.3","info":{"title":"OMS Packages Module API","version":"1.0.0"},"components":{"schemas":{"PaginatedPackageDenialReasonResponse":{"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/PackageDenialReason"}}}},"PackageDenialReason":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier","readOnly":true},"title":{"type":"string","description":"Human-readable title/name of the denial reason","maxLength":255},"remote_id":{"type":"string","nullable":true,"description":"External system identifier","maxLength":100},"priority":{"type":"integer","nullable":true,"description":"Priority level for sorting denial reasons","minimum":0},"is_active":{"type":"boolean","description":"Whether the denial reason is active and can be used","default":true}},"required":["id","title","is_active"]}}}}
```

## The PackageItem object

```json
{"openapi":"3.0.3","info":{"title":"OMS Packages Module API","version":"1.0.0"},"components":{"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"}}}}}}
```

## The PaginatedPackageItemResponse object

```json
{"openapi":"3.0.3","info":{"title":"OMS Packages Module API","version":"1.0.0"},"components":{"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"}}}}}}
```


---

# 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/models.md?ask=<question>&goal=<endgoal>
```

`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.