Cart Integration

CelebrationIQ offers an API that allows 3rd party e-commerce websites to integrate with CelebrationIQ digital storefronts. Integration requires a CelebrationIQ subscription, configuration within the Admin, and development work to integrate the e-commerce website with CelebrationIQ's cake customization and ordering features.

API Documentation

API Documentation can be found at https://api.decopactech.com

Best Practices

  • Lead times for cakes ordered through CelebrationIQ should be posted on the e-commerce website, letting consumers know how long their cake will take before linking over to CelebrationIQ.
  • The e-commerce website's cart should have a separate order item (2 of 2) for the cake order if the lead time will be different. This should clearly show the different pickup type and time.

Prerequisites

  • E-commerce website must have a CelebrationIQ website. Terms of Use must be accepted to activate the site.
  • E-commerce website must provide order information to support CelebrationIQ and consumers.
  • CelebrationIQ has to enable cart integration with a link to the e-commerce website.
  • E-commerce website has to update consumer order requests from CelebrationIQ.
  • E-commerce website has to call CelebrationIQ APIs to get order information.
  • Authentication token is confidential; please DO NOT DISCLOSE.

Order Flow Transitions in CelebrationIQ Admin

The flow chart below shows the order transition in the CelebrationIQ Admin. The order states shown are Pending, Closed, New, Accepted, Expired and Canceled.

Flow Chart

The following transitions will take place on the CelebrationIQ website and in the CelebrationIQ Admin:

  • Consumer follows the link that is provided on the e-commerce website to navigate to the CelebrationIQ website.
  • Consumer orders a cake successfully on the CelebrationIQ website.
  • Consumer checks out on the e-commerce website successfully.
  • Consumer is late to check out on the e-commerce website.
  • Consumer removes their cake order from the e-commerce website.
  • Owner accepts the order in the CelebrationIQ Admin.
  • Owner is late to accept the order in the CelebrationIQ Admin.
  • Owner denies the order in the CelebrationIQ Admin.

Cart Order Flow

Green: Consumer is on CelebrationIQ website.
Blue: Consumer is on the e-commerce website.

Order Flow Map

Notes:

  • A consumer has to start from an e-commerce website to be part of the cart integration experience. Otherwise, the consumer's order will not be included in their e-commerce shopping cart.
  • A consumer in the cart integration experience can go back to the e-commerce website anytime by clicking a link at the top of the CelebrationIQ website. This link will need to be activated in the CelebrationIQ Admin.
  • The cart integration experience is almost identical to the standard CelebrationIQ experience. Consumers can shop for a cake, customize it and complete their order. Consumers will still have to select a pick-up date that is dependent on the lead time entered in the CelebrationIQ Admin.
  • The main difference in the Cart integration experience is that on the Pickup page, the consumer will be brought back to the e-commerce website after completing their cake order. The order is created with a “pending” status. It can’t be accepted/rejected in Admin while in pending status.
  • The Order ID will be sent to the e-commerce website and will be used to get the cake order information once the consumer returns to the e-commerce website. The API to get the order detail will be described in the API list.
  • The e-commerce website has to maintain the cake order status and requests update the CelebrationIQ order statuses in the following scenarios:
    • The consumer is able to delete their cake order from their e-commerce shopping cart. This will update the order status to “Closed” in the CelebrationIQ Admin.
    • After the consumer completes the payment process in the e-commerce shopping cart, the e-commerce website has to notify CelebrationIQ that the order has been updated. This will update the order status to “New” in the CelebrationIQ Admin.

4. Notification system – CelebrationIQ only

Cart integration uses the current CelebrationIQ notification series including email and text messaging.
  • After an order placed successfully.
  • After an order is accepted by the owner in the CelebrationIQ Admin.
  • After an order is rejected by the owner in the CelebrationIQ Admin.
  • After the owner clicks the "Ready for Pickup" button in the CelebrationIQ Admin.

URL Parameters

5.1 From the e-commerce website to CelebrationIQ Website:

Example: https://order.dqa.decopac.com/pbc/sprinkles-bling-bakery?referrer_name=Sandbox%20Shop&shopper_id=864654&shopper_cart_id=C7867&shopper_name=Scott%20Fillman&locale=en_us&region=us&shopper_phone=5555555555&shopper
_email=customer%40example.com&return_url=https%3A%2F%2Fwww.bakerytechs.net%2Fcart

Parameter Required/Optional Description Example Value
referrer_name Optional Name of referring website, used for link back to site in banner, indicates bakery wants the banner to show Sandbox%20Shop
shopper_id Optional Unique identifier for shopper from customer’s systems (if they are logged in or have a cookie set, for example) 6798678
shopper_cart_id Optional If a user has a cart started on customer’s e-commerce website (if they are logged in) C876678
shopper_name Optional The full name of the shopper coming from the customer’s website (if they are logged in) Saul%20Goodman (URL encoded)
locale Required The language the user will experience on the CelebrationIQ website (en_us/es_mx/fr_ca) es_mx
region Required The region of the customer’s pickup location gb
shopper_phone Optional The shopper’s phone number without region code - will be added based on region param (if they are logged in) 5555555555
shopper_email Optional The shopper’s email address (if they are logged in) customer%40example.com (URL encoded)
return_url Required The URL the shopper should be redirected to after the order is submitted on CelebrationIQ, if store URL is set on admin then the link to the Ecommerce website will use it instead of its value on the session https%3A%2F%2Fwww.bakerytechs.net%2Fcart (URL encoded)

5.2 From the CelebrationIQ Website to the e-commerce Website

Example: https://craftcompany.co.uk?shopper_id=864654&shopper_cart_id=C7867&cake_order_id=987987&region=us&locale=en_us

Parameter Required/Optional Description Example Value
shopper_id Optional Unique identifier for shopper from customer’s systems (if they are logged in or have a cookie set, for example) 6798678
shopper_cart_id Optional If a user has a cart started on customer’s e-commerce system (if they are logged in) C876678
locale Required The language the user will experience on CelebrationIQ (en_us/es_mx/fr_ca) es_mx
region Required The region of the customer’s pick up location gb
cake_order_id Required The order ID from the order table in the CelebrationIQ DB 1237643