MANSOQ Knowledge
← Technical API reference

Backend resource · STATIC DECLARATIONS

Supply Delivery API reference · mansoq-core

Static source contract for Supply Delivery: 7 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.

Static API contract — behavior review pending. Source baseline f6e9f05f76d4.

Enable JavaScript to inspect structured operation, parameter, schema and permission evidence. Download this reference and its evidence.

Declared route and availability

This resource is declared in mansoq-core at /api/v1/supply_delivery/. verified core mount in config/urls.py A registered path and an indexed handler do not prove deployment availability, user permission or production readiness.

Operation map

Method Path Action Evidence
GET /api/v1/supply_delivery/ list declared/inherited method
POST /api/v1/supply_delivery/ create declared/inherited method
GET /api/v1/supply_delivery/{external_id}/ retrieve declared/inherited method
PUT /api/v1/supply_delivery/{external_id}/ update declared/inherited method
PATCH /api/v1/supply_delivery/{external_id}/ partial_update declared/inherited method
POST /api/v1/supply_delivery/upsert/ upsert @action declaration
GET /api/v1/supply_delivery/delivery_orders/ delivery_orders @action declaration

list · GET

GET /api/v1/supply_delivery/ — action list. static contract extracted; runtime/permission/payload behavior review pending.

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
query include_children not declared at read site not established
query order not declared at read site direct indexing; validation may be upstream
query request_order not declared at read site direct indexing; validation may be upstream
query destination not declared at read site direct indexing; validation may be upstream
query origin not declared at read site direct indexing; validation may be upstream

response: SupplyDeliveryReadSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
meta dict false No extra constraint extracted
id UUID4 | None false No extra constraint extracted
status SupplyDeliveryStatusOptions true No extra constraint extracted
supplied_item_condition SupplyDeliveryConditionOptions | None false No extra constraint extracted
total_purchase_price Decimal | None false No extra constraint extracted
extensions dict true No extra constraint extracted
supplied_item_quantity int true No extra constraint extracted
supplied_item dict | None false No extra constraint extracted
created_date datetime.datetime true No extra constraint extracted
modified_date datetime.datetime true No extra constraint extracted
supplied_inventory_item dict | None false No extra constraint extracted
supply_request dict | None false No extra constraint extracted
supplied_item_pack_quantity int | None false No extra constraint extracted
supplied_item_pack_size int | None false No extra constraint extracted
order dict | None false No extra constraint extracted

Observed authorization checks: can_list_facility_supply_delivery. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: No filters provided; PermissionDenied: Cannot read supply requests; PermissionDenied: Cannot list supply requests.

create · POST

POST /api/v1/supply_delivery/ — action create. static contract extracted; runtime/permission/payload behavior review pending.

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
query include_children not declared at read site not established
query order not declared at read site direct indexing; validation may be upstream
query request_order not declared at read site direct indexing; validation may be upstream
query destination not declared at read site direct indexing; validation may be upstream
query origin not declared at read site direct indexing; validation may be upstream

request: SupplyDeliveryWriteSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
meta dict false No extra constraint extracted
id UUID4 | None false No extra constraint extracted
status SupplyDeliveryStatusOptions true No extra constraint extracted
supplied_item_condition SupplyDeliveryConditionOptions | None false No extra constraint extracted
total_purchase_price Decimal | None false No extra constraint extracted
extensions dict false No extra constraint extracted
supplied_item_pack_quantity int | None false ge: 1
supplied_item_pack_size int | None false ge: 1
supplied_item_quantity Decimal true ge: 1
supplied_item UUID4 | None false No extra constraint extracted
supplied_inventory_item UUID4 | None false No extra constraint extracted
supply_request UUID4 | None false No extra constraint extracted
order UUID4 true No extra constraint extracted

response: SupplyDeliveryRetrieveSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
meta dict false No extra constraint extracted
id UUID4 | None false No extra constraint extracted
status SupplyDeliveryStatusOptions true No extra constraint extracted
supplied_item_condition SupplyDeliveryConditionOptions | None false No extra constraint extracted
total_purchase_price Decimal | None false No extra constraint extracted
extensions dict false No extra constraint extracted
supplied_item_quantity int true No extra constraint extracted
supplied_item dict | None false No extra constraint extracted
created_date datetime.datetime true No extra constraint extracted
modified_date datetime.datetime true No extra constraint extracted
supplied_inventory_item dict | None false No extra constraint extracted
supply_request dict | None false No extra constraint extracted
supplied_item_pack_quantity int | None false No extra constraint extracted
supplied_item_pack_size int | None false No extra constraint extracted
order dict | None false No extra constraint extracted
created_by UserSpec false No extra constraint extracted
updated_by UserSpec false No extra constraint extracted

Observed authorization checks: can_list_facility_supply_delivery, can_write_facility_supply_delivery, can_write_facility_external_supply_delivery. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: No filters provided; PermissionDenied: Cannot read supply requests; PermissionDenied: Cannot list supply requests; PermissionDenied: Cannot write supply requests; ValidationError: Supplied inventory item is not part of the origin or its children; ValidationError: Insufficient stock; ValidationError: Delivery order is abandoned or entered in error; ValidationError: Delivery order is completed.

retrieve · GET

