Packages

Main package operations and management

List packages

get

Get a list of Packages Objects for listing

Authorizations

tokenAuth

AuthorizationstringRequired

Use format: Token <your_token>

Query parameters

formatstring · enumOptional

Response format

Possible values:

pageintegerOptional

Page number

Default: 1

limitintegerOptional

Items per page

Default: 20

sortstring · enumOptional

Sort field

Possible values:

stateintegerOptional

State ID filter

state__enum_valuestringOptional

State enum value filter

state__enum_value__neqstringOptional

State enum value not equal filter

orderintegerOptional

Order ID filter

stock_locationintegerOptional

Stock location ID filter

stock_location__erp_codestringOptional

Stock location ERP code filter

stock_location__erp_code__instringOptional

Stock location ERP code in filter

stock_location__stock_location_typestringOptional

Stock location type filter

order__numberstringOptional

Order number filter

order__omnitron_idintegerOptional

Order Omnitron ID filter

start_datestring · dateOptional

Start date filter

end_datestring · dateOptional

End date filter

modified_start_datestring · dateOptional

Modified start date filter

modified_end_datestring · dateOptional

Modified end date filter

shipment__created_date__gtestring · date-timeOptional

Shipment created start date filter

shipment__created_date__ltestring · date-timeOptional

Shipment created end date filter

packageitem__order_item__product__skustringOptional

Product SKU filter

packageitem__order_item__product__barcodestringOptional

Product barcode filter

delivery_range__lowerstring · dateOptional

Delivery range lower bound filter

delivery_range__upperstring · dateOptional

Delivery range upper bound filter

delivery_range_datestring · dateOptional

Delivery range date filter

order__channelintegerOptional

Channel ID filter

order__customer__first_namestringOptional

Customer first name filter

order__customer__last_namestringOptional

Customer last name filter

order__date_placedstring · dateOptional

Order date filter

order__date_placed__gtestring · dateOptional

Order date placed greater than or equal filter

order__date_placed__ltestring · dateOptional

Order date placed less than or equal filter

shipment__cargo_companyintegerOptional

Shipment cargo company filter

packageitem__order_item__omnitron_id__instringOptional

Package item order item Omnitron ID in filter

is_click_and_collectbooleanOptional

Click and collect filter

id__gtintegerOptional

ID greater than filter

id__gteintegerOptional

ID greater than or equal filter

id__ltintegerOptional

ID less than filter

id__lteintegerOptional

ID less than or equal filter

pk__instringOptional

Primary key in filter

Responses

200

List of packages

application/json

get

/packages/

HTTPcURLJavaScriptPython

GET /api/v1/oms/packages/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

List of packages

{
  "count": 1,
  "results": [
    {
      "id": 1,
      "number": "text",
      "state": {},
      "order": {},
      "stock_location": {},
      "created_date": "2025-12-13T13:08:11.710Z",
      "modified_date": "2025-12-13T13:08:11.710Z"
    }
  ]
}

Get package by ID

get

Retrieve a specific package by its ID

Authorizations

tokenAuth

AuthorizationstringRequired

Use format: Token <your_token>

Path parameters

idintegerRequired

Responses

200

Package details

application/json

get

/packages/{id}/

HTTPcURLJavaScriptPython

GET /api/v1/oms/packages/{id}/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Package details

{
  "id": 1,
  "number": "text",
  "state": {},
  "order": {},
  "stock_location": {},
  "created_date": "2025-12-13T13:08:11.710Z",
  "modified_date": "2025-12-13T13:08:11.710Z"
}

List packages with short format

get

Get a list of Packages with minimal information

Authorizations

tokenAuth

AuthorizationstringRequired

Use format: Token <your_token>

Query parameters

formatstring · enumOptional

Response format

Possible values:

pageintegerOptional

Page number

Default: 1

limitintegerOptional

Items per page

Default: 20

Responses

200

Successful operation

application/json

get

/packages/short/

HTTPcURLJavaScriptPython

GET /api/v1/oms/packages/short/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful operation

{
  "count": 1,
  "results": [
    {
      "id": 1,
      "number": "text",
      "state": "text",
      "stock_location_erp_code": "text"
    }
  ]
}

Get a package with short format

get

Get a single Package object with minimal information

Authorizations

tokenAuth

AuthorizationstringRequired

Use format: Token <your_token>

Path parameters

idintegerRequired

Responses

200

Successful operation

application/json

get

/packages/{id}/short/

HTTPcURLJavaScriptPython

GET /api/v1/oms/packages/{id}/short/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful operation

{
  "id": 1,
  "number": "text",
  "state": "text",
  "stock_location_erp_code": "text"
}

Execute package command

post

Execute a command on a specific package

Authorizations

tokenAuth

AuthorizationstringRequired

Use format: Token <your_token>

Path parameters

idintegerRequired

Body

application/json

commandstringOptional

Command to execute

paramsobjectOptional

Command parameters

Responses

200

Command executed successfully

400

Invalid command or parameters

post

/packages/{id}/command/

HTTPcURLJavaScriptPython

POST /api/v1/oms/packages/{id}/command/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "command": "text",
  "params": {}
}

No content

Get package items for a package

get

Retrieve all package items for a specific package

Authorizations

tokenAuth

AuthorizationstringRequired

Use format: Token <your_token>

Path parameters

idintegerRequired

Responses

200

Package items list

application/json

get

/packages/{id}/package-items/

HTTPcURLJavaScriptPython

GET /api/v1/oms/packages/{id}/package-items/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Package items list

[
  {
    "id": 1,
    "package": {},
    "order_item": {},
    "state": {},
    "quantity": 1,
    "unit_weight": 1,
    "created_date": "2025-12-13T13:08:11.710Z",
    "modified_date": "2025-12-13T13:08:11.710Z"
  }
]