Skip to main content
The ArchiveOrder API is a JSON REST API.

​
Base URLs

EnvironmentBase URL
Productionhttps://api.archiveorder.com
Developmenthttps://api-dev.archiveorder.com

​
Authentication

All endpoints require: 
Authorization: Bearer <api_key>

​
Idempotency

Mutating endpoints support Idempotency-Key. Use idempotency keys for:
  • POST /orders
  • POST /orders/{orderId}/withdraw
  • POST /orders/{orderId}/offers/{offerId}/select
  • POST /orders/{orderId}/offers/{offerId}/decline
  • POST /orders/{orderId}/payments/initiate
  • POST /orders/{orderId}/payments/finalize
  • POST /orders/{orderId}/messages
  • POST /webhook-endpoints
  • DELETE /webhook-endpoints/{endpointId}

​
Endpoint groups

GroupEndpoints
OrdersCreate, list, inspect, and withdraw archive document orders.
OffersList, select, and decline researcher offers.
PaymentsInitiate, inspect, and finalize offer payments.
MessagesExchange order-specific messages.
DocumentsRetrieve delivered documents.
EventsRead order event history.
Webhook endpointsRegister and manage webhook delivery targets.