com.shopify.mappers.LegacyToFulfillmentOrderMapping Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of shopify-sdk Show documentation
Java SDK for Shopify REST API.
There is a newer version: 2.9.3
package com.shopify.mappers;

import java.util.LinkedList;
import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.shopify.ShopifySdk;
import com.shopify.exceptions.ShopifyEmptyLineItemsException;
import com.shopify.model.ShopifyFulfillment;
import com.shopify.model.ShopifyFulfillmentOrder;
import com.shopify.model.ShopifyFulfillmentOrder.SupportedActions;
import com.shopify.model.ShopifyFulfillmentOrderLineItem;
import com.shopify.model.ShopifyFulfillmentOrderMoveLocationPayload;
import com.shopify.model.ShopifyFulfillmentOrderMoveRequestRoot;
import com.shopify.model.ShopifyFulfillmentOrderPayloadLineItem;
import com.shopify.model.ShopifyFulfillmentPayload;
import com.shopify.model.ShopifyFulfillmentPayloadRoot;
import com.shopify.model.ShopifyLineItem;
import com.shopify.model.ShopifyLineItemsByFulfillmentOrder;
import com.shopify.model.ShopifyTrackingInfo;
import com.shopify.model.ShopifyUpdateFulfillmentPayload;
import com.shopify.model.ShopifyUpdateFulfillmentPayloadRoot;

public class LegacyToFulfillmentOrderMapping {

	private static final Logger LOGGER = LoggerFactory.getLogger(LegacyToFulfillmentOrderMapping.class);

	/**
	 * creates the fulfillment order's tracking info based on a fulfillment
	 * shopify fulfillment order based creation does not support a list of
	 * tracking urls, so we're getting the first one of CA's list if available.
	 * Otherwise we just grab the single tracking url string
	 * 
	 * @param fulfillment
	 *            the fulfillment to be created by the fulfillment order api
	 * @return the payload's tracking info
	 */
	private static ShopifyTrackingInfo getFulfillmentTrackingInfo(final ShopifyFulfillment fulfillment) {
		final ShopifyTrackingInfo trackingInfo = new ShopifyTrackingInfo();
		if (fulfillment.getTrackingUrls().size() > 0) {
			trackingInfo.setUrl(fulfillment.getTrackingUrls().get(0));
		} else {
			trackingInfo.setUrl(fulfillment.getTrackingUrl());
		}
		trackingInfo.setNumber(fulfillment.getTrackingNumber());
		trackingInfo.setCompany(fulfillment.getTrackingCompany());

		return trackingInfo;
	}

	/**
	 * the idea here is to create a payload similar to what we
	 * have here, the resulting payload will be sent to shopify via the
	 * active ShopifySdk instance
	 * 
	 * @see ShopifySdk
	 * @see ShopifyFulfillmentOrderMoveRequestRoot
	 * 
	 * @param newLocation
	 *            the new location that the fulfillment order will be moved to
	 * @param fulfillmentOrder
	 *            the fulfillment order to be moved
	 * @return an ShopifyFulfillmentOrderMoveRequestRoot instance to be sent to
	 *         shopify
	 */
	public static ShopifyFulfillmentOrderMoveRequestRoot toShopifyMoveFulfillmentOrder(final String newLocation,
			ShopifyFulfillmentOrder fulfillmentOrder) {
		try {
			final ShopifyFulfillmentOrderMoveLocationPayload payload = new ShopifyFulfillmentOrderMoveLocationPayload();
			payload.setNewLocationId(newLocation);
			for (final ShopifyFulfillmentOrderLineItem fulfillmentOrderLineItem : fulfillmentOrder.getLineItems()) {
				payload.getFulfillmentOrderLineItems().add(new ShopifyFulfillmentOrderPayloadLineItem(
						fulfillmentOrderLineItem.getId(), fulfillmentOrderLineItem.getQuantity()));
			}

			ShopifyFulfillmentOrderMoveRequestRoot root = new ShopifyFulfillmentOrderMoveRequestRoot();
			root.setFulfillmentOrder(payload);
			return root;
		} catch (final Exception e) {
			LOGGER.error(
					"There was an error parsing fulfillmentOrder into a ShopifyFulfillmentOrder moveRequest payload",
					e);
			throw e;
		}
	}

