Skip to main content
Create orders with POST /orders.

​
Required fields

FieldTypeDescription
repositoryNamestringName of the archive, repository, courthouse, or record office.
documentTypestringType of document requested.
locationstringPlace, jurisdiction, or repository location.
FieldTypeDescription
archiveRepositoryIdstringStable repository identifier from your system or a known archival registry.
countryISOA3stringThree-letter country code.
personsOfInterestarrayPeople connected to the requested record.
instructionsstringResearch notes, date ranges, register details, or scan requirements.
externalOrderRefstringYour case, cart, project, or customer order ID.
pricingModestringOPEN_FOR_BIDS or FIXED.
fixedPricenumberPrice when using fixed-price ordering.
currencystringThree-letter currency code.

​
Example

{
  "repositoryName": "Archives de Paris",
  "archiveRepositoryId": "FR-AD75",
  "countryISOA3": "FRA",
  "documentType": "Birth record",
  "location": "Paris, France",
  "pricingMode": "OPEN_FOR_BIDS",
  "externalOrderRef": "case-2026-001",
  "customerName": "Alex Martin",
  "personsOfInterest": [
    {
      "firstname": "Marie",
      "lastname": "Dupont"
    }
  ],
  "instructions": "Please retrieve a full-page scan if available. Target year is 1892."
}

​
Compatibility aliases

The API accepts these compatibility aliases:
Deprecated fieldPreferred field
archiveRepositoryNamerepositoryName
notesinstructions
Use the preferred fields in new integrations.

​
Idempotency

Order creation supports the Idempotency-Key header. If a request times out after the API receives it, retry the same request with the same idempotency key. The API can return the original result instead of creating a duplicate order.