Getting Orders Deletion Requests
For GDPR compliance, whenever a customer requests for the data to be deleted, we delete the customer data from our systems which includes the orders data as well. In order to ensure that our partners are GDPR compliant as well, we expose the orders data belonging to the customers who request data deletion through the below endpoint. This data can be used by you to identify such orders along with all the related data in your systems and delete them to be GDPR compliant.
GET merchants/{merchant-id}/orders-deletion-requests
This endpoint enables you to get all orders, or to select a subset of orders using the filtering parameter(s):
Except for merchant_id
, all query parameters are optional.
Below is an http call of the endpoint
http https://api-sandbox.merchants.zalando.com/merchants/{merchant_ID}/orders-deletion-requests \
Authorization:Bearer $YOUR_ACCESS_TOKEN
The API is paginated and by default returns the first page with the cursor for the next page, if there exists one.
Filtering
You may limit your return results with the following filter (please use appropriate URL encoding where required):
sales_channel_id
For example, to get only orders in a particular sales_channel_id:
GET merchants/{merchant_ID}/orders?orders-deletion-requests={sales_channel_id}
With httpie:
http https://api-sandbox.merchants.zalando.com/merchants/{merchant_ID}/orders-deletion-requests \
sales_channel_id={sales_channel_id} \
Authorization:Bearer $YOUR_ACCESS_TOKEN
Pagination
The API is paginated. You can use the below parameters to access
cursor
Description | This parameter is returned in API call as the cursor for the next page if there exists one. It is to be used as a query param to fetch the next page in subsequent calls. |
---|---|
Type | String |
Example | http https://api-sandbox.merchants.zalando.com/merchants/{merchant_ID}/orders-deletion-requests cursor=cursor_string Authorization:Bearer $YOUR_ACCESS_TOKEN |
limit
Description | Number of orders returned in a single page. |
---|---|
Type | Integer |
Default | 1000 |
Possible values | 1..1000 |
Example | http https://api-sandbox.merchants.zalando.com/merchants/{merchant_ID}/orders-deletion-requests limit=10 Authorization:Bearer $YOUR_ACCESS_TOKEN |