Endpoint Delete a Product
Name
delete_product
Description
Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it. [API reference]
Related Tables
Parameters
| Parameter | Required | Options |
|---|---|---|
|
Name:
Label: Product Id Unique identifier for the Product |
YES |
Output Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| Id |
DT_WSTR
|
nvarchar(100)
|
100 | |
| Name |
DT_WSTR
|
nvarchar(100)
|
100 | |
| Caption |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Description |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Active |
DT_BOOL
|
bit
|
||
| Created |
DT_DBTIMESTAMP
|
datetime
|
||
| Updated |
DT_DBTIMESTAMP
|
datetime
|
||
| Type |
DT_WSTR
|
nvarchar(100)
|
100 | |
| Object |
DT_WSTR
|
nvarchar(100)
|
100 | |
| Attributes |
DT_WSTR
|
nvarchar(2000)
|
2000 | |
| LiveMode |
DT_BOOL
|
bit
|
||
| StatementDescription |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| UnitLabel |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| PackageDimensionsHeight |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| PackageDimensionsLength |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| PackageDimensionsWidth |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| PackageDimensionsWeight |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| URL |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Images |
DT_WSTR
|
nvarchar(2000)
|
2000 | |
| TaxCodeId |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| TaxCodeName |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| PriceUnitAmount |
DT_I8
|
bigint
|
||
| PriceRecurringInterval |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| PriceRecurringIntervalCount |
DT_I4
|
int
|
||
| PriceRecurringUsageType |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Shippable |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| DeactivatedOn |
DT_DBTIMESTAMP
|
datetime
|
Input Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| Id |
DT_WSTR
|
nvarchar(100)
|
100 |
Examples
SSIS
Use Stripe Connector in API Source or in API Destination SSIS Data Flow components to read or write data.
API Source
| Required Parameters | |
|---|---|
| Product Id | Fill-in the parameter... |
| Optional Parameters | |
| ContineOn404Error | True |
API Destination
This Endpoint belongs to the Products table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to delete a product:
| Required Parameters | |
|---|---|
| Product Id | Fill-in the parameter... |
| Optional Parameters | |
| ContineOn404Error | True |
ODBC application
Use these SQL queries in your ODBC application data source:
Delete a Product
Delete a product
DELETE FROM Products
WHERE Id = 'abc'
delete_product endpoint belongs to
Products
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:
Delete a Product
Delete a product
DECLARE @MyQuery NVARCHAR(MAX) = 'DELETE FROM Products
WHERE Id = ''abc''';
EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];
delete_product endpoint belongs to
Products
table(s), and can therefore be used via those table(s).