# Ometria developer docs Documentation

> Documentation for Ometria developer docs

Append .md to any documentation page URL to get its markdown version.

## Guides
- [Ometria API introduction](https://docs.ometria.com/docs/ometria-data-api-introduction.md)
- [Orders](https://docs.ometria.com/docs/orders-endpoint.md)
- [GDPR data anonymisation](https://docs.ometria.com/docs/gdpr-data-anonymisation.md)
- [Merge profiles](https://docs.ometria.com/docs/merge-profiles.md)
- [Transactional email API](https://docs.ometria.com/docs/transactional-email-api.md)
- [JavaScript tracker](https://docs.ometria.com/docs/javascript-tracker.md)
- [Setting tags for overlays](https://docs.ometria.com/docs/setting-tags-for-overlays.md)
- [Google tag manager](https://docs.ometria.com/docs/google-tag-manager.md): How to integrate Google tag manager with your Ometria JavaScript tracker
- [Getting started with website personalisation](https://docs.ometria.com/docs/getting-started-with-website-personalisation.md): Key concepts for getting to grips with Ometria's Web Personalisation feature
- [Elements](https://docs.ometria.com/docs/elements.md)
- [Best practices](https://docs.ometria.com/docs/best-practices.md)
- [Front end integration overview](https://docs.ometria.com/docs/front-end-integration-overview.md): Decide which integration method is right for your brand
- [Website personalisation: Sending data to Ometria](https://docs.ometria.com/docs/website-personalisation-sending-data-to-ometria.md)
- [Website personalisation: JavaScript integration](https://docs.ometria.com/docs/website-personalisation-javascript-integration.md)
- [CORS](https://docs.ometria.com/docs/cors.md): Website personalisation: JavaScript integration
- [Website personalisation tag options](https://docs.ometria.com/docs/website-personalisation-tag-options.md): Website personalisation: JavaScript integration
- [Autocomplete API](https://docs.ometria.com/docs/autocomplete-api.md): Website personalisation: JavaScript integration
- [Query API](https://docs.ometria.com/docs/query-api.md): Website personalisation: JavaScript integration
- [Product detail page](https://docs.ometria.com/docs/product-detail-page.md): Website personalisation: JavaScript integration
- [Tracking API](https://docs.ometria.com/docs/tracking-api.md): Website personalisation: JavaScript integration
- [Privacy and GDPR](https://docs.ometria.com/docs/privacy-and-gdpr.md): Website personalisation: JavaScript integration
- [Website personalisation: Headless API integration](https://docs.ometria.com/docs/website-personalisation-headless-api-integration.md)
- [Access and authentication](https://docs.ometria.com/docs/access-and-authentication.md): Website personalisation: Headless API integration
- [Headless Query API reference](https://docs.ometria.com/docs/headless-query-api.md): Website personalisation: Headless API integration
- [Headless Query API examples](https://docs.ometria.com/docs/headless-query-api-examples.md): Website personalisation: Headless API integration
- [Headless Query API JSON response](https://docs.ometria.com/docs/headless-query-api-json-response.md): Website personalisation: Headless API integration
- [Headless tracking API reference](https://docs.ometria.com/docs/headless-tracking-api-reference.md): Website personalisation: Headless API integration
- [Website personalisation: Templating](https://docs.ometria.com/docs/website-personalisation-templating.md)
- [Website personalisation template functions](https://docs.ometria.com/docs/website-personalisation-template-functions.md): Website personalisation: Templating
- [Templating objects](https://docs.ometria.com/docs/templating-objects.md): Website personalisation: Templating
- [Templating tags](https://docs.ometria.com/docs/templating-tags.md): Website personalisation: Templating
- [Templating filters](https://docs.ometria.com/docs/templating-filters.md): Website personalisation: Templating

## API Reference
- [Push objects](https://docs.ometria.com/reference/post_push.md): Accepts a list of up to 100 records of any of the accepted types: contact, custom event, product, profile or order
- [List errors](https://docs.ometria.com/reference/get_push-errors.md): Return a list of the 100 latest push record errors
- [List Products](https://docs.ometria.com/reference/get_products.md): Return a list of products with optional filters
- [Get Product](https://docs.ometria.com/reference/get_products-product-id.md): Return a single Product item
- [List Orders](https://docs.ometria.com/reference/get_orders.md): List orders with optional filters
- [Get Order](https://docs.ometria.com/reference/get_orders-order-id.md): Return a single Order item
- [List Collections](https://docs.ometria.com/reference/get_contacts.md): List contact collections along with counts of records in each collection
- [List Contacts](https://docs.ometria.com/reference/get_contacts-collection.md): List Contacts in Collection with optional filters
- [Get Contact listing](https://docs.ometria.com/reference/get_contacts-collection-contact-id.md): Return a single Contact record
- [Returns a list of custom events](https://docs.ometria.com/reference/get_custom-events.md): Returns a list of custom events
- [Returns a list of custom events of a specific type](https://docs.ometria.com/reference/get_custom-events-event-type.md): Returns a list of custom events of a specific type
- [Returns a specific custom event](https://docs.ometria.com/reference/get_custom-events-event-type-event-id.md): Returns a specific custom event
- [Fetch list of profiles](https://docs.ometria.com/reference/get_profiles.md): Return profiles as a JSON array
- [Fetch individual profile](https://docs.ometria.com/reference/get_profiles-profile-id.md): Return profile as a JSON object
- [Merge profiles based on the provided identifiers.](https://docs.ometria.com/reference/post_merge-profile.md): Merge customers_to_merge profiles into the survivor profile. Identifiers supplied here can be any identifier defined in your account's identity resolution configuration (e.g. `customer_id`, `profile_hash`, `email_address`, `phone_number`, or any custom extra identifier such as `loyalty_id`), as well as `profile_id` — the ID (hash) of the profile (e.g. `27f4-8337f0-002384af`).
- [Get the status of merge jobs.](https://docs.ometria.com/reference/get_merge-profile.md): Get the status of merge jobs.
- [Get the status of a specific merge job.](https://docs.ometria.com/reference/get_merge-profile-job-id.md): Get the status of a specific merge job.
- [List Lists](https://docs.ometria.com/reference/get_lists.md): Fetch list of Lists (saved segments)
- [Get List](https://docs.ometria.com/reference/get_lists-list-id.md): Get specific List item by ID
- [Get List Changes](https://docs.ometria.com/reference/get_lists-list-id-changes.md): Return the list_enter and list_exit events for a specific list since a specified date
- [Fetch List members](https://docs.ometria.com/reference/get_lists-list-id-contacts.md): Return contacts in the list as a JSON array
- [Export List members](https://docs.ometria.com/reference/get_lists-list-id-contacts-export.md): Return contacts in the list as line delimited (separated by "\n") JSON objects, suitable for streaming
- [Send Transactional Email](https://docs.ometria.com/reference/post_transactional-email-send.md): Send a transactional email
- [Receive unsubscribe events within a given time range, across both email and SMS channels.](https://docs.ometria.com/reference/get_unsubscribes.md): Email   The following unsubscribe types are available via the endpoint:  Preferences centre  App  List unsubscribe — when the contact clicks the "unsubscribe" button in their email client.  Link unsubscribe — when the contact clicks a link formatted for Ometria to recognise.  SMS  Two types are available via the endpoint:  stopword_unsubscribe_TF — unsubscribe via a stop word in an automation campaign. stopword_unsubscribe_DO — unsubscribe via a stop word in double opt-in message.  Not available via the endpoint  API unsubscribes are not available through this endpoint, for either email or SMS.
- [List GDPR related data anonymisation requests](https://docs.ometria.com/reference/get_data-deletion-requests.md): Returns previously filed GDPR related data anonymisation requests and their status.
- [Create new GDPR data anonymisation request](https://docs.ometria.com/reference/post_data-deletion-requests.md): Create new or update an existing order
- [Get details of specific GDPR related data anonymisation request](https://docs.ometria.com/reference/get_data-deletion-requests-id.md): Returns details and status of GDPR related data anonymisation request by its ID.
- [List Custom Fields](https://docs.ometria.com/reference/get_custom-fields.md)
- [Create Custom Field](https://docs.ometria.com/reference/post_custom-fields.md)
- [Update Custom Field](https://docs.ometria.com/reference/put_custom-fields.md)
- [Delete Custom Field](https://docs.ometria.com/reference/delete_custom-fields-category-id.md)
- [List translation requests.](https://docs.ometria.com/reference/get_translations-requests.md)
- [Get translation request details.](https://docs.ometria.com/reference/get_translations-requests-request-id.md)
- [Get translation request template preview in source language.](https://docs.ometria.com/reference/get_translations-requests-request-id-preview.md)
- [Submit a translation for a pending translation request.](https://docs.ometria.com/reference/post_translations-submit.md)
- [List field forget requests](https://docs.ometria.com/reference/get_field-forget.md): Returns previously filed field forget requests for your account and their status, newest first (by `timestamp_created`). Requests made from the Ometria app are included, with `source.origin` set to `app`.  Page with `limit` and `offset`; `total_count` is the number of requests for the account.
- [Create new field forget request](https://docs.ometria.com/reference/post_field-forget.md): Erase a profile's `email` and/or `phone` while keeping the rest of the profile. For each requested field, Ometria clears the value on the profile. Nothing prevents the same value being added back to this profile later either.  `profile_hash` is the `id` of a profile, as returned by `GET /profiles/`.  Requests are processed asynchronously. A `202` means the request was accepted and queued; poll `GET /field-forget/{id}` until `status` is terminal. A request identical to one that is still `pending` or `in_progress` and less than 24 hours old returns the existing request's `id` (still `202`) rather than creating a new one, so retries are safe. Once a request has reached a terminal status, a new request for the same profile and fields is accepted again.
- [Get details of specific field forget request](https://docs.ometria.com/reference/get_field-forget-id.md): Returns details and status of a field forget request by its ID. Poll this endpoint after `POST /field-forget` until `status` is one of `completed`, `aborted_sole_identifier`, `not_found` or `failed`.

## Recipes
- [Check errors based on request ID](https://docs.ometria.com/recipes/check-errors-based-on-request-id.md)
- [Custom events | Back in stock](https://docs.ometria.com/recipes/custom-events-back-in-stock.md)
- [Custom events | Sending a gift voucher to an unknown recipient](https://docs.ometria.com/recipes/custom-events-sending-a-gift-voucher-to-an-unknown-recipient.md)
- [Custom events | Wish list](https://docs.ometria.com/recipes/custom-events-wish-list.md)
- [How to add a contact to/remove them from a segment/list](https://docs.ometria.com/recipes/how-to-add-a-contact-toremove-them-from-a-segmentlist.md)
- [How to add additional prices to a product](https://docs.ometria.com/recipes/how-to-add-additional-prices-to-a-product.md)
- [How to change a contact's email address with customer_ID](https://docs.ometria.com/recipes/how-to-change-a-contacts-email-address-with-customer_id.md)
- [How to merge a product](https://docs.ometria.com/recipes/how-to-merge-a-product.md)
- [How to merge contact record](https://docs.ometria.com/recipes/how-to-merge-contact-record.md)
- [How to override a contact's subscription preference](https://docs.ometria.com/recipes/how-to-override-a-contacts-subscription-preference.md)
- [How to pair recommended products](https://docs.ometria.com/recipes/how-to-pair-recommended-products.md)
- [How to pass a custom field into Ometria](https://docs.ometria.com/recipes/how-to-pass-a-custom-field-into-ometria.md)
- [How to process a cancelled order](https://docs.ometria.com/recipes/how-to-process-a-cancelled-order.md)
- [How to process a full refund](https://docs.ometria.com/recipes/how-to-process-a-full-refund.md)
- [How to process a partial refund](https://docs.ometria.com/recipes/how-to-process-a-partial-refund.md)
- [How to process an order with a cancelled line item](https://docs.ometria.com/recipes/how-to-process-an-order-with-a-cancelled-line-item.md)
- [JavaScript tracker: Identifying visitors ](https://docs.ometria.com/recipes/javascript-tracker-identifying-visitors.md)
- [Retrieve contacts that unsubscribed using their email client](https://docs.ometria.com/recipes/retrieve-contacts-that-unsubscribed-using-their-email-client.md)
- [SMS double opt-in](https://docs.ometria.com/recipes/sms-double-opt-in.md)