GET /api/v1/supply_delivery/{external_id}/ — action retrieve. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
path external_id router lookup string; semantic ID validation requires handler/schema review true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
query include_children not declared at read site not established
query order not declared at read site direct indexing; validation may be upstream
query request_order not declared at read site direct indexing; validation may be upstream
query destination not declared at read site direct indexing; validation may be upstream
query origin not declared at read site direct indexing; validation may be upstream

response: SupplyDeliveryRetrieveSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Observed authorization checks: can_list_facility_supply_delivery. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: No filters provided; PermissionDenied: Cannot read supply requests; PermissionDenied: Cannot list supply requests.

update · PUT

PUT /api/v1/supply_delivery/{external_id}/ — action update. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
path external_id router lookup string; semantic ID validation requires handler/schema review true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
query include_children not declared at read site not established
query order not declared at read site direct indexing; validation may be upstream
query request_order not declared at read site direct indexing; validation may be upstream
query destination not declared at read site direct indexing; validation may be upstream
query origin not declared at read site direct indexing; validation may be upstream

request: SupplyDeliveryUpdateSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
meta dict false No extra constraint extracted
id UUID4 | None false No extra constraint extracted
status SupplyDeliveryStatusOptions true No extra constraint extracted
supplied_item_condition SupplyDeliveryConditionOptions | None false No extra constraint extracted
total_purchase_price Decimal | None false No extra constraint extracted
extensions dict false No extra constraint extracted

response: SupplyDeliveryRetrieveSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Observed authorization checks: can_list_facility_supply_delivery, can_write_facility_supply_delivery, can_write_facility_external_supply_delivery. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: No filters provided; PermissionDenied: Cannot read supply requests; PermissionDenied: Cannot list supply requests; PermissionDenied: Cannot write supply requests; ValidationError: Supplied inventory item is not part of the origin or its children; ValidationError: Insufficient stock; ValidationError: Supply delivery is abandoned or entered in error; ValidationError: Supply delivery already completed.

partial_update · PATCH

PATCH /api/v1/supply_delivery/{external_id}/ — action partial_update. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
path external_id router lookup string; semantic ID validation requires handler/schema review true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
query include_children not declared at read site not established
query order not declared at read site direct indexing; validation may be upstream
query request_order not declared at read site direct indexing; validation may be upstream
query destination not declared at read site direct indexing; validation may be upstream
query origin not declared at read site direct indexing; validation may be upstream

request: SupplyDeliveryUpdateSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

response: SupplyDeliveryRetrieveSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Observed authorization checks: can_list_facility_supply_delivery. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: No filters provided; PermissionDenied: Cannot read supply requests; PermissionDenied: Cannot list supply requests; ValidationError: Supplied inventory item is not part of the origin or its children; ValidationError: Insufficient stock; ValidationError: Supply delivery is abandoned or entered in error; ValidationError: Supply delivery already completed.

upsert · POST

POST /api/v1/supply_delivery/upsert/ — action upsert. static contract extracted; runtime/permission/payload behavior review pending.

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
body datapoints not declared at read site not established
query include_children not declared at read site not established
query order not declared at read site direct indexing; validation may be upstream
query request_order not declared at read site direct indexing; validation may be upstream
query destination not declared at read site direct indexing; validation may be upstream
query origin not declared at read site direct indexing; validation may be upstream

Observed authorization checks: can_list_facility_supply_delivery. Helper/queryset evidence is included; this is not proof of complete security review.

Explicit response statuses in observed code: 400. Other branches/framework exception handling may differ.

Declared refusal/error evidence: RestFrameworkValidationError: Invalid request data; RestFrameworkValidationError: No datapoints provided; RestFrameworkValidationError: Too many datapoints provided; ValidationError: No filters provided; PermissionDenied: Cannot read supply requests; PermissionDenied: Cannot list supply requests; ValidationError: Supplied inventory item is not part of the origin or its children; ValidationError: Insufficient stock; ValidationError: Supply delivery is abandoned or entered in error; ValidationError: Supply delivery already completed; ValidationError: Delivery order is abandoned or entered in error; ValidationError: Delivery order is completed; PermissionDenied: Cannot write supply requests.

Conditional gates: conditional/computed expression; inspect pinned declaration comparison settings.MAX_DATAPOINTS_PER_UPSERT.

delivery_orders · GET

GET /api/v1/supply_delivery/delivery_orders/ — action delivery_orders. static contract extracted; runtime/permission/payload behavior review pending.

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
query include_children not declared at read site not established
query order not declared at read site direct indexing; validation may be upstream
query request_order not declared at read site direct indexing; validation may be upstream
query destination not declared at read site direct indexing; validation may be upstream
query origin not declared at read site direct indexing; validation may be upstream

Observed authorization checks: can_list_facility_supply_delivery. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: request_order is required; ValidationError: No filters provided; PermissionDenied: Cannot read supply requests; PermissionDenied: Cannot list supply requests.

Integration review checklist

Confirm the installed route and full schema; review authentication, organization/facility scoping, all accepted fields, value-state and date/time semantics, idempotency, pagination, response/exception branches and the allowed correction/reversal workflow. Test positive and negative cases with synthetic data. This source reference does not establish external certification or replace an illustrated user procedure.

Pinned source evidence

Links require access to the private source repository.