Stripe Connector
Documentation
Version: 2
Documentation
Endpoint

Update a Product

Name

update_product

Description

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged. [API reference]

Related Tables

Products

Parameters

Parameter Label Required Options Description
Id Product Id YES Unique identifier for the Product
name Name YES
type Type (Good or Service) YES
Option Value
service service
good good
active Active NO
Option Value
true true
false false
description Description NO
caption Caption (Can be set if Type = good) NO
package_dimensions_height Package Dimensions - Height (inch) (Can be set if Type = good) NO
package_dimensions_length Package Dimensions - Length (inch) (Can be set if Type = good) NO
package_dimensions_weight Package Dimensions - Weight (inch) (Can be set if Type = good) NO
package_dimensions_width Package Dimensions - Width (inch) (Can be set if Type = good) NO
shippable Shippable (Can be set if Type = good) NO
Option Value
True True
False False
statement_descriptor Statement Description (Can be set if Type = service) NO
unit_label Unit Label (Can be set if Type = service) NO
url Product URL (Can be set if Type = good) NO
image1 Image1 NO
image2 Image2 NO
image3 Image3 NO
image4 Image4 NO
image5 Image5 NO
image6 Image6 NO
image7 Image7 NO
image8 Image8 NO

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
Id DT_WSTR nvarchar(100) 100 False
Name DT_WSTR nvarchar(100) 100 False
Caption DT_WSTR nvarchar(4000) 4000 False
Description DT_WSTR nvarchar(4000) 4000 False
Active DT_BOOL bit False
Created DT_DBTIMESTAMP datetime False
Updated DT_DBTIMESTAMP datetime False
Type DT_WSTR nvarchar(100) 100 False
Object DT_WSTR nvarchar(100) 100 False
Attributes DT_WSTR nvarchar(2000) 2000 False
LiveMode DT_BOOL bit False
StatementDescription DT_WSTR nvarchar(4000) 4000 False
UnitLabel DT_WSTR nvarchar(4000) 4000 False
PackageDimensionsHeight DT_WSTR nvarchar(4000) 4000 False
PackageDimensionsLength DT_WSTR nvarchar(4000) 4000 False
PackageDimensionsWidth DT_WSTR nvarchar(4000) 4000 False
PackageDimensionsWeight DT_WSTR nvarchar(4000) 4000 False
URL DT_WSTR nvarchar(4000) 4000 False
Images DT_WSTR nvarchar(2000) 2000 False
TaxCodeId DT_WSTR nvarchar(4000) 4000 False
TaxCodeName DT_WSTR nvarchar(4000) 4000 False
PriceUnitAmount DT_I8 bigint False
PriceRecurringInterval DT_WSTR nvarchar(4000) 4000 False
PriceRecurringIntervalCount DT_I4 int False
PriceRecurringUsageType DT_WSTR nvarchar(4000) 4000 False
Shippable DT_WSTR nvarchar(4000) 4000 False
DeactivatedOn DT_DBTIMESTAMP datetime False
If the column you are looking for is missing, consider customizing Stripe Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
Id DT_WSTR nvarchar(100) 100 False
Name DT_WSTR nvarchar(100) 100 False
Caption DT_WSTR nvarchar(4000) 4000 False
Description DT_WSTR nvarchar(4000) 4000 False
Type DT_WSTR nvarchar(100) 100 False
Active DT_BOOL bit False
StatementDescription DT_WSTR nvarchar(4000) 4000 False
UnitLabel DT_WSTR nvarchar(4000) 4000 False
PackageDimensionsHeight DT_WSTR nvarchar(4000) 4000 False
PackageDimensionsLength DT_WSTR nvarchar(4000) 4000 False
PackageDimensionsWidth DT_WSTR nvarchar(4000) 4000 False
PackageDimensionsWeight DT_WSTR nvarchar(4000) 4000 False
URL DT_WSTR nvarchar(4000) 4000 False
Shippable DT_WSTR nvarchar(4000) 4000 False
Image1 DT_WSTR nvarchar(4000) 4000 False
Image2 DT_WSTR nvarchar(4000) 4000 False
Image3 DT_WSTR nvarchar(4000) 4000 False
Image4 DT_WSTR nvarchar(4000) 4000 False
Image5 DT_WSTR nvarchar(4000) 4000 False
Image6 DT_WSTR nvarchar(4000) 4000 False
Image7 DT_WSTR nvarchar(4000) 4000 False
Image8 DT_WSTR nvarchar(4000) 4000 False
Required columns that you need to supply are bolded.

Examples

SSIS

Use Stripe Connector in API Source component to read data or in API Destination component to read/write data:

Update rows in Products table using API Destination

This Endpoint belongs to Products table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Stripe
Products
Update
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Update a product 

SELECT * FROM update_product
WHERE Id = 'abcd-1234-id'
WITH
(
    "name" = 'abcd-1234-name',
    "type" = 'abcd-1234-type'
)

Update a Product

Read a product 

UPDATE Products
SET [name] = 'new name'
WHERE Id = 'abc'

Update a Product

Product Update example. When supply Image1,Image2... it will reset previous images. 

UPDATE Products
SET   [Name]='SSIS PowerPack 3 - Updated'
	, [Caption]='Caption-updated'
	, [Description]='Desc-updated'
	--, [UnitLabel] --only when product type=service
	, [Active]='true'
	, [PackageDimensionsHeight]=12
	, [PackageDimensionsWidth]=13
	, [PackageDimensionsLength]=14
	, [PackageDimensionsWeight]=1122
	, [URL]='https://zappysys.com/products/ssis-powerpack/?updated=1'
	, [Image1]='https://zappysys.com/images/tech/web-api-logo.png?updated=1'
	, [Image2]='https://zappysys.com/images/tech/xml-logo.png?updated=1'
WHERE Id='prod_MiSJzGZ8PDM9uh'

update_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:

Update a product 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM update_product
WHERE Id = ''abcd-1234-id''
WITH
(
    "name" = ''abcd-1234-name'',
    "type" = ''abcd-1234-type''
)';

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];

Update a Product

Read a product 

DECLARE @MyQuery NVARCHAR(MAX) = 'UPDATE Products
SET [name] = ''new name''
WHERE Id = ''abc''';

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];

Update a Product

Product Update example. When supply Image1,Image2... it will reset previous images. 

DECLARE @MyQuery NVARCHAR(MAX) = 'UPDATE Products
SET   [Name]=''SSIS PowerPack 3 - Updated''
	, [Caption]=''Caption-updated''
	, [Description]=''Desc-updated''
	--, [UnitLabel] --only when product type=service
	, [Active]=''true''
	, [PackageDimensionsHeight]=12
	, [PackageDimensionsWidth]=13
	, [PackageDimensionsLength]=14
	, [PackageDimensionsWeight]=1122
	, [URL]=''https://zappysys.com/products/ssis-powerpack/?updated=1''
	, [Image1]=''https://zappysys.com/images/tech/web-api-logo.png?updated=1''
	, [Image2]=''https://zappysys.com/images/tech/xml-logo.png?updated=1''
WHERE Id=''prod_MiSJzGZ8PDM9uh''';

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];

update_product endpoint belongs to Products table(s), and can therefore be used via those table(s).