{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/docs/ai/document-ai/platform-managed-configurations/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Platform-Managed Configurations

\n

Platform-managed configurations are reusable processing configurations maintained by Shipwell. Use them when their description matches your document workflow and you do not need custom extraction instructions.

\n

Identify a platform-managed configuration

\n

In Shipwell, platform-managed configurations:

\n\n

\"Read-only

\n

In the API, platform-managed configurations have:

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n  \"enabled\": true,\n  \"is_platform_managed\": true\n}
\n
\n

Available configurations

\n

Shipwell provides five platform-managed configurations:

\n\n

Prefer a specialized configuration whenever you know the workflow, even when you do not know the exact document type. A document can reasonably fit more than one configuration; your selection defines the extraction intent.

\n

Use Universal Logistics when the context is genuinely unknown. Its broader coverage can take longer and be less precise than a specialized configuration.

\n

Common capabilities

\n

Every platform-managed configuration:

\n\n

The difference is extraction intent: each specialized configuration asks for a different set of business facts.

\n

Configuration comparison

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CapabilityShipment OperationsFreight Billing & SettlementOrders & CommercialCarrier ComplianceUniversal Logistics
Document classification✓✓✓✓✓
Structured signatures✓✓✓✓✓
Shipment stages, stops, cargo, and equipment✓———✓
Shipment events, exceptions, and delivery outcomes✓———✓
Rates, charges, weights, temperature, seals, and customs✓PartialPartial—✓
Invoices, settlements, adjustments, and payment termsPartial✓——✓
Purchase orders, line items, totals, and delivery requirements——✓—✓
Commercial trade and shipping termsPartial—✓—✓
Carrier identity, authority, insurance, and tax profilePartialPartial—✓✓
Carrier agreements, assignments, safety, and hazmat———✓✓
Best when business context is unknown————✓
\n

Partial means the configuration extracts the information only where it supports that configuration's primary workflow.

\n

Structured outputs by configuration

\n

These are the stable result names consumers see in schemas[].name. The value behind each name can be a string, object, or repeated result.

\n

Shipment Operations

\n

18 structured outputs:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Result nameWhat it provides
document_typeOperational role, such as bill of lading, proof of delivery, rate confirmation, receipt, report, or trade document
shipment_stagePlanning, tendered, picked up, in transit, delivered, billing, exception, or customs stage
shipment_identifierBOL, PRO, load, shipment, tracking, order, booking, container, seal, and related references
shipment_partyShipper, consignee, carrier, broker, buyer, seller, and other shipment parties
shipment_stopPickup, delivery, and intermediate stop details
cargo_itemCommodities, quantities, weights, dimensions, and handling details
equipmentTrailer, container, tractor, chassis, and seal information
shipment_eventPlanned and actual shipment events
signatureExecution role, signature status, signer details, date, method, and source
shipment_exceptionDelay, shortage, damage, refusal, temperature, customs, and other exceptions
delivery_outcomeDelivery completion, acceptance, refusal, and discrepancy information
rate_termsNegotiated transportation terms and rate context
chargeTransportation and accessorial charges
invoice_summaryInvoice identifiers, parties, dates, and totals
weight_measurementGross, tare, net, and related weight measurements
temperature_recordRequired and observed temperature information
customs_detailCustoms, origin, tariff, and trade information
seal_eventSeal application, inspection, change, and removal
\n

Freight Billing & Settlement

\n

12 structured outputs:

\n

document_type, billing_identifier, billing_party, shipment_reference, charge, settlement_adjustment, invoice_summary, settlement_summary, payment_terms, supporting_document_status, tax_summary, and signature.

\n

Use this configuration when the main question is what was billed, adjusted, approved, supported, or paid.

\n

Orders & Commercial Documents

\n

11 structured outputs:

\n

document_type, order_identifier, order_party, order_line, order_totals, order_date, shipping_terms, delivery_requirement, commercial_trade_detail, order_status, and signature.

\n

Use this configuration for purchase and sales orders, confirmations, commercial invoices, packing lists, and trade documents.

\n

Carrier Compliance

\n

12 structured outputs:

\n

document_type, carrier_identity, authority_record, insurance_policy, tax_profile, agreement_summary, compliance_expiration, signature, carrier_contact, notice_of_assignment, safety_record, and hazmat_credential.

\n

Use this configuration for onboarding, authority, insurance, agreements, tax forms, safety, and credential review.

\n

Universal Logistics

\n

Universal Logistics contains the union of the specialized output names, with duplicate concepts represented once. It is intentionally broad and should not replace a specialized configuration when the workflow is known.

\n

See Reading Results for how to consume these result names and Signatures for the difference between structured signature results and detected signature regions.

\n

Review a configuration before using it

\n

Open the configuration and review:

\n
    \n
  1. \nIts name and description\n
    2. \n
  2. \nWhether document splitting is enabled\n
    3. \n
  3. \nWhether descriptions and key facts are generated\n
    4. \n
  4. \nWhether semantic search is enabled\n
    5. \n
  5. \nThe extraction schemas and their expected result shapes\n
    6. \n
\n

A configuration's description explains its intended use. Do not select a configuration based only on its name.

\n

Select it during upload

\n

In the upload workflow, open Upload behavior and choose the named configuration marked Platform. Its settings apply to every file in that upload.

\n

Through the API, pass the configuration id:

\n
\n
",\n "files": [\n {"filename": "sample-document.pdf"}\n ]\n}`, `6267327984486593000`)\"\n >\n
Copy
\n
Copied
\n
\n 
{\n  \"processing_config_id\": \"<platform-processing-config-id>\",\n  \"files\": [\n    {\"filename\": \"sample-document.pdf\"}\n  ]\n}
\n
\n

Select it when reprocessing

\n

Apply the configuration's id through POST /document-store/runs.

\n

A new processing run is created for every accepted document. Previous runs remain available in the document's run history.

\n

See Runs and Reprocessing for the request example.

\n

API permissions

\n

You can retrieve and use a visible platform-managed configuration. Attempts to update or delete one return 403 with reason platform_config_immutable.

\n

If a configuration is unavailable to your account, retrieval and selection return 404.

\n

When you need different behavior

\n

If no platform-managed option matches your workflow, create a Custom Configuration. Custom configurations let your company define schemas and processing features while keeping the platform responsible for underlying model selection.

","headings":[{"value":"Platform-Managed Configurations","depth":1},{"value":"Identify a platform-managed configuration","depth":2},{"value":"Available configurations","depth":2},{"value":"Common capabilities","depth":2},{"value":"Configuration comparison","depth":2},{"value":"Structured outputs by configuration","depth":2},{"value":"Shipment Operations","depth":3},{"value":"Freight Billing & Settlement","depth":3},{"value":"Orders & Commercial Documents","depth":3},{"value":"Carrier Compliance","depth":3},{"value":"Universal Logistics","depth":3},{"value":"Review a configuration before using it","depth":2},{"value":"Select it during upload","depth":2},{"value":"Select it when reprocessing","depth":2},{"value":"API permissions","depth":2},{"value":"When you need different behavior","depth":2}]},"contentItem":{"data":{"lastModified":"2026-07-17T16:00:10.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":true,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"1aff7fdc-dbb7-5f80-823b-95f864ea2575__redocly content/docs/ai/document-ai/platform-managed-configurations/","seo":{"title":"Platform-Managed Configurations","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"docs/ai/document-ai/platform-managed-configurations.md","pageBaseUrl":"/docs/ai/document-ai/platform-managed-configurations","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Platform-Managed Configurations","id":"platform-managed-configurations"},{"depth":2,"value":"Identify a platform-managed configuration","id":"identify-a-platform-managed-configuration"},{"depth":2,"value":"Available configurations","id":"available-configurations"},{"depth":2,"value":"Common capabilities","id":"common-capabilities"},{"depth":2,"value":"Configuration comparison","id":"configuration-comparison"},{"depth":2,"value":"Structured outputs by configuration","id":"structured-outputs-by-configuration"},{"depth":3,"value":"Shipment Operations","id":"shipment-operations"},{"depth":3,"value":"Freight Billing & Settlement","id":"freight-billing--settlement"},{"depth":3,"value":"Orders & Commercial Documents","id":"orders--commercial-documents"},{"depth":3,"value":"Carrier Compliance","id":"carrier-compliance"},{"depth":3,"value":"Universal Logistics","id":"universal-logistics"},{"depth":2,"value":"Review a configuration before using it","id":"review-a-configuration-before-using-it"},{"depth":2,"value":"Select it during upload","id":"select-it-during-upload"},{"depth":2,"value":"Select it when reprocessing","id":"select-it-when-reprocessing"},{"depth":2,"value":"API permissions","id":"api-permissions"},{"depth":2,"value":"When you need different behavior","id":"when-you-need-different-behavior"}]},"data":{"title":"Platform-Managed Configurations"},"catalogInfo":null,"link":"/docs/ai/document-ai/platform-managed-configurations/","sidebarName":"developerPortal","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}