Endpoint Update Product
Name
put_product
Description
Related Tables
Parameters
| Parameter | Required | Options | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| There are no parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Output Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| Id |
DT_WSTR
|
nvarchar(255)
|
255 | |
| Display |
DT_WSTR
|
nvarchar(1000)
|
1000 | |
| Summary |
DT_WSTR
|
nvarchar(1000)
|
1000 | |
| Description |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Action |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Image |
DT_WSTR
|
nvarchar(500)
|
500 | |
| Format |
DT_WSTR
|
nvarchar(50)
|
50 | |
| Sku |
DT_WSTR
|
nvarchar(255)
|
255 | |
| Renew |
DT_WSTR
|
nvarchar(10)
|
10 | |
| Interval |
DT_WSTR
|
nvarchar(10)
|
10 | |
| IntervalLength |
DT_I8
|
bigint
|
||
| IntervalCount |
DT_I4
|
int
|
||
| QuantityBehavior |
DT_WSTR
|
nvarchar(10)
|
10 | |
| QuantityDefault |
DT_I8
|
bigint
|
||
| PriceUSD |
DT_R8
|
float
|
||
| PriceEUR |
DT_R8
|
float
|
||
| PriceGBP |
DT_R8
|
float
|
||
| PriceCAD |
DT_R8
|
float
|
||
| PriceNZD |
DT_R8
|
float
|
||
| PriceCHF |
DT_R8
|
float
|
||
| PriceSEK |
DT_R8
|
float
|
||
| PriceCZK |
DT_R8
|
float
|
||
| PriceDKK |
DT_R8
|
float
|
||
| PricePLN |
DT_R8
|
float
|
||
| PriceSGD |
DT_R8
|
float
|
||
| PriceJPY |
DT_R8
|
float
|
||
| PriceCNY |
DT_R8
|
float
|
||
| PriceHKD |
DT_R8
|
float
|
||
| PriceINR |
DT_R8
|
float
|
||
| PriceBRL |
DT_R8
|
float
|
||
| PriceAUD |
DT_R8
|
float
|
||
| Trial |
DT_I4
|
int
|
||
| PaymentCollected |
DT_BOOL
|
bit
|
||
| PaidTrial |
DT_BOOL
|
bit
|
||
| FulfillmentInstructions |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Badge |
DT_WSTR
|
nvarchar(50)
|
50 | |
| Rank |
DT_I4
|
int
|
||
| DateLimitsEnabled |
DT_BOOL
|
bit
|
||
| CancellationInterval |
DT_WSTR
|
nvarchar(4)
|
4 | |
| CancellationIntervalLength |
DT_I8
|
bigint
|
||
| TaxCode |
DT_WSTR
|
nvarchar(50)
|
50 | |
| TaxCodeDescription |
DT_WSTR
|
nvarchar(500)
|
500 | |
| Visibility |
DT_WSTR
|
nvarchar(255)
|
255 | |
| ProductAppReference |
DT_WSTR
|
nvarchar(255)
|
255 | |
| Parent |
DT_WSTR
|
nvarchar(255)
|
255 | |
| MigratedProductId |
DT_WSTR
|
nvarchar(50)
|
50 | |
| ClassicProduct |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| SetupFeeTitle |
DT_WSTR
|
nvarchar(500)
|
500 | |
| SetupFeePriceUSD |
DT_R8
|
float
|
||
| SetupFeePriceEUR |
DT_R8
|
float
|
||
| SetupFeePriceGBP |
DT_R8
|
float
|
||
| TrialPriceUSD |
DT_R8
|
float
|
||
| TrialPriceEUR |
DT_R8
|
float
|
||
| TrialPriceGBP |
DT_R8
|
float
|
||
| Result |
DT_WSTR
|
nvarchar(100)
|
100 | |
| ResultAction |
DT_WSTR
|
nvarchar(100)
|
100 | |
| ResultErrors |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| ResultMessage |
DT_WSTR
|
nvarchar(4000)
|
4000 |
Input Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| Id |
DT_WSTR
|
nvarchar(255)
|
255 | |
| Display |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Summary |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Description |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Action |
DT_WSTR
|
nvarchar(1000)
|
1000 | |
| Format |
DT_WSTR
|
nvarchar(50)
|
50 | |
| Sku |
DT_WSTR
|
nvarchar(255)
|
255 | |
| TaxCode |
DT_WSTR
|
nvarchar(50)
|
50 | |
| Image |
DT_WSTR
|
nvarchar(500)
|
500 | |
| Renew |
DT_WSTR
|
nvarchar(10)
|
10 | |
| Interval |
DT_WSTR
|
nvarchar(10)
|
10 | |
| IntervalLength |
DT_I8
|
bigint
|
||
| IntervalCount |
DT_I4
|
int
|
||
| QuantityBehavior |
DT_WSTR
|
nvarchar(10)
|
10 | |
| QuantityDefault |
DT_I8
|
bigint
|
||
| PriceUSD |
DT_R8
|
float
|
||
| PriceEUR |
DT_R8
|
float
|
||
| PriceGBP |
DT_R8
|
float
|
||
| PriceCAD |
DT_R8
|
float
|
||
| PriceNZD |
DT_R8
|
float
|
||
| PriceCHF |
DT_R8
|
float
|
||
| PriceSEK |
DT_R8
|
float
|
||
| PriceCZK |
DT_R8
|
float
|
||
| PriceDKK |
DT_R8
|
float
|
||
| PricePLN |
DT_R8
|
float
|
||
| PriceSGD |
DT_R8
|
float
|
||
| PriceJPY |
DT_R8
|
float
|
||
| PriceCNY |
DT_R8
|
float
|
||
| PriceHKD |
DT_R8
|
float
|
||
| PriceINR |
DT_R8
|
float
|
||
| PriceBRL |
DT_R8
|
float
|
||
| PriceAUD |
DT_R8
|
float
|
||
| Trial |
DT_I4
|
int
|
||
| PaymentCollected |
DT_BOOL
|
bit
|
||
| PaidTrial |
DT_BOOL
|
bit
|
||
| FulfillmentInstructions |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| DateLimitsEnabled |
DT_BOOL
|
bit
|
||
| CancellationInterval |
DT_WSTR
|
nvarchar(4)
|
4 | |
| CancellationIntervalLength |
DT_I8
|
bigint
|
||
| SetupFeeTitle |
DT_WSTR
|
nvarchar(500)
|
500 | |
| SetupFeePriceUSD |
DT_R8
|
float
|
||
| SetupFeePriceEUR |
DT_R8
|
float
|
||
| SetupFeePriceGBP |
DT_R8
|
float
|
||
| TrialPriceUSD |
DT_R8
|
float
|
||
| TrialPriceEUR |
DT_R8
|
float
|
||
| TrialPriceGBP |
DT_R8
|
float
|
||
| Badge |
DT_WSTR
|
nvarchar(50)
|
50 | |
| Rank |
DT_I4
|
int
|
||
| Parent |
DT_WSTR
|
nvarchar(255)
|
255 | |
| Attributes |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Fulfillments |
DT_WSTR
|
nvarchar(4000)
|
4000 |
Examples
SSIS
Use FastSpring Connector in API Source or in API Destination SSIS Data Flow components to read or write data.
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 update product:
| There are no parameters to configure. |
ODBC application
Use these SQL queries in your ODBC application data source:
Update product
<p>Updates product attributes by ID. Use <code>UPDATE Products SET ... WHERE Id='...'</code> with the product ID and the columns you want to change (display name, SKU, prices, tax code, trial settings, etc.).</p>
UPDATE Products
SET
Display='Product ABCD'
, Sku='PRD-ABCD-01'
, Summary='Product Abcd **STD**'
, Description='This product can be used to call **API** supports markdown syntax'
, Action='**Action** supports markdown'
, TaxCode='DC010500'
, Image='https://zappysys.com/api/images/ZappySys-icon.png'
, FulfillmentInstructions='Thank you for shopping. **Activate** license by using our License App'
, Format='digital'
, PriceUSD='101.5'
, PriceEUR='102.5'
, PriceGBP='103.5'
, PriceCAD='104.5'
, PriceNZD='105.5'
, PriceCHF='106.5'
, PriceSEK='107.5'
, PriceCZK='108.5'
, PriceDKK='109.5'
, PricePLN='101.5'
, PriceSGD='102.5'
, PriceJPY='103.5'
, PriceCNY='104.5'
, PriceHKD='105.5'
, PriceINR='106.5'
, PriceBRL='107.5'
, PriceAUD='108.5'
, Badge='Badge-1'
, Rank=1
, Trial=14 --how many trial days
, TrialPriceUSD=10.5
--, Renew=1 --not allowed for update : Only for create (enable subscription)
, Interval='year' --allowed values: adhoc, day, week, year, only needed if you are creating a subscription
, IntervalLength=1
, IntervalCount=0
, QuantityBehavior='allow' --allowed values: allow, lock, hide
, QuantityDefault=1
, Attributes = '{"mykey-1" : "some-value-1", "mykey-2" : "some-value-2"}'
--, Fulfillments='[ { fullfillment }, { fullfillment } ... ]' --JSON fragment
WHERE Id='abcd'
Update multiple products from CSV
<p>Updates multiple products from an external source. Use <code>UPDATE Products SOURCE('ODBC', ...)</code> with a connection string and a <code>SELECT</code> whose column names (or aliases) match the product columns to update (e.g. <code>Id</code>, <code>TaxCode</code>). Works with ZappySys CSV Driver, SQL Server, MySQL, PostgreSQL, or any ODBC source.</p>
UPDATE Products
SOURCE('ODBC',
--File input example (use as to match Column name allowed in Products Table to write)
--'Driver={ZappySys CSV Driver};DataPath=c:\data\products.csv',
--'SELECT P_ID AS Id,P_TAXCODE AS TaxCode FROM $'
--Direct input example
'Driver={ZappySys CSV Driver}',
'SELECT ''abcd'' AS Id, ''DC010500'' AS TaxCode UNION
SELECT ''xyz'' AS Id, ''DC010500'' AS TaxCode UNION
SELECT ''zzz'' AS Id, ''DC010500'' AS TaxCode
'
)
put_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 product
<p>Updates product attributes by ID. Use <code>UPDATE Products SET ... WHERE Id='...'</code> with the product ID and the columns you want to change (display name, SKU, prices, tax code, trial settings, etc.).</p>
DECLARE @MyQuery NVARCHAR(MAX) = 'UPDATE Products
SET
Display=''Product ABCD''
, Sku=''PRD-ABCD-01''
, Summary=''Product Abcd **STD**''
, Description=''This product can be used to call **API** supports markdown syntax''
, Action=''**Action** supports markdown''
, TaxCode=''DC010500''
, Image=''https://zappysys.com/api/images/ZappySys-icon.png''
, FulfillmentInstructions=''Thank you for shopping. **Activate** license by using our License App''
, Format=''digital''
, PriceUSD=''101.5''
, PriceEUR=''102.5''
, PriceGBP=''103.5''
, PriceCAD=''104.5''
, PriceNZD=''105.5''
, PriceCHF=''106.5''
, PriceSEK=''107.5''
, PriceCZK=''108.5''
, PriceDKK=''109.5''
, PricePLN=''101.5''
, PriceSGD=''102.5''
, PriceJPY=''103.5''
, PriceCNY=''104.5''
, PriceHKD=''105.5''
, PriceINR=''106.5''
, PriceBRL=''107.5''
, PriceAUD=''108.5''
, Badge=''Badge-1''
, Rank=1
, Trial=14 --how many trial days
, TrialPriceUSD=10.5
--, Renew=1 --not allowed for update : Only for create (enable subscription)
, Interval=''year'' --allowed values: adhoc, day, week, year, only needed if you are creating a subscription
, IntervalLength=1
, IntervalCount=0
, QuantityBehavior=''allow'' --allowed values: allow, lock, hide
, QuantityDefault=1
, Attributes = ''{"mykey-1" : "some-value-1", "mykey-2" : "some-value-2"}''
--, Fulfillments=''[ { fullfillment }, { fullfillment } ... ]'' --JSON fragment
WHERE Id=''abcd''';
EXEC (@MyQuery) AT [LS_TO_FASTSPRING_IN_GATEWAY];
Update multiple products from CSV
<p>Updates multiple products from an external source. Use <code>UPDATE Products SOURCE('ODBC', ...)</code> with a connection string and a <code>SELECT</code> whose column names (or aliases) match the product columns to update (e.g. <code>Id</code>, <code>TaxCode</code>). Works with ZappySys CSV Driver, SQL Server, MySQL, PostgreSQL, or any ODBC source.</p>
DECLARE @MyQuery NVARCHAR(MAX) = 'UPDATE Products
SOURCE(''ODBC'',
--File input example (use as to match Column name allowed in Products Table to write)
--''Driver={ZappySys CSV Driver};DataPath=c:\data\products.csv'',
--''SELECT P_ID AS Id,P_TAXCODE AS TaxCode FROM $''
--Direct input example
''Driver={ZappySys CSV Driver}'',
''SELECT ''''abcd'''' AS Id, ''''DC010500'''' AS TaxCode UNION
SELECT ''''xyz'''' AS Id, ''''DC010500'''' AS TaxCode UNION
SELECT ''''zzz'''' AS Id, ''''DC010500'''' AS TaxCode
''
)';
EXEC (@MyQuery) AT [LS_TO_FASTSPRING_IN_GATEWAY];
put_product endpoint belongs to
Products
table(s), and can therefore be used via those table(s).