Skip to main content

​
GET /orders

Lists orders owned by the API client. Required scope: orders:read 
curl "$ARCHIVE_ORDER_BASE_URL/orders" \
  -H "Authorization: Bearer $ARCHIVE_ORDER_API_KEY"
Response: 
[
  {
    "id": "order_123",
    "status": "submitted",
    "order": {}
  }
]

​
POST /orders

Creates an order. Required scope: orders:write Request body:
FieldRequiredType
repositoryNameYesstring
documentTypeYesstring
locationYesstring
archiveRepositoryIdNostring
countryISOA3Nostring
pricingModeNoFIXED or OPEN_FOR_BIDS
fixedPriceNonumber
currencyNostring
externalOrderRefNostring
customerNameNostring
personsOfInterestNoarray
instructionsNostring
curl -X POST "$ARCHIVE_ORDER_BASE_URL/orders" \
  -H "Authorization: Bearer $ARCHIVE_ORDER_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "repositoryName": "Archives de Paris",
    "documentType": "Birth record",
    "location": "Paris, France"
  }'

​
GET /orders/{orderId}

Gets one order by ID. Required scope: orders:read 
curl "$ARCHIVE_ORDER_BASE_URL/orders/order_123" \
  -H "Authorization: Bearer $ARCHIVE_ORDER_API_KEY"

​
POST /orders/{orderId}/withdraw

Withdraws an order before fulfillment work starts. Required scope: orders:write 
curl -X POST "$ARCHIVE_ORDER_BASE_URL/orders/order_123/withdraw" \
  -H "Authorization: Bearer $ARCHIVE_ORDER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
Response: 
{
  "id": "order_123",
  "status": "withdrawn"
}