Package Items

Operations related to package items

List package items

get

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.

Authorizations
AuthorizationstringRequired

Use format: Token <your_token>

Query parameters
pageinteger · min: 1Optional

Page number for pagination

Default: 1
page_sizeinteger · min: 1 · max: 100Optional

Number of items per page

Default: 20
sortstring · enumOptional

Ordering field

Possible values:
packageintegerOptional

Filter by package ID

package__numberstringOptional

Filter by package number

stateintegerOptional

Filter by state ID

state__enum_valuestringOptional

Filter by state enum value

Responses
200

Successful response with package items

application/json
get
/packages/package-items/
GET /api/v1/oms/packages/package-items/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "id": 1,
      "package": {},
      "order_item": {},
      "state": {},
      "quantity": 1,
      "unit_weight": 1,
      "created_date": "2025-12-01T15:11:05.058Z",
      "modified_date": "2025-12-01T15:11:05.058Z"
    }
  ]
}

Retrieve package item

get

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

Authorizations
AuthorizationstringRequired

Use format: Token <your_token>

Path parameters
idintegerRequired

The unique identifier of the package item

Responses
200

Successful response with package item details

application/json
get
/packages/package-items/{id}/
GET /api/v1/oms/packages/package-items/{id}/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "id": 1,
  "package": {},
  "order_item": {},
  "state": {},
  "quantity": 1,
  "unit_weight": 1,
  "created_date": "2025-12-01T15:11:05.058Z",
  "modified_date": "2025-12-01T15:11:05.058Z"
}

Last updated

Was this helpful?