Update Document Request Items

Update line items on a draft document request (HS codes, values, regulatory profiles).

/regulatory-documents/request/:request_id

PUT https://api.terminal.africa/v1/regulatory-documents/request/:request_id

Re-matches available_documents after item changes. Clears HS-code validation errors when fixed.

Draft: add new items (omit item_id) or update existing items (include item_id).

After purchase (failed-doc recovery): only existing items may be updated. item_id is required on every item.

Path Parameters

Name	Type	Description
request_id*	String	Document request id. e.g. DRQ-ABC1234567.

Headers

Name	Type	Description
Authorization*	String	Set value to Bearer SECRET_KEY
Content-Type*	String	Set value to application/json

Request Body

Name	Type	Description
items*	Array	One or more item objects (see below).

Item object

Name	Type	Description
item_id	String	Required to update an existing item. Omit to append a new item (draft only).
description*	String	Item description.
hs_code*	String	Harmonized System code. e.g. 0901.21.
value*	Number	Item value.
currency*	String	Item value currency. 3-letter code. e.g. USD.
quantity*	Number	Quantity.
weight*	Number	Weight per unit.
weight_unit*	String	Weight unit. e.g. kg.
manufacturer_country	String	ISO country code. e.g. NG.
manufacturers_profile	Object or String	Manufacturer address snapshot or address id.
regulatory_profiles	Object	Map of document slug → profile fields. See Update Item Regulatory Profile.

Sample body: fix missing HS code

{
    "items": [
        {
            "item_id": "DRI-ITEM002",
            "description": "Gift box",
            "hs_code": "4819.20",
            "value": 25,
            "currency": "USD",
            "quantity": 1,
            "weight": 0.5,
            "weight_unit": "kg",
            "manufacturer_country": "NG"
        }
    ]
}

Sample body : add new item (draft only)

{
    "items": [
        {
            "description": "Organic honey",
            "hs_code": "0409.00",
            "value": 15,
            "currency": "USD",
            "quantity": 2,
            "weight": 1,
            "weight_unit": "kg",
            "manufacturer_country": "NG"
        }
    ]
}

Returns the full document request object (same shape as Get Document Request).

200: OK Document request updated successfully

{
    "status": true,
    "message": "Document request updated successfully",
    "data": {
        "request_id": "DRQ-ABC1234567",
        "status": "draft",
        "validation": {
            "ok": true,
            "items_missing_hs_codes": []
        },
        "error": "",
        "available_documents": []
    }
}