Shopify Order API Export

Shopify Order API Export

Module: Export
Path: Processing > Import/Export > Exports
Topic:  Shopify Order API Export
Version(s): 5.1 & Up
Editions: All


What IS Shopify Order API Export

Shopify Order API Export allows you to export orders from your OLX instance into Shopify.


Making The Connection

Where Will I See This Within OLX?

You will not see anything in OLX to denote an order as being exported via Shopify Order API Export. Only orders that are in the status of Item Paid or Item Shipment Delivered are eligible for export with Shopify Order API Export.

What Reports Can Be Pulled?

At this time there are no reports for Shopify Order API Export specifically. Please reach out if you would like an estimate for a custom report.

What Imports/Exports Relate to Shopify Order API Export

At this time there are no additional import/exports related to Shopify Order API Export specifically.


Trouble Shooting

  1. RESPONSE: HTTP Status Code (422) {"errors":{"order":["Shipping lines is invalid"],"shipping_lines":[" Title can't be blank and Code can't be blank"]}} OrderID: ###### could not posted to shopify.

    1. Client custom value - Shopify_USShippingMethod is missing
  2. RESPONSE: HTTP Status Code (422) {"errors":{"order":["Line items is invalid"],"line_items":["Name can't be blank","Title can't be blank"]}}

    1. Base item custom value - Shopify_Sku is missing
  3. RESPONSE: HTTP Status Code (422) {"errors":{"customer.email_address":["is invalid"]}}

    1. Review the customers email address


Setup

Required Custom Values

Client Custom Values

  1. Shopify_Subdomain- capitalization does not matter

    1. This can be added at company level if only one store for all clients 
      1. Requires 1 hr code change
    2. REQUIRED
  2. Shopify_APIPassword - case sensitive
    1. To get your Shopify API secret key, navigate to Shopify admin > Settings > Apps and sales channels > Develop apps. Select your app and click on API credentials. Your API secret key will be displayed there.
    2. This can be added at company level if only one store for all clients 
      1. Requires 1 hr code change
    3. REQUIRED

Default Custom Values

Following custom value can be setup on either Company, Campaign, Client or Base Item

  1. Shopify_OrderTag
    1. by default (if not setup)
      1. we will send “OLX”

Client Custom Values

  1. Shopify_USShippingMethod - capitalization does not matter
    1. by default (if not setup)
      1. we will send "standard"
    2. REQUIRED

Base Item Custom Values

  1. Shopify_Sku  - capitalization does not matter
    1. by default (if not setup) 
      1. we will send this as the base items olx external sku value
    2. if added to base item
      1. alpha/numeric
      2. if doesn't exist shopify will create – default behavior by shopify
      3. if does exist shopify will link


Optional Custom Values

Company Custom Values

    1. Shopify_OlxDomainName
    2. Shopify_OLXEnvoirnment
      1. **take from login link - capitalization does not matter

Client Custom Values

  1. Shopify_APIKey - case sensitive
    1. This can be added at company level if only one store for all clients 
      1. Requires 1 hr code change
    2. To get your Shopify API key, navigate to Shopify admin > Settings > Apps and sales channels > Develop apps. Select your app and click on API credentials. Your API key will be displayed there.
    3.  
  2. Shopify_INTShippingMethod - capitalization does not matter
    1. can use 'standard'
  3. Shopify_AuthType - capitalization does not matter
    1. token
  4. Shopify_Gateway - for example "Authorize.net" - case sensitive
    1. must match from shopify exactly    
    2. we send actual transaction info 
      1. gateway name
      2. transID
  5. Shopify_MarkOrdersAsFulfilled
    1. 0 false/off
      1. set as open order in shopify
    2. 1 true/on
      1. order as fulfilled in shopify when exported from OLX
  6. Shopify_SendTransactionForPaidOrders
    1. 0 false/off
    2. 1 true/on
  7. Shopify_MarkOrdersAsPaid
    1. 0 false/off
    2. 1 true/on
      1. we set order as paid in shopify
      2. should match Shopify_MarkOrdersAsFulfilled setting
  8. Shopify_UseRecharge - capitalization does not matter
    1. shopify plugin
    2. true/false
  9. Shopify_RechargeApiKey  - case sensitive
    1. recharge api will provide
    2. will match what is setup in shopify

