Skip to main content

Order Management Step

Routes orders to one ore many locations and applies shipping rules.

Prerequisites​

Order Management step requires locations to be setup prior to running.

Environment Variables​

  • SHOPIFY_ORDER_ID_CUTOFF - The numeric Shopify order ID (can be retrieved from the URL of an order in Shopify Admin) is used to exclude any order with an ID less than the value defined here.

  • SHOPIFY_TAG_FILTERS - Comma-separated values list of tags; when an order tag includes any of these it is excluded from fulfillment and the order is placed in PENDING status. When used in conjunction with SHOPIFY_INCLUDE_TAGS and tag is present in both exclusion and inclusion lists the exclusion will take precedence.(i.e. hold,fraud)

  • SHOPIFY_INCLUDE_TAGS - Comma-separated values list of tags; when a value is present, one or more of the include tags MUST be present on the order for it to continue processing. When used in conjunction with SHOPIFY_TAG_FILTERS and tag is present in both exclusion and inclusion lists the exclusion will take precedence (i.e. GlobalE,exclusive)

  • SHOPIFY_FINANCIAL_STATUS_FILTERS - Comma-separated values list of financial statuses; when an order financial status matches any of these it is excluded from fulfillment (i.e. refunded,voided,pending)

  • VIRTUAL_SALES_CHANNEL_LOCATION_ID - The ChannelApe Location ID configured for the IMS Location on the eCommerce Sales Channel (e.g. Shopify). Used to propagate Inventory updates to inventory on the eCommerce Sales Channel.

  • DOMESTIC_COUNTRY_CODE - This ISO 3166 alpha 2 country code is compared to the country code on the order's shipping address to determine if it's shipping Domestically vs Internationally.

  • DOMESTIC_DEFAULT_CARRIER - A default carrier code that should be used when no other Shipping Rules apply for domestic shipments.

  • DOMESTIC_DEFAULT_SERVICE - A default service code that should be used when no other Shipping Rules apply for domestic shipments.

  • INTERNATIONAL_DEFAULT_CARRIER - A default carrier code that should be used when no other Shipping Rules apply for international shipments.

  • INTERNATIONAL_DEFAULT_SERVICE - A default service code that should be used when no other Shipping Rules apply for international shipments.

  • SHIPPING_RULES - CSV formatted text, including newlines, where each row represents a new rule used to select the shipment's carrier and service. See here for more details.

  • WAREHOUSE_LOCATION_MAP - A JSON dictionary mapping warehouse codes and their location limits to a ChannelApe Location ID. See here for more details.

  • DOM_PRIORITIES - CSV formatted text, including newlines, where each row represents a new rule used to select the warehouse locations available to fulfill the ordered items. See here for more details.

  • BUNDLE_CONFIG - CSV formatted text, including newlines, where each row represents a new bundle configuration. The first column is designated for the bundle SKU and each column after can be dynamically used for that bundle's component SKUs. Multiple units of the same component SKU should be entered as multiple columns. (i.e A bundle, SKU BNDL, with 2 units of SKU A, and 1 of SKU B should be entered a BNDL,A,A,B)

  • SHIP_COMPLETE - This flag, when enabled, prevents the shipment of items that cannot be fulfilled completely at one warehouse location.