Direct Shopify API Access

The Rye Sync API’s Shopify Endpoint allows developers to execute raw Shopify GraphQL queries directly on their connected Shopify stores. This is ideal for accessing specific store data or performing complex operations through the Rye API.

​

Overview

This endpoint serves as a bridge between your application and Shopify, forwarding your GraphQL queries to Shopify’s API. It’s essential for developers requiring direct interaction with their Shopify data via the Rye platform.

​

Prerequisites

To use the Shopify Endpoint:

1. Ensure you have an active Rye account with developer privileges.
2. Connect your Shopify store to your Rye account.
3. Obtain specific permissions from Rye to access this endpoint.

​

Endpoint Information

• Endpoint URL: core-v1.api.rye.com/shopify/proxy
• Method: POST
• Content-Type: application/json
• Authentication: Requires Bearer Token (provided by Rye).

​

Making a Request

Your request should include:

{
  "query": "Your GraphQL query",
  "variables": {
    // Optional GraphQL variables
  },
  "shopifyStore": "your-shopify-store.myshopify.com"
}

• query: The GraphQL query for execution.
• variables: (Optional) GraphQL variables.
• shopifyStore: Your Shopify store URL.

​

Usage Example with cURL

Here’s a cURL command example to create a draft order in Shopify:

curl -v -X POST core-v1.api.rye.com/shopify/proxy \
-H 'Authorization: Bearer [Your Rye Access Token]' \
-d '{"query": "mutation DraftOrderCreate($draftOrderCreateInput: DraftOrderInput!) {\\n draftOrderCreate(input: $draftOrderCreateInput) {\\n  draftOrder {\\n   id\\n   createdAt\\n   currencyCode\\n  }\\n  userErrors {\\n   field\\n   message\\n  }\\n }\\n}", "shopifyStore": "your-shopify-store.myshopify.com", "variables":{"draftOrderCreateInput":{"appliedDiscount":{"amount":"600","description":"Description","value":100,"valueType":"PERCENTAGE"},"billingAddress":{"address1":"","address2":null,"city":"","countryCode":"US","firstName":"John","lastName":"Doe","phone":"","provinceCode":"","zip":""},"email":"","lineItems":[{"variantId":"gid://shopify/ProductVariant/45027021553960","quantity":1,"requiresShipping":true}]}}' \
-H "content-type: application/json"

Replace [Your Rye Access Token] and your-shopify-store.myshopify.com with your actual Rye access token and Shopify store URL.

​

Support and Further Information

For more details or support, contact the Rye developer support team. Use this endpoint responsibly, as it directly interacts with your Shopify store data.