Pulling Orders from Shopify into ChannelApe Mapping

ChannelApe supports pulling orders into ChannelApe from Shopify, which can then be sent to your supplier(s) to be fulfilled. In order to be able to pull orders into your ChannelApe business, you must install and configure the Shopify integration. Once this is complete, you can set up a recipe to pull your Shopify orders directly into ChannelApe. Prior to reading this, you should be familiar with what a ChannelApe Order looks like.

ChannelApe only pulls orders from shopify that were placed within the last 7 days. If an order is older than that, ChannelApe will not able to perform this action on those orders.

When orders are pulled into ChannelApe, they are mapped in the following way:

Shopify OrderChannelApe Order

ChannelApe Field Shopify Field or Value
id N/A (Generated by ChannelApe)
channelOrderId id
status If the order doesn’t exist yet in ChannelApe:

  • If a Shopify order is canceled and has a canceled timestamp, ChannelApe creates the order with Canceled status
  • If a Shopify has a closedAt timestamp on the order, the ChannelApe creates the order with Closed status.
  • ChannelApe creates the order with Open Status

If the order does exist in ChannelApe and the order in ChannelApe is in OPEN, IN_PROGRESS, HOLD:

  • If a Shopify order is canceled and has a canceled timestamp, ChannelApe creates the order with Canceled status
  • If a Shopify has a closedAt timestamp on the order, the ChannelApe creates the order with Closed status.
  • Doesn’t touch status
purchaseOrderNumber name
purchasedAt created_at
canceledAt cancelled_at
canceledReason cancel_reason
totalPrice total_price
subtotalPrice subtotal_price
totalShippingPrice price on first item in shipping_lines if one is found. If not, it is left as null
totalShippingTax N/A
totalTax total_tax
totalGrams total_weight
alphabeticCurrencyCode currency

Shopify OrderChannelApe Order Additional Fields

Additional Field Key Shopify Field or Value
closed_at closed_at
number number
note note
token token
taxes_included taxes_included
financial_status financial_status
total_discounts total_discounts
total_line_items_price total_line_items_price
cart_token cart_token
buyer_accepts_marketing buyer_accepts_marketing
name name
referring_site referring_site
landing_site landing_site
cancelled_at cancelled_at
cancel_reason cancel_reason
user_id user_id
location_id location_id
browser_ip browser_ip
order_number order_number
processing_method processing_method
source_name source_name
fulfillment_status fulfillment_status
tags tags
order_status_url order_status_url
updated_at updated_at
Used to decide whether the ChannelApe order has the latest updates from Shopify. If this additional field is not present, the ChannelApe updatedAt field is used with a 2 hour grace period.
risk_recommendation When creating orders

This value is not updated during update of an order.

risk_message When creating orders

This value is not updated during the update of an order.

risk_merchant_message When creating orders

This value is not updated during the update of an order.

shipping_lines_title Created if the first shipping line has a title
shipping_lines_code Created if the first shipping line has a code
shipping_lines_source Created if the first shipping line has a source
note_attributes_* Iterates through each Shopify note attribute field and creates an additional field for each. Each additional field is prefixed with “note_attribute_”:

  • Shopify Note Attribute Name → “Gift Message”
  • Shopify Note Attribute Value → “Enjoy the shoes!”
  • Additional Field Name → “note_attribute_Gift Message”
  • Additional Field Value → “Enjoy the shoes!”
apple_pay transactions[n].receipt.apple_pay

  • If any of the orders transactions have a receipt with the apple pay flag set to true then this value will be true.
  • else false.
created_at created_at
processed_at processed_at

Shopify CustomerChannelApe Customer

ChannelApe Field Shopify Field or Value
name N/A
firstName first_name
lastName last_name
email email
phone phone

Shopify CustomerChannelApe Customer Additional Fields

ChannelApe Additional Field Shopify Field or Value
id id
accepts_marketing accepts_marketing
lastName last_name
orders_count orders_count
total_spent total_spent
note note
state state
shipping_address_company shipping_address_company
billing_address_company billing_address_company

Shopify Customer Shipping and Billing AddressesChannelApe Customer Shipping and Billing Addresses

ChannelApe Field Shopify Field or Value
name name
firstName first_name
lastName last_name
company company
address1 address1
address2 address2
city city
province province
provinceCode province_code
country country
countryCode country_code
postalCode zip
phone phone

Shopify Line ItemChannelApe Line Item

ChannelApe Field Shopify Field or Value
id id
sku sku
upc N/A
quantity quantity
price price_inc_tax
title name
vendor N/A
grams weight

  • Determine weight unit by retrieving store information
  • Convert values to grams
shippingPrice N/A
shippingTax N/A
shippingMethod first order shipping line source + ” – ” + first order shipping line code

Shopify Line ItemChannelApe Line Item Additional Fields

ChannelApe Field Shopify Field or Value
variant_id variant_id
title title
variant_title variant_title
product_id product_id
requires_shipping requires_shipping
taxable taxable
gift_card gift_card
variant_inventory_management variant_inventory_management
fulfillable_quantity fulfillable_quantity
total_discount total_discount
fulfillment_status fulfillment_status
fulfillment_service fulfillment_service

Shopify FulfillmentChannelApe Fulfillment

Fulfillments are not created or update for fulfillments created outside of ChannelApe.

Shopify RefundChannelApe Refunds

Refunds are not created or update for refunds created outside of ChannelApe.