Package Denial Reasons
Operations related to package denial reasons
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.
Use format: Token <your_token>
Page number for pagination
1Number of items per page
20Ordering field
Filter by active status
Filter by title (case-insensitive contains search)
Filter by exact priority value
Filter by exact remote ID
Successful response with paginated denial reasons
Bad request - invalid filter parameters
Authentication credentials were not provided
You do not have permission to perform this action
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
}
]
}Creates a new package denial reason with the provided data.
The title must be unique across all denial reasons.
Use format: Token <your_token>
Human-readable title/name of the denial reason
External system identifier
Priority level for sorting denial reasons
Whether the denial reason is active and can be used
truePackage denial reason created successfully
Bad request - validation errors
Authentication credentials were not provided
You do not have permission to perform this action
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
}Retrieves a single package denial reason by its ID with all details.
Use format: Token <your_token>
The unique identifier of the package denial reason
Successful response with denial reason details
Authentication credentials were not provided
You do not have permission to perform this action
Package denial reason not found
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
}Updates all fields of a package denial reason. All required fields must be provided.
Use format: Token <your_token>
The unique identifier of the package denial reason
Human-readable title/name of the denial reason
External system identifier
Priority level for sorting denial reasons
Whether the denial reason is active and can be used
Package denial reason updated successfully
Bad request - validation errors
Authentication credentials were not provided
You do not have permission to perform this action
Package denial reason not found
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
}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.
Use format: Token <your_token>
The unique identifier of the package denial reason
Package denial reason deleted successfully
Authentication credentials were not provided
You do not have permission to perform this action
Package denial reason not found
DELETE /api/v1/oms/packages/package_denial_reason/{id}/ HTTP/1.1
Host: domain.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
No content
Partially updates a package denial reason. Only provided fields will be updated.
Use format: Token <your_token>
The unique identifier of the package denial reason
Human-readable title/name of the denial reason
External system identifier
Priority level for sorting denial reasons
Whether the denial reason is active and can be used
Package denial reason updated successfully
Bad request - validation errors
Authentication credentials were not provided
You do not have permission to perform this action
Package denial reason not found
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
}Last updated
Was this helpful?