API reference

Restrict to these categories. Categories your rules do not cover simply match nothing.

Lowest price.listingPrice to include — decimal, in the response currency, inclusive.

Highest price.listingPrice to include, same units, inclusive.

Restrict to pieces containing ANY of these metals.

Restrict to these primary stones. none selects pieces without a stone.

Restrict to natural or lab-grown stones.

Restrict to pieces tagged with ANY of these occasions.

Restrict to these audiences.

1-based. A page past the end returns an empty data and the same total, not an error.

Products per page. Fifty is the ceiling; the response echoes what applied.

The current contents of the feed.

The request body did not validate. Unknown fields are rejected rather than ignored — a silently dropped filter would let you believe it applied.

Missing, malformed, unknown, or revoked key — all four answer identically, on purpose. The remedy is the same in every case: check the key, or rotate it.

Your DYJ plan is not live. The feed resumes the moment it is.

No such feed, or not yours, or disabled. Merged deliberately: an authenticated stranger must not be able to learn that a feed id exists.

Too many requests for this key. Limits are per key, not per IP, so adding servers does not add quota. Back off and retry; a full catalogue sync should page steadily rather than fan out.

The product, in the same envelope as search minus the pagination.

Missing, malformed, unknown, or revoked key — all four answer identically, on purpose. The remedy is the same in every case: check the key, or rotate it.

Your DYJ plan is not live. The feed resumes the moment it is.

No such product in this feed. Returned for an unknown id, a product outside your feed, and a delisted one alike.

Too many requests for this key. Limits are per key, not per IP, so adding servers does not add quota. Back off and retry; a full catalogue sync should page steadily rather than fan out.

Serving.

Restrict to these categories. Categories your rules do not cover simply match nothing.

Lowest price.listingPrice to include — decimal, in the response currency, inclusive.

Highest price.listingPrice to include, same units, inclusive.

Restrict to pieces containing ANY of these metals.

Restrict to these primary stones. none selects pieces without a stone.

Restrict to natural or lab-grown stones.

Restrict to pieces tagged with ANY of these occasions.

Restrict to these audiences.

1-based. A page past the end returns an empty data and the same total, not an error.

Products per page. Fifty is the ceiling; the response echoes what applied.

The currency of every amount in the response, stated once. EUR is the only currency in v1, so rate is 1; the block exists so a second currency can arrive without the shape of a product changing.

The currency of every amount in the response, stated once. EUR is the only currency in v1, so rate is 1; the block exists so a second currency can arrive without the shape of a product changing.

The page this response is.

The page size that applied — what you asked for, clamped to the ceiling.

How many products the feed selects in all, after your filters — the number behind "page 3 of 7". Membership is live, so it can change between two pages of one walk; see the sync guide for how to read a walk whose total moved.

ISO 4217 code.

Against EUR, the platform's base currency. 1 while EUR is the only currency served.

When rate was last set.

What DYJ charges you to produce this piece. Your cost, not a recommended price.

Your selling price, computed from listingPrice by the margin schedule of the first of your rules that matches this piece:

total = round_half_up(listing × (1 + percent/100)) + addon

DYJ never charges it — it exists so your store and your dashboard agree without you recomputing anything.

Reserved. Always 0 for now; a future discount will be subtracted from totalPrice here.

totalPrice converted to EUR at currency.rate. Equal to totalPrice while EUR is the only currency.

Terms for DYJ listingPrice only, not your shopper tax/shipping policy. Null on legacy offers; quote_required is not a final delivered total.

Confirmed purity in parts per thousand; 750 means 18K gold, 925 sterling silver.

Approximate metal weight for the complete sale unit at sizing.referenceOptionId. Null means unknown.

Confirmed stone body color, such as white, teal, or champagne. Custom color labels remain supported. Null or absent means unknown; color does not imply natural or lab-grown origin.

Number supplied in this group across the complete sale unit, including both pieces of a pair.

Confirmed total for the group across the sale unit; never a per-stone weight. Null means unknown.

Individual stone dimensions, only when they apply to every stone in the group.

Optional label identifying a piece in an asymmetric pair or set.

Atelier estimate after payment and final specification confirmation, excluding shipping transit. min is no greater than max.

Stable identifier for this product. Use it as your own catalogue key.

Stable public Marketplace reference, distinct from the creator's internal catalog reference. Never changes on reapproval.

Reviewed specification version; null on legacy products. A price-only update keeps this version while updatedAt advances.

Confirmed materials, or null when no structured specification has been reviewed.

Supplied homogeneous stone groups. Null means no reviewed information; [] confirms stone-free. Request stones/stoneOrigins filters still select the primary stone only.

Exactly what the atelier supplies. An illustrative center stone absent here and from stones is not included.

Free text from the designer, e.g. "18k white gold".

Every metal in the piece; a two-tone ring lists two.

The primary stone; none for a piece without one.

none exactly when stone is none.

Zero or more. Empty when the designer did not say.

Decimal amounts in the response's currency. Confidential to your account — no designer and no other business sees them.

The product gallery, in display order. Each URL is a stable public image URL: it carries no key, is cacheable (immutable — a changed image gets a new URL), and is safe to place in an <img src> on your store as-is. Whether the product is still yours to sell is answered by this API, not by the image, so keep syncing. Empty when the designer has not added gallery images.

The per-product half of the interactive 3D view, or null when your account has no viewer key yet. The other half — your PUBLIC dyj_live_ key and the viewer script tag — is the same for every product and comes from your dashboard (My Account → Developer, or any embed code there). Together:

html <div class="dyj-viewer" data-license-key="{your public key}" data-config-url="{configUrl}" data-poster-url="{posterUrl}"></div> <script async src="{viewer script URL from your dashboard}"></script>

Omit the data-poster-url attribute when posterUrl is null; printed unguarded it becomes the literal "null", a request for an image by that name. Photo and poster URLs change when a reviewed gallery is approved, so render them from each sync rather than hard-coding them.

The view works only on the domains registered under My Account → Developer, and only while this product is in one of your feeds. When it leaves (delisted, blocked, no longer matching your rules) the tag shows the poster with a neutral notice — never an error, never a broken box.

Product configuration for the viewer. Carries your public key already; use verbatim.

Still image shown before the 3D view loads (and instead of it when unavailable). A stable public image URL like the gallery's: no key, cacheable. null when the designer's published version has no poster — use the first photo, or omit the data-poster-url attribute.

A stable machine-readable code. Branch on this, not on the message.

Human-readable. May be reworded without notice.