To access the API, use the following base URL:

{shopify_store}/apps/subscribfy-api/v1/collection.php

new version [unreleased]:

{shopify_store}*/apps/subscribfy-api/v1/collection*

Endpoints

POST

Make a POST request to interact with the API. Include the following parameters in your request:

• key: Your Subscribfy API key.
• topic: Action to perform. Options include:
  • member
  • store_credit_history
  • activity_log_m
  • subscription_contract

Responses

The API will return JSON responses based on the request made:

• Error Responses:

  • {"error": "Bad request."}
  • {"error": "Invalid API key."}
  • {"error": "Store not found."}
  • {"error": "No records found."}

• Success Responses:

  • Fetching content topic: member

    • [{"shopify_customer_gid":"1234","email":"xx@gmail.com","balance_from_subscribfy":"200.00"},{"shopify_customer_gid":"5678","email":"yy@yahoo.com","balance_from_subscribfy":0}]

  • Fetching content topic: store_credit_history

    • {"123123123":[{"shopify_customer_gid":"123123123","body":"You've earned 29.00 Store Credits!","value":"29.00","total":"29.00","status":"0","created_at":"2023-05-08 07:36"}],"456456456456":[{"shopify_customer_gid":"456456456456","body":"Discount Redemption","value":"-29.00","total":"0.00","status":"1","order_name":"#1234","created_at":"2023-05-17 13:54"}]}

Example Usage

curl -X POST {shopify_store}/apps/subscribfy-api/v1/collection.php \\
-d 'key=your_api_key' \\
-d 'topic=member' 

curl -X POST {shopify_store}/apps/subscribfy-api/v1/collection.php \\
-d 'key=your_api_key' \\
-d 'topic=store_credit_history'