← Technical API reference

Frontend module · STATIC DECLARATIONS

Supply Request Api client API reference · mansoq-web

7 client route/call declarations with path parameters, named payload/response types and source references. Exact server acceptance and permissions require the matched backend contract.

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.

Client contract scope

These 7 declarations come from repositories/platform/mansoq-web/src/types/inventory/supplyRequest/supplyRequestApi.ts. Client types and noAuth flags describe the caller; they do not authorize a server action. Dynamic paths and missing backend matches are retained as review work, not repaired into invented endpoints.

Operation map

Client method HTTP method Path pattern Resolution
default.listSupplyRequest GET /api/v1/supply_request/ literal
default.retrieveSupplyRequest GET /api/v1/supply_request/{supplyRequestId}/ literal
default.createSupplyRequest POST /api/v1/supply_request/ literal
default.upsertSupplyRequest POST /api/v1/supply_request/upsert/ literal
default.updateSupplyRequest PUT /api/v1/supply_request/{supplyRequestId}/ literal
default.updateSupplyRequestAsReceiver PUT /api/v1/supply_request/{supplyRequestId}/update_as_receiver/ literal
default.requestOrders GET /api/v1/supply_request/request_orders/ literal

default.listSupplyRequest

GET /api/v1/supply_request/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Declared default query fields: ordering (string). These are defaults observed at this route object, not an exhaustive query allowlist.

response type: PaginatedResponse<SupplyRequestRead>. client-side declaration; not proof of accepted server payload.

PaginatedResponse declared fields:

Field Type Required Description
count number true —
results TItem[] true —

SupplyRequestRead declared fields:

Field Type Required Description
item ProductKnowledgeBase true —
order RequestOrderRetrieve true —

Composed/inherited schema references: SupplyRequestBase. Exact generic composition is retained in the structured reference and requires server-side confirmation.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.retrieveSupplyRequest

GET /api/v1/supply_request/{supplyRequestId}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: supplyRequestId. Transport strings are declared here; semantic identifier types require the server contract.

response type: SupplyRequestRead. client-side declaration; not proof of accepted server payload.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.createSupplyRequest

POST /api/v1/supply_request/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

request type: SupplyRequestCreate. client-side declaration; not proof of accepted server payload.

SupplyRequestCreate declared fields:

Field Type Required Description
item string true —
order string true —

Composed/inherited schema references: SupplyRequestBase. Exact generic composition is retained in the structured reference and requires server-side confirmation.

response type: SupplyRequestBase. client-side declaration; not proof of accepted server payload.

SupplyRequestBase declared fields:

Field Type Required Description
id string true —
status SupplyRequestStatus true —
quantity string true —

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.upsertSupplyRequest

POST /api/v1/supply_request/upsert/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

request type: object. client-side declaration; not proof of accepted server payload.

SupplyRequestUpsert declared fields:

Field Type Required Description
id string false —
item string true —
order string true —

Composed/inherited schema references: SupplyRequestBase. Exact generic composition is retained in the structured reference and requires server-side confirmation.

default.upsertSupplyRequest.request declared fields:

Field Type Required Description
datapoints SupplyRequestUpsert[] true —

response type: SupplyRequestBase. client-side declaration; not proof of accepted server payload.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.updateSupplyRequest

PUT /api/v1/supply_request/{supplyRequestId}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: supplyRequestId. Transport strings are declared here; semantic identifier types require the server contract.

request type: SupplyRequestCreate. client-side declaration; not proof of accepted server payload.

response type: SupplyRequestBase. client-side declaration; not proof of accepted server payload.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.updateSupplyRequestAsReceiver

PUT /api/v1/supply_request/{supplyRequestId}/update_as_receiver/. typed route object; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: supplyRequestId. Transport strings are declared here; semantic identifier types require the server contract.

request type: SupplyRequestCreate. client-side declaration; not proof of accepted server payload.

response type: SupplyRequestBase. client-side declaration; not proof of accepted server payload.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.requestOrders

GET /api/v1/supply_request/request_orders/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

response type: PaginatedResponse<RequestOrderRetrieve>. client-side declaration; not proof of accepted server payload.

RequestOrderRetrieve declared fields:

Field Type Required Description
id string true —
created_date string true —
created_by UserReadMinimal true —
modified_date string true —
origin LocationDetail false —
destination LocationDetail true —
supplier Organization false —
tags TagConfig[] true —

Composed/inherited schema references: RequestOrder. Exact generic composition is retained in the structured reference and requires server-side confirmation.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

Pinned source evidence

Links require access to the private source repository.