Skip to main content

OnlineArrangements

Online Arrangements

This object represents an online arrangement initiated through a portal (e.g Parting Pro, eFuneral, etc.), including cart details and purchaser information.

Insert or update (upsert) an Online Arrangement

Uniqueness is determined based on a combination of the location unique identifier and the external ID. If a record with the same location unique identifier and external unique identifier already exists, the existing record will be updated. Otherwise, a new record will be created. New data is merged with existing data.

Parameters

location_unique_identifier
Requiredstring

The unique identifier of the funeral home's location where the arrangement is being made.

external_identifier
Requiredstring

The external identifier of this online arrangement, to enforce uniqueness.

person_full_name
Requiredstring

The full name of the person for whom the arrangement is being made.

person_phone_number
RequiredE164_string

The phone number of the person for whom the arrangement is being made, formatted as an E164 string (e.g. +14155552671).

cart_summary
Requiredstring

A breakdown of the cart. This can include whether the online arrangement is a burial/cremation. This can also include professional services, merchandise items, and/or cash advances, etc. This is a free-form text field for maximum flexibility.

additional_person_metadata
(optional)object

Additional metadata about the person for whom the arrangement is being made.

email_address
(optional)string

The person's email address.

mailing_address
(optional)string

The person's mailing address. This can include the street address, city, state, and zip code.

birth_date
(optional)ISO_8601_date_string

The birth date of the person.

gender
(optional)string

The person's gender.

additional_cart_metadata
(optional)object

Additional metadata about the cart.

cart_value_in_cents
(optional)number

The total monetary value of the cart (in cents).

cart_currency
(optional)string

The currency of the cart (required if cart_value_in_cents is provided, and only USD is supported at this time).

is_abandoned_cart
(optional)boolean

Indicates whether the cart has been abandoned.

additional_data
(optional)object

An arbitrary object containing any additional data not covered in person or cart.

Returns

A dictionary representing the created or updated online arrangement object.

POST
/v1/online_arrangements/upsert
curl -X POST https://api.mogulbridge.com/v1/online_arrangements/upsert \
-u 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: \
-H "Content-Type: application/json" \
-d '{
  "location_unique_identifier": "loc_igEkIq05KFm4JDSNbneAN",
  "external_identifier": "arrangement-external-id-123",
  "person_full_name": "John Doe",
  "person_phone_number": "+14155552671",
  "cart_summary": "Cremation, Basic Urn, Memorial Service",
  "additional_person_metadata": {
    "email_address": "john.doe@example.com",
    "mailing_address": "123 Elm St, Springfield, IL 62704",
    "birth_date": "1980-05-10",
    "gender": "Male"
  },
  "additional_cart_metadata": {
    "cart_value_in_cents": 120000,
    "cart_currency": "USD",
    "is_abandoned_cart": true
  },
  "additional_data": {
    "away_from_home_insurance": true
  }
}'
RESPONSE
{
  "object": "online_arrangement",
  "external_identifier": "arrangement-external-id-123",
  "inserted_at": "2024-01-15T15:30:52Z",
  "location_unique_identifier": "loc_igEkIq05KFm4JDSNbneAN",
  "person_full_name": "John Doe",
  "person_phone_number": "+14155552671",
  "cart_summary": "Cremation, Basic Urn, Memorial Service",
  "additional_person_metadata": {
    "email_address": "john.doe@example.com",
    "mailing_address": "123 Elm St, Springfield, IL 62704",
    "birth_date": "1980-05-10",
    "gender": "Male"
  },
  "additional_cart_metadata": {
    "cart_value_in_cents": 120000,
    "cart_currency": "USD",
    "is_abandoned_cart": true
  },
  "additional_data": {
    "away_from_home_insurance": true
  },
  "unique_identifier": "oa_H1NfdrAkeLTQ3VojW6sKz",
  "updated_at": "2024-01-15T15:35:25Z"
}