Akinon Release Notes (11/10/2025) are now live! Click here to learn what's new.
Docs Portal

Package Services

This document covers all services related to packages, requests, and responses for these services.

Status Codes

The following status codes returns in the response message body of the request.

  • 200 OK: The request was successful and the requested resource is returned in the response.

  • 204 No Content: The request was successful and there is no content to be returned.

  • 400 Bad Request: The request was malformed or missing, false given required parameters.

  • 401 Unauthorized: The requested user is not authorized to access the requested resource.

  • 403 Forbidden: The server understands the request, but the client is not authorized to access the requested resource.

  • 406 Not Acceptable: The server cannot produce a response matching the list of acceptable values defined in the request's headers.

  • 429 Too Many Requests: Made too many requests in a given amount of time and the server is rate limiting the request.

  • 500 Internal Server Error: An unexpected error occurred on the server.

GET Package List

Returns a detailed list of packaging orders.

Path: /api/v1/oms/packages/

Request

  • Headers: -

  • Authorization: Token

  • Body Parameters: None

  • Request Body: None

Response (200 OK)

Response Description

A detailed list of packages, shipments, shipping labels, package items, available commands, and stock_locations is transmitted in the message body.

GET Package Short List

Returns less detailed list of packages. Compared to Package List packageitem_count is returned instead of packageitem_set, as well as omiting some parameters.

Path: /api/v1/oms/packages/short/

Request

  • Headers: -

  • Authorization: Token

  • Body Parameters: None

  • Request Body: None

Response (200 OK)

Response Description:

Only the parameters needed for the packaging orders list page in the OMS are transmitted. Instead of repeatedly transmitting information for all related objects, only their keys are transmitted in the message body.

GET Package Simple List

Returns less detailed list of packaging orders.

Path: /api/v1/oms/packages/list-simple/

Request

  • Headers: -

  • Authorization: Token

  • Body Parameters: None

  • Request Body: None

Response 200 OK

Response Description:

Since this endpoint is designed specifically for the BI tool, it includes the created_date and modified_date parameters. It excludes the majority of the other parameters.

GET Package Detail

Returns the detailed information of a single package with pk (ID).

Path: /api/v1/oms/packages/pk/

Request

  • Headers: -

  • Authorization: Token

  • Body Parameters: None

  • Request Body: None

Response (200 OK)

Response Description:

Package related information, including shipment, shipping label, package items, available commands, and stock locations, is transmitted in the message body.

GET Package Short Detail

Returns less detailed information of the package with pk (ID) compared to Package Detail.

Path: /api/v1/oms/packages/pk/short/

Request

  • Headers: -

  • Authorization: Token

  • Body Parameters: None

  • Request Body: None

Response (200 OK)

Response Description:

Only the required parameters on the OMS Packaging Order Detail page are transmitted in the message body.

GET Package State Transition Log List

Returns the list of transition logs for the package with pk (ID).

Path: /api/v1/oms/packages/pk/transition_logs/

Request

  • Headers: -

  • Authorization: Token

  • Body Parameters: None

  • Request Body: None

Response (200 OK)

Response Description:

State transition log ID, old state, new state, user attributes, created date, object ID and content type are transmitted in the message body.

GET Package State Transition Log Short List

Returns less detailed list of transition logs. The object_id and content_type are omitted when compared to the Package State Transition Log List.

Path: /api/v1/oms/packages/pk/transition_logs/short/

Request

  • Headers: -

  • Authorization: Token

  • Body Parameters: None

  • Request Body: None

Response (200 OK)

Response Description:

Only the required parameters on the OMS Package Detail page transition logs are transmitted in the message body.

GET Package State Transition Log Detail

Returns details of a single state transition log with thelog_id of the package specified with the pk (ID).

Path: /api/v1/oms/packages/pk/transition_logs/log_id/

Request

  • Headers: -

  • Authorization: Token

  • Body Parameters: None

  • Request Body: None

Response (200 OK)

Response Description:

State transition log ID, old state, new state, user attributes, created date, object ID, and content type are transmitted in the message body.

GET Package State Transition Log Short Detail

