Store adapter — Shopify The adapter object contains properties for connecting to the Shopify API.
Parent object: a store with property "platform" : "shopify"
Required properties The following adapter properties are required for Shopify stores.
access_token Property access_tokenName Shopify API Access Token Data type string Required? Yes
location_id Property location_idName Fulfillment Location ID Description The ID of the fulfillment location, as configured and enabled in Shopify. When DropStream exports the shipment, Shopify checks that the item/SKU is in stock at the specified location. If not, order processing fails in DropStream with an error. Data type string Required? Yes
shop_name Property shop_nameName Shopify Shop Name Description The subdomain of the store URL Data type string Example If the URL is http://mystore.myshopify.com, the shop name is "mystore" Required? Yes
Optional properties The following adapter properties are optional for Shopify stores.
enable_sku_instance Property enable_sku_instanceName Enable SKU Instance Data type boolean More info By default, DropStream will not attempt to update inventory for more than one match for a given SKU. However, if this value is true, DropStream updates inventory for all instances of the SKU. This attribute corresponds to the GUI option Include Duplicate SKUs . Default false
exclude_empty_orders Property exclude_empty_ordersName Exclude Empty Orders Description If true, empty orders are not imported Data type boolean Default false
filter_orders_by_location Property filter_orders_by_locationName Filter Orders By Location Description If true, import only orders assigned to the Fulfillment Location Data type boolean Default false
fulfillment_service Property fulfillment_serviceName Fulfillment Service Description The Fulfillment Service is the fulfillment provider, as configured and activated in Shopify. If this value is specified, DropStream imports only line items/SKUs that have been designated for this fulfillment service. If the order contains SKUs designated for a different fulfillment service, those SKUs are not imported. Data type string
include_partial_fulfillments Property include_partial_fulfillmentsName Include Partial Fulfillments Description If true, import orders that are "partially" fulfilled, including virtual products such as gift cards Data type boolean Default false
order_import_financial_status Property order_import_financial_statusName Order Import Financial Status Description Orders with the specified status(es) are imported Data type array of strings Accepted values "Paid""Pending""Authorized""Partially Paid""Partially Refunded""Refunded""Voided"Default [ "Paid" ]Example ["Paid", "Partially Paid", "Refunded"]
order_import_fulfillment_status Property order_import_fulfillment_statusName Order Import Fulfillment Status Data type string Default "unshipped"
return_magic_api_key Property return_magic_api_keyName Return Magic API Key Description The Return Magic API key if using Return Magic for custom returns workflow Data type string
use_local_currency Property use_local_currencyName Use Local Currency Description If set to true, money values are displayed in the buyer's local currency Data type boolean Default false
Example Example: create a new Shopify store cURL \
"Authorization: Bearer $JWT_TOKEN " \
"Content-Type: application/json" \
\
<<EOF
{ "customer_id": "3775",
"name":"Your Shopify Store",
"platform": "shopify",
"adapter": {
"shop_name": "abc123",
"location_id": "abc123",
"access_token": "abc123",
"enable_sku_instance": false,
"exclude_empty_orders": false,
"filter_orders_by_location": false,
"fulfillment_service": "abc123",
"include_partial_fulfillments": false,
"order_import_financial_status": [ "Paid", "Pending" ],
"order_import_fulfillment_status": "abc123",
"return_magic_api_key": "abc123",
"use_local_currency": false
}
}
EOF
Create a new store .
