Endpoint Delete a Customer
Name
delete_customer
Description
Deletes a specific customer. [API reference]
Related Tables
Parameters
| Parameter | Required | Options |
|---|---|---|
|
Name:
Label: Customer Id The ID of the customer to be deleted. |
YES |
Output Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| Id |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Response |
DT_WSTR
|
nvarchar(255)
|
255 |
Input Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| Id |
DT_I8
|
bigint
|
Examples
SSIS
Use Shopify Connector in API Source or in API Destination SSIS Data Flow components to read or write data.
API Source
| There are no parameters to configure. |
API Destination
This Endpoint belongs to the Customers table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to delete a customer:
| There are no parameters to configure. |
ODBC application
Use these SQL queries in your ODBC application data source:
Bulk delete customers using IDs from SQL Server
<p>Bulk deletes customers by reading <code>Id</code> values from an external SQL Server database. You can also pass <code>$$ContineOn404Error</code> as a column to control error handling per row.</p>
DELETE FROM Customers
SOURCE('MSSQL'
,'Data Source=localhost;Initial Catalog=tempdb;Integrated Security=true'
,'select 111 as Id,1 as [$$ContineOn404Error]
UNION
select 222 as Id,1 as [$$ContineOn404Error]
'
)
delete_customer endpoint belongs to
Customers
table(s), and can therefore be used via those table(s).
SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
Bulk delete customers using IDs from SQL Server
<p>Bulk deletes customers by reading <code>Id</code> values from an external SQL Server database. You can also pass <code>$$ContineOn404Error</code> as a column to control error handling per row.</p>
DECLARE @MyQuery NVARCHAR(MAX) = 'DELETE FROM Customers
SOURCE(''MSSQL''
,''Data Source=localhost;Initial Catalog=tempdb;Integrated Security=true''
,''select 111 as Id,1 as [$$ContineOn404Error]
UNION
select 222 as Id,1 as [$$ContineOn404Error]
''
)';
EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];
delete_customer endpoint belongs to
Customers
table(s), and can therefore be used via those table(s).