Returns less detailed information of transition logs. The object_id and content_type are omitted when compared to the Package State Transition Log Detail.

Path: /api/v1/oms/packages/pk/transition_logs/short/log_id/

Request

  • Headers: -

  • Authorization: Token

  • Body Parameters: None

  • Request Body: None

Response (200 OK)

Response Description:

Only the required parameters on the OMS Package State Transition Log page are transmitted in the message body.

GET Package Webhook Event List

Returns the list of webhook events of the package specified with the pk (ID).

Path: /api/v1/oms/packages/pk/webhook_events/

Request

  • Headers: -

  • Authorization: Token

  • Body Parameters: None

  • Request Body: None

Response (200 OK)

Response Description:

Detailed information about the webhook along with the entire payload is transmitted in the message body.

GET Package Webhook Event Short List

Returns less detailed list of webhook events belonging to the package specified with the pk (ID). Compared to Package Webhook Event List less information about the webhook is transmitted and payload is excluded from the response to reduce the size of the response.

Path: /api/v1/oms/packages/pk/webhook_events/short/

Request

  • Headers: -

  • Authorization: Token

  • Body Parameters: None

  • Request Body: None

Response (200 OK)

Response Description:

Only the required parameters on the OMS Package Detail Webhook Events page are transmitted in the message body.

GET Package Webhook Event Details

Returns the details of a webhook event with the webhook_event_id of the package specified with the pk (ID).

Path: /api/v1/oms/packages/pk/webhook_events/webhook_event_id/

Request

  • Headers: -

  • Authorization: Token

  • Body Parameters: None

  • Request Body: None

Response (200 OK)

Response Description:

Detailed information about the webhook event with the entire payload is transmitted in the message body.

GET Package Delivery Ranges

Returns the distinct available delivery ranges.

Path: /api/v1/oms/packages/delivery-ranges/

Request

  • Headers: -

  • Authorization: Token

  • Body Parameters: None

  • Request Body: None

Response (200 OK)

Response Description:

The lower, upper and bounds values of the delivery ranges are transmitted in the message body.

POST Package Command

Runs the command given in the request body for the package specified with the pk (ID). Instructions for the commands may be found in Commands article.

Path: /api/v1/oms/packages/pk/command/

Request

  • Headers: -

  • Authorization: Token

  • Body Parameters: None

Body Parameters

Property
Data Type
Required
Descriptions

transition

int

false*

Transition ID

slug

str

false*

Unique slug of the transition

input_parameters

dict

true

Parameters ( {} is entered if there are no parameters)

*Either slug or transition is required.

Request Body Example

Response (204 No Content)

Response (200 OK)

Response Description:

There is no content to send for this request. If there is a content (depending on the command), the status code is 200 OK.

POST Package Invoice

Creates a purchase invoice for the package specified with the pk (ID) using the provided ID (from the URL). The request is sent without a body.

Path: /api/v1/oms/packages/pk/invoice/

Request

  • Headers: -

  • Authorization: Token

  • Body Parameters: None

  • Request Body: None

Response (201 CREATED)

Response Description:

Detailed information about the created invoice is transmitted in the message body.

POST Package Set Invoice Number

Assigns the invoice number specified in the request body to the package specified with the pk (ID).

Path: /api/v1/oms/packages/pk/set_invoice_number/

Request

  • Headers: -

  • Authorization: Token

  • Body Parameters: None

Body Parameters

Property
Data Type
Required
Descriptions

invoice_number

string

true

New invoice number to be assigned to the package

Request Body Example

Response (204 No Content)

Response Description:

There is no content to send for this request.

POST Package Set Remote ID

Updates the remote_id parameter of the package specified with the pk (ID).

Path: /api/v1/oms/packages/pk/set_remote_id/

Request

  • Headers: -

  • Authorization: Token

  • Body Parameters: None

  • Request Body: None

Body Parameters

Property
Data Type
Required
Descriptions

remote_id

string

true

Remote ID to be assigned to the package

Request Body Example

Response (204 No Content)

Response Description:

There is no content to send for this request.

PreviousOMSNextPackage Item Services

Last updated

Was this helpful?