	/**
	 * the idea here is to create a payload similar to what we
	 * have here, the resulting payload will be sent to shopify via the
	 * active ShopifySdk instance
	 * 
	 * we need to iterate through all fulfillmentOrder line items to determine
	 * which fulfillment order line items are going to be referenced inside the
	 * payload's line_items_by_fulfillment_order section
	 * 
	 * if a shopify fulfillment is cancelled a new fulfillment order is added
	 * the old one gets it's supported actions emptied, so we need to make sure
	 * the current fulfillmentOrder supportes fulfillment creation under it
	 * 
	 * @see ShopifySdk
	 * @see ShopifyFulfillmentPayloadRoot
	 * 
	 * @param fulfillment
	 *            the active fulfillment to be created/updated
	 * @param fulfillmentOrders
	 *            a list of fulfillment orders that are contained within the
	 *            order
	 * @return an ShopifyFulfillmentPayloadRoot instance to be sent to shopify
	 * @throws ShopifyEmptyLineItemsException
	 */
	public static ShopifyFulfillmentPayloadRoot toShopifyFulfillmentPayloadRoot(final ShopifyFulfillment fulfillment,
			final List fulfillmentOrders) throws ShopifyEmptyLineItemsException {
		final ShopifyTrackingInfo trackingInfo = getFulfillmentTrackingInfo(fulfillment);
		final ShopifyFulfillmentPayload payload = new ShopifyFulfillmentPayload();
		final List lineItemsByFulfillmentOrder = new LinkedList<>();

		// here we need to iterate through all fulfillmentOrder line items
		// to determine which fulfillment order line items are going to be
		// referenced inside the payload's line_items_by_fulfillment_order
		// section
		for (final ShopifyFulfillmentOrder fulfillmentOrder : fulfillmentOrders) {
			// if a shopify fulfillment is cancelled a new fulfillment order
			// is added the old one gets it's supported actions emptied, so
			// we need to make sure the current fulfillmentOrder supportes
			// fulfillment creation under it
			if (fulfillmentOrder.hasSupportedAction(SupportedActions.CREATE_FULFILLMENT)) {
				ShopifyLineItemsByFulfillmentOrder lineItemsByFulfillment = new ShopifyLineItemsByFulfillmentOrder();
				lineItemsByFulfillment.setFulfillmentOrderId(fulfillmentOrder.getId());
				for (final ShopifyFulfillmentOrderLineItem fulfillmentOrderLineItem : fulfillmentOrder.getLineItems()) {
					for (final ShopifyLineItem fulfillmentLineItem : fulfillment.getLineItems()) {
						if (fulfillmentOrderLineItem.getLineItemId().equals(fulfillmentLineItem.getId())) {
							ShopifyFulfillmentOrderPayloadLineItem payloadLineItem = new ShopifyFulfillmentOrderPayloadLineItem(
									fulfillmentOrderLineItem.getId(), fulfillmentLineItem.getQuantity());
							lineItemsByFulfillment.getFulfillmentOrderLineItems().add(payloadLineItem);
						}
					}
				}

				if (lineItemsByFulfillment.getFulfillmentOrderLineItems().size() > 0) {
					lineItemsByFulfillmentOrder.add(lineItemsByFulfillment);
				}
			}
		}
		if (lineItemsByFulfillmentOrder.size() < 1)
			throw new ShopifyEmptyLineItemsException();

		payload.setTrackingInfo(trackingInfo);
		payload.setNotifyCustomer(fulfillment.isNotifyCustomer());
		payload.setLineItemsByFulfillmentOrder(lineItemsByFulfillmentOrder);

		ShopifyFulfillmentPayloadRoot root = new ShopifyFulfillmentPayloadRoot();
		root.setFulfillment(payload);
		return root;
	}

	/**
	 * the idea here is to create a payload similar to what we
	 * have here, the resulting payload will be sent to shopify via the
	 * active ShopifySdk instance
	 * 
	 * @see ShopifySdk
	 * @see ShopifyUpdateFulfillmentPayloadRoot
	 * 
	 * @param fulfillment
	 *            the active fulfillment to have it's tracking information
	 *            updated
	 * @return an ShopifyFulfillmentPayloadRoot instance to be sent to shopify
	 */
	public static ShopifyUpdateFulfillmentPayloadRoot toUpdateShopifyFulfillmentPayloadRoot(
			final ShopifyFulfillment fulfillment) {
		try {
			final ShopifyTrackingInfo trackingInfo = getFulfillmentTrackingInfo(fulfillment);
			final ShopifyUpdateFulfillmentPayload payload = new ShopifyUpdateFulfillmentPayload();

			payload.setTrackingInfo(trackingInfo);
			payload.setNotifyCustomer(fulfillment.isNotifyCustomer());

			ShopifyUpdateFulfillmentPayloadRoot root = new ShopifyUpdateFulfillmentPayloadRoot();
			root.setFulfillment(payload);
			return root;
		} catch (final Exception e) {
			LOGGER.error("There was an error parsing fulfillmentOrder into a ShopifyFulfillment update payload", e);
			throw e;
		}
	}

}