Skip to main content
GET
/
api
/
lakehouse
/
documents
/
{document_id}
Get Document
curl --request GET \
  --url https://api.merchantops.ai/api/lakehouse/documents/{document_id}
{
  "document_id": "<string>",
  "file_size": 123,
  "file_type": "<string>",
  "file_url": "<string>",
  "filename": "<string>",
  "job_id": "<string>",
  "organization_id": "<string>",
  "status": "<string>",
  "uploaded_at": "<string>",
  "uploaded_by": "<string>",
  "approval_status": "pending_review",
  "approved_at": "<string>",
  "approved_by": "<string>",
  "available_columns": [
    "<string>"
  ],
  "brand_key": "<string>",
  "brand_name": "<string>",
  "changes_detected": 123,
  "document_category": "product",
  "extracted_products": [
    {
      "key": "<string>",
      "brand_key": "",
      "extraction_confidence": 123,
      "name": "",
      "needs_review": false,
      "visibility": "shared"
    }
  ],
  "extracted_technologies": [
    {
      "key": "<string>",
      "brand_key": "",
      "description": "<string>",
      "name": ""
    }
  ],
  "organization_name": "<string>",
  "policy_id": "<string>",
  "preview_rows": [
    {}
  ],
  "prices_extracted": 123,
  "prices_linked": 123,
  "prices_unmatched": 123,
  "processing_completed_at": "<string>",
  "processing_error": "<string>",
  "processing_started_at": "<string>",
  "products_extracted": 0,
  "rejection_reason": "<string>",
  "rows_skipped": 123,
  "skipped_rows_details": [
    {}
  ],
  "stubs_created": 123,
  "technologies_extracted": 0,
  "total_rows_processed": 123,
  "uploaded_by_name": "<string>"
}

Headers

authorization
string | null
X-Organization-ID
string | null

Path Parameters

document_id
string
required

Cookies

stytch_session
string | null

Response

Successful Response

Response model for document metadata.

document_id
string
required
file_size
integer
required
file_type
string
required
file_url
string
required
filename
string
required
job_id
string
required
organization_id
string
required
status
string
required
uploaded_at
string
required
uploaded_by
string
required
approval_status
string | null
default:pending_review

Governance status: pending_review, approved, rejected

approved_at
approved_by
string | null
available_columns
string[] | null
brand_key
string | null

Brand key (for pricing documents)

brand_name
string | null

Brand display name (e.g. 'New Balance')

changes_detected
integer | null

Number of changes detected vs previous policy

document_category
string | null
default:product

Category: 'product' or 'pricing'

extracted_products
ExtractedProductSummary · object[] | null

Products extracted from this document (from the shared lakehouse)

extracted_technologies
ExtractedTechnologySummary · object[] | null

Technologies extracted from this document (from the shared lakehouse)

organization_name
string | null
policy_id
string | null

MAP policy ID created from this document

preview_rows
Preview Rows · object[] | null
prices_extracted
integer | null

Number of MAP prices extracted

prices_linked
integer | null

Number of prices linked to existing products

prices_unmatched
integer | null

Number of prices without product match

processing_completed_at
string | null
processing_error
string | null
processing_started_at
string | null
products_extracted
integer
default:0
rejection_reason
string | null
rows_skipped
integer | null
skipped_rows_details
Skipped Rows Details · object[] | null
stubs_created
integer | null

Number of product stubs auto-created

technologies_extracted
integer
default:0
total_rows_processed
integer | null
uploaded_by_name
string | null