twigfiddle.com - Fixing Gallery Products with Duplicate SKUs in OrderDesk

File

{# TWIG SCRIPTS USED IN ORDERDESK RULE "Gallery 03 - Parse _gallery JSON into individual product details (RELEASE)" #}
{# ASSUMPTIONS:
	-This script is evaluated in the context of a single order item in OrderDesk
	-The script can access the order object to which the order item belongs
	-This allows the script to reference other order items in the same order
	-The current order item has the following attributes based on the OrderDesk Rule Engine:
		-Has data in item.metadata._gallery
		-item.metadata._isGallery = TRUE
		-item.metadata._galleryBundleId = Shopify lineItem ID
		-item.metadata._galleryProcessed = FALSE
#}
{# STRATEGY:
	- On Order Import to OrderDesk, OrderDesk will replace each Gallery product with
		separate order items (line items) for each of the frames in the gallery.
	- This code executes as part of an "order item rule" in OrderDesk that only fires on
		order items that were originally part of a gallery bundle.
	- Since a customer may purchase more than one gallery product in a single checkout, we
		start by finding the original Shopify Line Item ID of the current order item, which uniquely
		identifies the specific gallery product in the customer's order to which the current
		order item belongs.
	- These "Sibling" order items (aka the un-bundled items from the gallery) are collected
		in the object "gallerySiblings", which is composed of key:value pairs like this:
			Format: {"orderItem.id": "orderItem.code",...}
			Example: {"123456": "PF-FR-WYT-BK-810-57",...}
		where "orderItem.id" is the Order Desk Order Line Item Unique ID (fieldname: order[*].item[*].id)
		and "orderItem.code" is the Product Variant Sku passed from Shopify (fieldname: order[*].item[*].code)

	- Shopify products sync to OrderDesk every hour and carry over various fulfillment-related metafields.
		For Gallery products, the Shopify Metafield that stores the array of SKUs in the order they appear
		in the Gallery is metafields.variant.inventory.orderdesk_code_replace (example: 'PF-FR-WYT-BK-1620-1114
		,PF-FR-WYT-BK-810-57,PF-FR-WYT-BK-1114-810,PF-FR-WYT-BK-1114-810,PF-FR-WYT-BK-1620-1114,PF-FR-WYT-BK-810-57').
	- Because the Shopify line item variant had this metafield attached when imported to OrderDesk, it is copied
		to each de-bundled OrderDesk order item and so it can be referenced on each order item. It is defined
		in this snippet as "budleSkusOrder" and looks like this:
			Format: {"index": "SKU",...}
			Example: {"0": "PF-FR-WYT-BK-1620-1114", "1": "PF-FR-WYT-BK-810-57",...}

	- By looping through bundleSkusOrder, and in each iteration also looping through gallerySiblings, we update
		a third array called galleryLookup that relates the OrderDesk Order Item ID to it's "index" within the gallery.
		The Index is the position within the Gallery and by convention starts in the top-left at index = 0
		and increments with each frame in a clockwise direction. The galleryLookup object looks like this:
			Format: { "[order.order_items.id]": "[index of framed-print within Gallery]",...}
			Example: {"12345": "2", "223634": "0",...}

	- The Gallery Data JSON (OrderDesk: order.item.metadata._gallery; Shopify: order.lineItem.properties._gallery)
		is then parsed in order to find the nested framed-print data object with a value for "_index"
		that matches the galleryLookup.value where galleryLookup.key = [The current order item being evaluated]

	- In this way, the script takes the entire Gallery's worth of line item data and parses out only the nested
		data object containing the line item data for the OrderDesk Order Item currently being evaluated.
#}

{# DEFINITIONS #}
{# For execution in ORDERDESK #}
	{# {% set currentItemId = id %}
	{% set currentItemCode = code %}
	{% set currentItemVariations = variation_list %}
	{% set currentItemMetadata = metadata %} #}
{# For execution in TWIGFIDDLE #}
	{% set orderItemTestIndex = 0 %}
	{% set currentItem = order.order_items[orderItemTestIndex] %}
	{% set currentItemId = currentItem.id %}
	{% set currentItemCode = currentItem.code %}
	{% set currentItemVariations = currentItem.variation_list %}
	{% set currentItemMetadata = currentItem.metadata %}
{# For all contexts #}
	{% set currentOrder = order %}
	{% set currentOrderId = currentOrder.id %}
	{% set currentOrderMetadata = currentOrder.order_metadata %}
	{% set currentItemGalleryId = currentItemMetadata._galleryBundleId %}
	{% set bundleSkus = currentItemMetadata.orderdesk_code_replace %}

{#
	Set Variables to loop through Order Items to find Gallery products
		and then to loop through each Gallery product's individual products
		orderItemGalleryItemIndex = Current Order Item Index when Gallery Product is encountered
		galleryObjectCount = total number of gallery items found
#}

{# 	SCRIPT VARIABLES #}
{% set bundleSkusOrder = {} %} {# contains ordered list of Gallery item SKUs #}
{% set gallerySiblings = {} %} {# contains all order items that were de-bundled from the same Gallery #}
{% set galleryLookup = {} %} {# contains the index of each Sibling order item in the Gallery Data JSON #}
{% set matchedItemIds = [] %} {# contains Gallery items that have already been added to galleryLookup object #}
{% set orderItemGalleryItemIndex = -1 %} {# the index of the current order item in the Gallery Data JSON #}
{% set currentItemGalleryTileData = {} %} {# contains data returned to OrderDesk #}

{# Create bundleSkusOrder - An object containing an ordered list of each
	SKU in the Gallery Product #}
{% for bundleSku in bundleSkus|split(',') %}
	{% set bundleSkusOrder = bundleSkusOrder + {(loop.index-1): bundleSku} %}
{% endfor %}
{#~ DEBUG ~#}
	{{~ "VAR: bundleSkusOrder: " }}{{ bundleSkusOrder|json_encode()|raw -}}
{# END DEBUG #}

{# COLLECT GALLERY SIBLINGS -
	gallerySiblings is an object containing the order_item.id and order_item.code of
	each OrderDesk order item that was de-bundled from the Shopify line item that contained
	the gallery to which the current order item originally belonged #}

{# DEL #}{% set galleryObjectCounter = -1 %}
{# DEL #}{% set gallerySiblingsOld = {} %}

{% for orderItem in currentOrder.order_items %}
	{#~ DEBUG ~#}
		{# {{ "LOOP INDEX: " }}{{ loop.index -}} #}
	{# END DEBUG #}
	{% if orderItem.metadata['_isGallery'] == "TRUE" and orderItem.metadata['_galleryBundleId'] == currentItemGalleryId %}
{# DEL #}		{% set galleryObjectCounter = galleryObjectCounter + 1 %}
{# DEL #}		{% set galleryKey = galleryObjectCounter %}
{# DEL #}		{% set galleryItemId = orderItem.id %}
{# DEL #}		{% set gallerySiblingsOld = {(galleryKey): galleryItemId}+ gallerySiblingsOld %}
		{% set gallerySiblings = gallerySiblings + {(orderItem.id): orderItem.code} %}
		{# DEBUG #}
{# DEL {{ "VAR: galleryObjectCounter: " }}{{ galleryObjectCounter }} #}
{# DEL {{ "VAR: galleryKey: " }}{{ galleryKey }} #}
{# DEL {{ "VAR: galleryItemId: " }}{{ galleryItemId }} #}
			{# {{ "VAR: gallerySiblings: " }}{{ gallerySiblings|json_encode()|raw ~}} #}
		{#~ END DEBUG ~#}
	{% endif %}
{% endfor %}
{#~ DEBUG ~#}
{# DEL 	{{~ "END LOOP: Gallery Siblings" }} #}
{# DEL 	{{~ "VAR: galleryObjectCounter: " }}{{ galleryObjectCounter }} #}
	{{~ "VAR: gallerySiblings: " }}{{ gallerySiblings|json_encode()|raw }}
{# END DEBUG #}


{# BEGIN TEST LOGIC #}
{# Create galleryLookup - An object containing the OrderDesk order_item.id and the position index (itemOrder)
	of each order item within the Gallery product  #}
{% for itemOrder,targetSku in bundleSkusOrder %}
	{% set foundMatch = false %}
	{% for itemId,matchSku in gallerySiblings %}
		{% if foundMatch == false and matchSku == targetSku and itemId not in matchedItemIds %}
			{% set foundMatch = true %}
			{% set matchedItemIds = matchedItemIds|merge([itemId]) %}
			{% set galleryLookup = galleryLookup + {(itemId): itemOrder} %}
		{% endif %}
	{% endfor %}
{% endfor ~%}
{{~ "VAR: galleryLookup: " }}{{ galleryLookup|json_encode()|raw ~}}
{# END TEST LOGIC #}

{# DELETE THIS CODE  #}
	{% set gallerySiblingCount = gallerySiblingsOld|length %}
	{% set galleryLookupOld = {} %}
	{#~ DEBUG ~#}
		{# {{~ "START LOOP: galleryLookup" }}
		{{~ "VAR: gallerySiblingCount: " }}{{ gallerySiblingCount ~}} #}
	{# END DEBUG #}
	{% for i in 0..gallerySiblingCount-1 %}
		{#~ {% set galleryLookup = galleryLookup + {(gallerySiblings[i]): gallerySiblings[gallerySiblings[i]]} %} ~#}
		{% set galleryLookupOld = galleryLookupOld + {(gallerySiblingsOld[i]): i} %}
		{#~ DEBUG ~#}
			{# {{ "LOOP INDEX: " }}{{ loop.index ~}}
			{{ "VAR: gallerySiblings[" }}{{ i }}{{ "]: "}}{{ gallerySiblings[i] ~}}
			{{ "VAR: galleryLookup: " }}{{ galleryLookup|json_encode()|raw ~}} #}
		{# END DEBUG #}
	{% endfor ~%}
	{#~ DEBUG ~#}
		{# {{~ "END LOOP: galleryLookup" }}
		{{~ "VAR: galleryLookup: " }}{{ galleryLookup|json_encode()|raw ~}}
		{{~ "Gallery tile index for current line item: " }}{{ galleryLookup[currentItemId] ~}}
		{{~ "VAR: orderItemGalleryItemIndex: " }}{{ orderItemGalleryItemIndex ~}} #}
	{# END DEBUG ~#}
{{~ "VAR: galleryLookupOld: " }}{{ galleryLookupOld|json_encode()|raw ~}}
{# END DELETE #}
{# ************************************************************** #}

{# PARSE GALLERY DATA JSON FOR LINE ITEM PROPERTIES OF CURRENT ORDER DESK ORDER ITEM #}
{% set orderItemGalleryItemIndex = galleryLookup[currentItemId] %}
{% for variationKey,variationData in currentItemVariations %}
	{% if variationKey == "_gallery" %}
		{# DEBUG #}
			{# {{ "GALLERY DATA: " }}{{ variationData|raw }} #}
			{# {{ "GALLERY DATA: " }}{{ variationData|json_encode()|raw }} #}
			{# {{ "Tiles:" }} #}
		{# END DEBUG #}

		{# Loop through each tile of the gallery #}
		{% set galleryTiles = [] %}
		{% for tile in variationData|replace({'[{':'','}]':''})|split('},{') %}
			{% set tileProps = {} %}
			{% for tileProperty in tile|replace({"\\":''})|replace({',"':'|'})|replace({'"':''})|split('|') %}
				{# {{ tileProperty }} #}
				{% set propKey = tileProperty|split(':',2)[0]|raw %}
				{% set propValue = tileProperty|split(':',2)[1]|raw %}
				{% set tileProps = tileProps|merge({(propKey): propValue}) %}
				{#   {{ "Tile Props Encoded" }}{{ tileProps|json_encode()|raw }}#}
			{% endfor %}
			{#~ DEBUG ~#}
				{# {{ "Tile Props: " }}{{ tileProps|json_encode()|raw ~}} #}
				{# {{ "Tile Props Index: " }}{{ tileProps._index ~}} #}
			{# END DEBUG #}
			{% if tileProps._index == orderItemGalleryItemIndex %}
				{% set currentItemGalleryTileData = currentItemGalleryTileData|merge({tileProps}) %}
			{% endif %}
		{% endfor %}
	{% endif %}
{% endfor ~%}
{#~ DEBUG ~#}
	{# {{~ "FINAL OUTPUT: " ~}} #}
	{# {{~ " -Order Item Metadata: " }}{{ currentItemGalleryTileData.tileProps|json_encode()|raw }} #}
	{# {{~ " -_printerAsset: " }}{{ currentItemGalleryTileData.tileProps["_printerAsset"] ~}} ~#}
{# END DEBUG ~#}
{{- currentItemGalleryTileData.tileProps|json_encode()|raw -}}

Format

{
    "status": "success",
    "execution_time": "0.0398 seconds",
    "order": {
        "id": "305739577",
        "email": "mnpeart@gmail.com",
        "shipping_method": "Standard (4-10 business days)",
        "quantity_total": 6,
        "weight_total": 33.5,
        "product_total": 331.02,
        "shipping_total": 6.99,
        "handling_total": 0,
        "tax_total": 0,
        "discount_total": 327.69,
        "order_total": 10.32,
        "cc_number_masked": "",
        "cc_exp": "",
        "processor_response": "gift_card",
        "payment_type": "gift_card",
        "payment_status": "Approved",
        "processor_balance": 10.3,
        "refund_total": 0,
        "customer_id": "5369976258756",
        "email_count": "37",
        "ip_address": "24.6.147.101",
        "tag_color": "",
        "source_name": "Shopify",
        "source_id": "#12047",
        "fulfillment_name": "",
        "fulfillment_id": "",
        "tag_name": "",
        "folder_id": 230311,
        "pre