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
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
get
/packages/package_denial_reason/

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
AuthorizationstringRequired

Use format: Token <your_token>

Body
titlestring · max: 255Required

Human-readable title/name of the denial reason

remote_idstring | 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
chevron-right
201

Package denial reason created successfully

application/json
post
/packages/package_denial_reason/

Retrieve package denial reason

get

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

Authorizations
AuthorizationstringRequired

Use format: Token <your_token>

Path parameters
idintegerRequired

The unique identifier of the package denial reason

Responses
get
/packages/package_denial_reason/{id}/

Update package denial reason (full update)

put

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

Authorizations
AuthorizationstringRequired

Use format: Token <your_token>

Path parameters
idintegerRequired

The unique identifier of the package denial reason

Body
titlestring · max: 255Required

Human-readable title/name of the denial reason

remote_idstring | 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
put
/packages/package_denial_reason/{id}/

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
AuthorizationstringRequired

Use format: Token <your_token>

Path parameters
idintegerRequired

The unique identifier of the package denial reason

Responses
delete
/packages/package_denial_reason/{id}/

No content

Partially update package denial reason

patch

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

Authorizations
AuthorizationstringRequired

Use format: Token <your_token>

Path parameters
idintegerRequired

The unique identifier of the package denial reason

Body
titlestring · max: 255Optional

Human-readable title/name of the denial reason

remote_idstring | 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
patch
/packages/package_denial_reason/{id}/

Last updated

Was this helpful?