Bulk

Start a full catalog export (async job)

Starts an export of the diamonds, engagement ring, or jewelry catalog with the same filters the list endpoint accepts, and answers 202 Accepted with a Location header pointing at the job's status URL. Exports complete within seconds: poll status_url (honouring Retry-After) until status is succeeded, then download result_url. Job ids are self-contained signed tokens valid for 24 hours; there is nothing to cancel.

post/api/v1/exports

Request

  • Base URL: https://www.adadiamonds.com
  • URL: https://www.adadiamonds.com/api/v1/exports
  • Auth: one of:
    • none
    • API key in header X-Ada-Api-Key
    • OAuth 2 (authorization code, authorization URL https://www.adadiamonds.com/oauth/authorize, token URL https://www.adadiamonds.com/api/oauth/token; client credentials, token URL https://www.adadiamonds.com/api/oauth/token, scopes: catalog:read)

Request body

type'diamonds' | 'engagement-rings' | 'jewelry' required
format'jsonl' | 'json'

jsonl streams one product per line; json returns one array.

filtersobject

Same query keys as the matching list endpoint (e.g. shape, min_price). Unknown keys are ignored.

Example request

{
  "filters": {
    "shape": "Oval",
    "max_price": 5000
  }
}

Response

The export job was accepted. Poll the Location URL.

object'job' required
idstring required

Opaque signed job id. Valid for 24 hours.

type'export' required
status'queued' | 'succeeded' required
progressinteger
status_urlstring uri required
result_urlstring uri nullable

Set once status is succeeded.

created_atstring date-time required
completed_atstring date-time nullable
expires_atstring date-time required
notestring

Changes

No recorded changes to this operation across all 1 revision of this API.