Skip to content

Latest commit

 

History

History
275 lines (187 loc) · 9.71 KB

ShopifyPrivacyWebhooksApi.md

File metadata and controls

275 lines (187 loc) · 9.71 KB

openapi_client.ShopifyPrivacyWebhooksApi

All URIs are relative to /api/v2

Method HTTP request Description
shopify_customer_redact POST /gdpr_hooks/shopify/customers/redact Delete requested shopify customer orders data from the system
shopify_data_request POST /gdpr_hooks/shopify/customers/data_request Get requested data of shopify user
shopify_shop_redact POST /gdpr_hooks/shopify/shop/redact Delete requested shopify shop's data from the system

shopify_customer_redact

ShopifyCustomerRedactResponse shopify_customer_redact(shopify_customer_redact_request)

Delete requested shopify customer orders data from the system

Delete requested shopify customer orders data from the system

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (apiSecret):
import openapi_client
from openapi_client.models.shopify_customer_redact_request import ShopifyCustomerRedactRequest
from openapi_client.models.shopify_customer_redact_response import ShopifyCustomerRedactResponse
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/api/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: apiSecret
configuration.api_key['apiSecret'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiSecret'] = 'Bearer'

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.ShopifyPrivacyWebhooksApi(api_client)
    shopify_customer_redact_request = openapi_client.ShopifyCustomerRedactRequest() # ShopifyCustomerRedactRequest | 

    try:
        # Delete requested shopify customer orders data from the system
        api_response = api_instance.shopify_customer_redact(shopify_customer_redact_request)
        print("The response of ShopifyPrivacyWebhooksApi->shopify_customer_redact:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ShopifyPrivacyWebhooksApi->shopify_customer_redact: %s\n" % e)

Parameters

Name Type Description Notes
shopify_customer_redact_request ShopifyCustomerRedactRequest

Return type

ShopifyCustomerRedactResponse

Authorization

apiKey, apiSecret

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful -
400 Bad request syntax or unsupported method -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

shopify_data_request

ShopifyDataRequestResponse shopify_data_request(shopify_data_request)

Get requested data of shopify user

Get requested data of shopify user

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (apiSecret):
import openapi_client
from openapi_client.models.shopify_data_request import ShopifyDataRequest
from openapi_client.models.shopify_data_request_response import ShopifyDataRequestResponse
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/api/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: apiSecret
configuration.api_key['apiSecret'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiSecret'] = 'Bearer'

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.ShopifyPrivacyWebhooksApi(api_client)
    shopify_data_request = openapi_client.ShopifyDataRequest() # ShopifyDataRequest | 

    try:
        # Get requested data of shopify user
        api_response = api_instance.shopify_data_request(shopify_data_request)
        print("The response of ShopifyPrivacyWebhooksApi->shopify_data_request:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ShopifyPrivacyWebhooksApi->shopify_data_request: %s\n" % e)

Parameters

Name Type Description Notes
shopify_data_request ShopifyDataRequest

Return type

ShopifyDataRequestResponse

Authorization

apiKey, apiSecret

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful -
400 Bad request syntax or unsupported method -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

shopify_shop_redact

ShopifyShopRedactResponse shopify_shop_redact(shopify_shop_redact_request)

Delete requested shopify shop's data from the system

Delete requested shopify shop's data from the system

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (apiSecret):
import openapi_client
from openapi_client.models.shopify_shop_redact_request import ShopifyShopRedactRequest
from openapi_client.models.shopify_shop_redact_response import ShopifyShopRedactResponse
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/api/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: apiSecret
configuration.api_key['apiSecret'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiSecret'] = 'Bearer'

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.ShopifyPrivacyWebhooksApi(api_client)
    shopify_shop_redact_request = openapi_client.ShopifyShopRedactRequest() # ShopifyShopRedactRequest | 

    try:
        # Delete requested shopify shop's data from the system
        api_response = api_instance.shopify_shop_redact(shopify_shop_redact_request)
        print("The response of ShopifyPrivacyWebhooksApi->shopify_shop_redact:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ShopifyPrivacyWebhooksApi->shopify_shop_redact: %s\n" % e)

Parameters

Name Type Description Notes
shopify_shop_redact_request ShopifyShopRedactRequest

Return type

ShopifyShopRedactResponse

Authorization

apiKey, apiSecret

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful -
400 Bad request syntax or unsupported method -

[Back to top] [Back to API list] [Back to Model list] [Back to README]