Base Item Custom Values

  1. Shopify_RechargeOrderIntervalUnit  - capitalization does not matter
    1. shopify plugin
    2. integer (whole number)
  2. Shopify_RechargeOrderInterval  - capitalization does not matter
    1. shopify plugin
    2. integer (whole number)

Shopify Admin API Access Scopes

The following permissions must be granted in Shopify for the export to work correctly between the two systems:
  1. Login to Shopify
  2. Go to Settings
  3. Apps and Sales Channels
  4. Develop Apps
  5. open the app you created for OLX integration with each client
  6. navigate to Configuration tab
  7. review access scopes
    1. specifically looking for the write scopes
      1. write_content,
      2. write_customers,
      3. write_orders,
      4. write_products,
      5. write_translations,
      6. write_third_party_fulfillment_orders,
      7. write_themes,
      8. write_shipping,
      9. write_script_tags,
      10. write_resource_feedbacks,
      11. write_reports,
      12. write_product_listings,
      13. write_price_rules,
      14. write_order_edits,
      15. write_online_store_pages,
      16. write_merchant_managed_fulfillment_orders,
      17. write_marketing_events, 
      18. write_locales,
      19. write_legal_policies,
      20. write_inventory,
      21. write_gift_cards, 
      22. write_fulfillments,
      23. write_draft_orders,
      24. write_discounts,
      25. write_assigned_fulfillment_orders, 

Create Schedule

Processing > Import/Export > Export > Client = > Spec = Shopify Order API export

  1. job should be set to run after the ship confirm import
  2. Processing > import/export > Exports
  3. Click on Show Schedules to open scheduler
  4. Click on Add to add new schedule
  5. Set Schedule Name
  6. Set Schedule run parameters
  7. Client = 
  8. Spec = Shopify Order API Export
  9. Select start/end date range - date selector is looking at orderdate
  10. Select all product groups
  11. Click save on scheduler

The scheduled job will create an export that will post orders to Shopify as per following:

  1. All default export framework filters will apply.
  2. Orders having item status of “Item Paid” or “Item shipment delivered” will be sent over.
  3. Order Number field will have hard coded prefix “OLX” followed by Order Id e.g. “OLX-123456”
  4. Each order will be sent with a tag coming from custom values from either company, client, campaign or product level.
    1. Custom field name would be “ShopifyOrderTag” default value would be “OLX”
  5. If the order is one-time order then no additional tag will be sent over. 
  6. If the order is enrollment subscription (New Subscription Order), then we will add following tags 
        1. “OLX-AS-Enrollment”
        2. “Subscription”
  1. If the order is subsequent subscription, then we will add tag
        1. “OLX-Subscription”
  1. All product offers names on the order will be send as tags.
  2. Amount Paid = Order Total
  3. The order will have the sku coming from the product level custom value “ShopifySku”
  4. The order notes field will contain a hyperlink to order in olx
  5. Each order when exported will be added to a tracking table for processing in other module.




    • Related Articles

    • Shopify Order Import

      Module: Imports Path: Processing > Imports Topic: Shopify Order Import Version(s): 5.1 & Up Editions: All What Are Shopify Order Import This module is built for olx 5x and lets us import orders from the Shopify. It supports four payment gateways for ...
    • Shopify Ship Confirmation Export

      Module: Export Path: Processing>Import/Export>Exports Topic: Shopify Ship Confirmation Export Version(s): 5.1 & up Editions: All What Is Shopify Ship Confirmation Export The Shopify Ship Confirmation Export is used to pass payment and fulfillment ...
    • Shopify Tags Update Process

      Module: Processes Path: Processing > Processes Topic: Shopify Tags Update Process Version(s): 5.1 & up Editions: All What Is Shopify Tags Update Process Module will look through each order in the tracking table and check to see if its subscription is ...
    • API Detail Screen

      Module : API Detail Screen  Topic : Page Overview  Version(s): Version 5.0 and up   Editions : All Editions  Overview : The API Detail Screen is a page that allows OrderLogix users to view details about orders submitted to the Order Import API. These ...
    • Export Schedules

      Module : Export Schedules  Topic : Module Overview  Version(s) : Version 5.1 and up   Editions : Standard, Commerce, Call Center  Navigate to Processing>Import/Export>Exports. When you click on the     Show schedules button you will see some specific ...