Learn how to configure coreBOS and Shopify to work together.

WEB-SERVICE MAPPING DOCUMENTATION

GET/POST information from coreBOS to Shopify and from Shopify to coreBOS

GET/POST information (products,accounts,orders)from coreBOS to Shopify and from Shopify to coreBOS

This document explains how to successfully call the Shopify API with coreBOS in order to get or post information. The first thing you need before receiving or submitting information to Shopify is the URL of Shopify from the client and the access token.

The access token can be generated by following the steps in this link

To get information from Shopify, you will need the specific id of the account or product stored in Shopify for example: if you want to get an account from Shopify into coreBOS you need to have an account id and then you can get the data of that account.

Identification of the Endpoint Admin REST API endpoints are organized by resource type. You’ll need to use different endpoints depending on your app’s requirements.

Version API Shopify releases a new API version every 3 months at the beginning of the quarter. Version names are date-based to be meaningful and semantically unambiguous

Webservice mapping

Get Products from Shopify to coreBOS

The Product resource lets you update and create products in a store. Every product has a unique ID. Each id is unique across the Shopify system. No two products will have the same id. To retrieve a product from Shopify you need to store this id in a field and use it whenever you want. Besides the ID you also need the access token to generate the products.

Example

 Access Token : your_super_secret_key 
 Format : https://yourshop.myshopify.com/admin/api/2022-04/products/$prod_id
 The value of the variable prod_id is taken with the following code
 <fieldname>prod_id</fieldname>
 <Orgfields><Orgfield>
 <OrgfieldName>concat(shopifyprodid,'.json')</OrgfieldName>
 <OrgfieldID>expression</OrgfieldID>

Response example:

Get Customers from Shopify to coreBOS

The Customer resource lets you update and create customers in a store. Every customer has a unique ID. Each id is unique across the Shopify system. No two customers will have the same id. To retrieve a customer from Shopify you need to store this id in a field and use it whenever you want. Besides the ID you also need the access token to generate the customers.

Example

Example Access Token : your_super_secret_key 
Format : https://yourshop.myshopify.com/admin/api/2022-04/customers/$clientid
The value of the variable clientid is taken with the following code
<fieldname>clientid</fieldname>
<Orgfields><Orgfield>
<OrgfieldName>concat(client_id,'.json')</OrgfieldName>
<OrgfieldID>expression</OrgfieldID>

Response example:

Get Orders

The Orders resource lets you update and create orders in a store. Every order has a unique ID. Each id is unique across the Shopify system. No two orders will have the same id. To retrieve an order from Shopify you need to store this id in a field and use it whenever you want. Besides the ID you also need the access token to generate the products. This webservice will be a little different from the others due to the fact that we have related modules and information that will be stored in both modules. To do this, a workflow must be created which will perform an upsert to the related module. The upsert_data variable is used to store the ws response with the corresponding field.

Example of the wf:

The upsert task:

Example

Access Token : your_super_secret_key
URL Format : https://yourshop.myshopify.com/admin/api/2022-04/orders/$order_id 
The value of the variable clientid is taken with the following code
<fieldname>order_id</fieldname>
<Orgfields>
<Orgfield>
<OrgfieldName>concat(shopifyordid,'.json')</OrgfieldName>
<OrgfieldID>expression</OrgfieldID>

Response example:

Send Products to Shopify

Unlike the Get method, the Post method has a different format. It has the same header structure, with the content-type and access token, but it also has a body structure. To send a product from coreBOS to Shopify you must map the fields you want to send from coreBOS to the fields that are in Shopify. Be careful with mandatory fields!

Send Customers to Shopify

To send a customer from coreBOS to Shopify you must map the fields you want to send from coreBOS to the fields that are in Shopify. Be careful with mandatory fields!

Send SalesOrder to Shopify

An order is a customer's request to purchase one or more products from a shop. You can create, retrieve, update, and delete orders using the Order resource. To send an order from coreBOS to Shopify you must map the fields you want to send from coreBOS to the fields that are in Shopify. Be careful with mandatory fields! The creation of a new order has a different structure from the others because it is not only fields from SalesOrder that must be sent, but also fields from related modules. Therefore, besides the web service mapping, you will also need another map of the Mapping type to make a relation of the corebos fields that you must send with the shopify fields.

Map

• Type: Mapping
• Map name: Workflow_InventoryDetails2ShopifyOrder
• Target module: InventoryDetails

Fields map:

WS Mapping: