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

tokenAuth

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

countintegerOptional

Total number of items

nextstring · nullableOptional

URL for the next page

previousstring · nullableOptional

URL for the previous page

400

Bad request - invalid filter parameters

401

Authentication credentials were not provided

403

You do not have permission to perform this action

get

/packages/package-items/

HTTPcURLJavaScriptPython

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": "2026-03-06T16:32:27.745Z",
      "modified_date": "2026-03-06T16:32:27.745Z"
    }
  ]
}

Retrieve package item

get

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

Authorizations

tokenAuth

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

idintegerOptional

Unique identifier

packageobjectOptional

Associated package information

order_itemobjectOptional

Associated order item information

stateobjectOptional

Package item state information

quantityintegerOptional

Quantity of items

unit_weightnumber · decimalOptional

Unit weight of the item

created_datestring · date-timeOptional

Creation timestamp

modified_datestring · date-timeOptional

Last modification timestamp

401

Authentication credentials were not provided

403

You do not have permission to perform this action

404

Package item not found

get

/packages/package-items/{id}/

HTTPcURLJavaScriptPython

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": "2026-03-06T16:32:27.745Z",
  "modified_date": "2026-03-06T16:32:27.745Z"
}