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
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.
Client custom value - Shopify_USShippingMethod is missing
RESPONSE: HTTP Status Code (422) {"errors":{"order":["Line items is invalid"],"line_items":["Name can't be blank","Title can't be blank"]}}
- Base item custom value - Shopify_Sku is missing
RESPONSE: HTTP Status Code (422) {"errors":{"customer.email_address":["is invalid"]}}
- Review the customers email address
Setup
Required Custom Values
Client Custom Values
- Shopify_Subdomain- capitalization does not matter
- This can be added at company level if only one store for all clients
- Requires 1 hr code change
- REQUIRED
- Shopify_APIPassword - case sensitive
- 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.
- This can be added at company level if only one store for all clients
- Requires 1 hr code change
- REQUIRED
Default Custom Values
Following custom value can be setup on either Company, Campaign, Client or Base Item
- Shopify_OrderTag
- by default (if not setup)
- we will send “OLX”
Client Custom Values
- Shopify_USShippingMethod - capitalization does not matter
- by default (if not setup)
- we will send "standard"
- REQUIRED
Base Item Custom Values
- Shopify_Sku - capitalization does not matter
- by default (if not setup)
- we will send this as the base items olx external sku value
- if added to base item
- alpha/numeric
- if doesn't exist shopify will create – default behavior by shopify
- if does exist shopify will link
Optional Custom Values
Company Custom Values
- Shopify_OlxDomainName
- Shopify_OLXEnvoirnment
- **take from login link - capitalization does not matter
Client Custom Values
- Shopify_APIKey - case sensitive
- This can be added at company level if only one store for all clients
- Requires 1 hr code change
- 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.
-
- Shopify_INTShippingMethod - capitalization does not matter
- can use 'standard'
- Shopify_AuthType - capitalization does not matter
- token
- Shopify_Gateway - for example "Authorize.net" - case sensitive
- must match from shopify exactly
- we send actual transaction info
- gateway name
- transID
- Shopify_MarkOrdersAsFulfilled
- 0 false/off
- set as open order in shopify
- 1 true/on
- order as fulfilled in shopify when exported from OLX
- Shopify_SendTransactionForPaidOrders
- 0 false/off
- 1 true/on
- Shopify_MarkOrdersAsPaid
- 0 false/off
- 1 true/on
- we set order as paid in shopify
- should match Shopify_MarkOrdersAsFulfilled setting
- Shopify_UseRecharge - capitalization does not matter
- shopify plugin
- true/false
- Shopify_RechargeApiKey - case sensitive
- recharge api will provide
- will match what is setup in shopify
Base Item Custom Values
- Shopify_RechargeOrderIntervalUnit - capitalization does not matter
- shopify plugin
- integer (whole number)
- Shopify_RechargeOrderInterval - capitalization does not matter
- shopify plugin
- 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:
- Login to Shopify
- Go to Settings
- Apps and Sales Channels
- Develop Apps
- open the app you created for OLX integration with each client
- navigate to Configuration tab
- review access scopes
- specifically looking for the write scopes
- write_content,
- write_customers,
- write_orders,
- write_products,
- write_translations,
- write_third_party_fulfillment_orders,
- write_themes,
- write_shipping,
- write_script_tags,
- write_resource_feedbacks,
- write_reports,
- write_product_listings,
- write_price_rules,
- write_order_edits,
- write_online_store_pages,
- write_merchant_managed_fulfillment_orders,
- write_marketing_events,
- write_locales,
- write_legal_policies,
- write_inventory,
- write_gift_cards,
- write_fulfillments,
- write_draft_orders,
- write_discounts,
- write_assigned_fulfillment_orders,
Create Schedule
Processing
> Import/Export > Export > Client = > Spec = Shopify Order API
export
- job should be set to run after the ship confirm import
- Processing > import/export > Exports
- Click on Show Schedules to open scheduler
- Click on Add to add new schedule
- Set Schedule Name
- Set Schedule run parameters
- Client =
- Spec = Shopify Order API Export
- Select start/end date range - date selector is looking at orderdate
- Select all product groups
- Click save on scheduler
The scheduled job will create an export that will post orders to Shopify as per
following:
- All default export framework filters will apply.
- Orders having item status
of “Item Paid” or “Item shipment delivered” will be sent over.
- Order Number field will have hard coded prefix “OLX”
followed by Order Id e.g. “OLX-123456”
- Each order will be sent with a tag coming from custom
values from either company, client, campaign or product level.
- Custom field
name would be “ShopifyOrderTag” default value would be “OLX”
- If the order is one-time order then no additional tag
will be sent over.
- If the order is enrollment subscription (New Subscription
Order), then we will add following tags
- “OLX-AS-Enrollment”
- “Subscription”
- If the order is subsequent subscription, then we will add tag
- “OLX-Subscription”
- All product offers names on the order will be send as
tags.
- Amount Paid = Order Total
- The order will have the sku coming from the product level
custom value “ShopifySku”
- The order notes field will contain a hyperlink to order
in olx
- Each order when exported will be added to a tracking
table for processing in other module.