For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update Document Request Shipping

Update carrier and tracking number on an invoice-sourced document request.

/regulatory-documents/request/:request_id/shipping

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

Invoice requests only. Shipment-sourced requests already have carrier and tracking from the shipment.

When carrier is updated, available_documents are re-matched (carrier can affect FDA eligibility).

At least one of carrier or tracking_number is required.

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

carrier

String

Carrier slug or carrier id. e.g. dhl, dhl-ng, fedex, CRR-7890. Validated against active carriers.

tracking_number

String

Carrier tracking number. Pass "" to clear.

Sample body : update both

{
    "carrier": "fedex",
    "tracking_number": "1Z999AA10123456784"
}

Sample body : tracking only

Sample body : carrier only

Note: dhl is normalized to dhl-ng internally for regulatory matching.

Common errors

Status
Message

400

Carrier and tracking number can only be updated for invoice document requests

404

Carrier not found for carrier - {value}

400

Carrier is not available

Last updated

Was this helpful?