Receive GDPR webhooks

post
/gdpr

Receive GDPR webhooks.

When a customer requests data from a merchant, you should send a customers/data_request GDPR request to AfterShip. After receiving this request, AfterShip will send customer's data to the merchant's email, which is registered as the organization owner's email account.

When a merchant requests deletion of data on behalf of a customer, you should send a customers/redact GDPR request to AfterShip. After receiving this request, AfterShip will send a confirmation email to the merchant's email, which is registered as the organization owner's email account.

Finally, AfterShip will delete the customer's data after receiving the merchant's confirmation.

When the data owner requests to perform a GDPR data redaction request, you should send a store/redact GDPR request to AfterShip. After receiving this request, AfterShip will send a confirmation email to the merchant's email, which is registered as the organization owner's email account. Finally, AfterShip will delete all the data that belongs to the store after receiving the merchant's confirmation.

automizely_product
string
required

Automizely product code.

Allowed values:
aftershipautomizelyshoppingpostmenpagesdropshippingreviewsadsloyaltysmsreturnscenter
type
string
required

The type of GDPR request.

Allowed values:
customers/data_requestcustomers/redactstore/redact
as-store-id
string

The identifier of your store. It is not the store ID generated by AfterShip.

source_id
string
required

A unique identifier for the request.

<= 32 characters
store_id
string
required

The identifier of store. It is not the store ID generated by AfterShip.

<= 256 characters
source_order_ids
array[string]

The list of order id. If request type is store/redact, this field is not required, otherwise it is required.

customer
object

The info of customer. If request type is store/redact, this field is not required, otherwise it is required.

source_id
string
required

A unique identifier for the customer.

<= 32 characters
email
string

The email of customer.

<= 256 characters
phone
string

The phone of customer.

<= 256 characters
Auth
:
Parameters
:
:
:
Body
preparing...