Package Denial Reasons

Operations related to package denial reasons

List package denial reasons

get

Returns a paginated list of package denial reasons with filtering support.

Supports filtering by active status, title, priority, remote ID, and date ranges. Results can be ordered by ID or modification date.

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:

is_activebooleanOptional

Filter by active status

titlestringOptional

Filter by title (case-insensitive contains search)

priorityintegerOptional

Filter by exact priority value

remote_idstringOptional

Filter by exact remote ID

Responses

200

Successful response with paginated denial reasons

application/json

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_denial_reason/

HTTPcURLJavaScriptPython

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

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "id": 1,
      "title": "text",
      "remote_id": "text",
      "priority": 1,
      "is_active": true
    }
  ]
}

Create package denial reason

post

Creates a new package denial reason with the provided data.

The title must be unique across all denial reasons.

Authorizations

tokenAuth

AuthorizationstringRequired

Use format: Token <your_token>

Body

application/json

titlestring · max: 255Required

Human-readable title/name of the denial reason

remote_idstring · max: 100 · nullableOptional

External system identifier

priorityinteger · nullableOptional

Priority level for sorting denial reasons

is_activebooleanOptional

Whether the denial reason is active and can be used

Default: true

Responses

201

Package denial reason created successfully

application/json

idintegerRead-onlyRequired

Unique identifier

titlestring · max: 255Required

Human-readable title/name of the denial reason

remote_idstring · max: 100 · nullableOptional

External system identifier

priorityinteger · nullableOptional

Priority level for sorting denial reasons

is_activebooleanRequired

Whether the denial reason is active and can be used

Default: true

400

Bad request - validation errors

401

Authentication credentials were not provided

403

You do not have permission to perform this action

post

/packages/package_denial_reason/

HTTPcURLJavaScriptPython

POST /api/v1/oms/packages/package_denial_reason/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "title": "text",
  "remote_id": "text",
  "priority": 1,
  "is_active": true
}

{
  "id": 1,
  "title": "text",
  "remote_id": "text",
  "priority": 1,
  "is_active": true
}

Retrieve package denial reason

get

Retrieves a single package denial reason by its ID with all details.

Authorizations

tokenAuth

AuthorizationstringRequired

Use format: Token <your_token>

Path parameters

idintegerRequired

The unique identifier of the package denial reason

Responses

200

Successful response with denial reason details

application/json

401

Authentication credentials were not provided

403

You do not have permission to perform this action

404

Package denial reason not found

get

/packages/package_denial_reason/{id}/

HTTPcURLJavaScriptPython

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

{
  "id": 1,
  "title": "text",
  "remote_id": "text",
  "priority": 1,
  "is_active": true
}

Update package denial reason (full update)

put

Updates all fields of a package denial reason. All required fields must be provided.

Authorizations

tokenAuth

AuthorizationstringRequired

Use format: Token <your_token>

Path parameters

idintegerRequired

The unique identifier of the package denial reason

Body

application/json

titlestring · max: 255Required

Human-readable title/name of the denial reason

remote_idstring · max: 100 · nullableOptional

External system identifier

priorityinteger · nullableOptional

Priority level for sorting denial reasons

is_activebooleanRequired

Whether the denial reason is active and can be used

Responses

200

Package denial reason updated successfully

application/json

400

Bad request - validation errors

401

Authentication credentials were not provided

403

You do not have permission to perform this action

404

Package denial reason not found

put

/packages/package_denial_reason/{id}/

HTTPcURLJavaScriptPython

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

{
  "title": "text",
  "remote_id": "text",
  "priority": 1,
  "is_active": true
}

{
  "id": 1,
  "title": "text",
  "remote_id": "text",
  "priority": 1,
  "is_active": true
}

Delete package denial reason

delete

Soft deletes a package denial reason by setting its is_active flag to false.

This is a soft delete operation - the denial reason is not physically removed from the database but marked as inactive.

Authorizations

tokenAuth

AuthorizationstringRequired

Use format: Token <your_token>

Path parameters

idintegerRequired

The unique identifier of the package denial reason

Responses

204

Package denial reason deleted successfully

401

Authentication credentials were not provided

403

You do not have permission to perform this action

404

Package denial reason not found

delete

/packages/package_denial_reason/{id}/

HTTPcURLJavaScriptPython

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

No content

Partially update package denial reason

patch

Partially updates a package denial reason. Only provided fields will be updated.

Authorizations

tokenAuth

AuthorizationstringRequired

Use format: Token <your_token>

Path parameters

idintegerRequired

The unique identifier of the package denial reason

Body

application/json

titlestring · max: 255Optional

Human-readable title/name of the denial reason

remote_idstring · max: 100 · nullableOptional

External system identifier

priorityinteger · nullableOptional

Priority level for sorting denial reasons

is_activebooleanOptional

Whether the denial reason is active and can be used

Responses

200

Package denial reason updated successfully

application/json

400

Bad request - validation errors

401

Authentication credentials were not provided

403

You do not have permission to perform this action

404

Package denial reason not found

patch

/packages/package_denial_reason/{id}/

HTTPcURLJavaScriptPython

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

{
  "title": "text",
  "remote_id": "text",
  "priority": 1,
  "is_active": true
}

{
  "id": 1,
  "title": "text",
  "remote_id": "text",
  "priority": 1,
  "is_active": true
}