Endpoint Create a Product
Name
create_product
Description
Creates a new product. [API reference]
Related Tables
Parameters
| Parameter | Required | Options | ||||||
|---|---|---|---|---|---|---|---|---|
|
Name:
Label: Name |
YES | |||||||
|
Name:
Label: Type (Good or Service) |
YES |
|
||||||
|
Name:
Label: Active |
|
|||||||
|
Name:
Label: Description |
||||||||
|
Name:
Label: Caption (Can be set if Type = good) |
||||||||
|
Name:
Label: Package Dimensions - Height (inch) (Can be set if Type = good) |
||||||||
|
Name:
Label: Package Dimensions - Length (inch) (Can be set if Type = good) |
||||||||
|
Name:
Label: Package Dimensions - Weight (inch) (Can be set if Type = good) |
||||||||
|
Name:
Label: Package Dimensions - Width (inch) (Can be set if Type = good) |
||||||||
|
Name:
Label: Shippable (Can be set if Type = good) |
|
|||||||
|
Name:
Label: Statement Description (Can be set if Type = service) |
||||||||
|
Name:
Label: Unit Label (Can be set if Type = service) |
||||||||
|
Name:
Label: Product URL (Can be set if Type = good) |
||||||||
|
Name:
Label: Image1 |
||||||||
|
Name:
Label: Image2 |
||||||||
|
Name:
Label: Image3 |
||||||||
|
Name:
Label: Image4 |
||||||||
|
Name:
Label: Image5 |
||||||||
|
Name:
Label: Image6 |
||||||||
|
Name:
Label: Image7 |
||||||||
|
Name:
Label: Image8 |
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 |
|---|---|---|---|---|
| Name |
DT_WSTR
|
nvarchar(100)
|
100 | |
| Caption |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Description |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Type |
DT_WSTR
|
nvarchar(100)
|
100 | |
| Active |
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 | |
| Shippable |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Image1 |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Image2 |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Image3 |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Image4 |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Image5 |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Image6 |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Image7 |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Image8 |
DT_WSTR
|
nvarchar(4000)
|
4000 |
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 | |
|---|---|
| Name | Fill-in the parameter... |
| Type (Good or Service) | Fill-in the parameter... |
| Optional Parameters | |
| Active | |
| Description | |
| Caption (Can be set if Type = good) | |
| Package Dimensions - Height (inch) (Can be set if Type = good) | |
| Package Dimensions - Length (inch) (Can be set if Type = good) | |
| Package Dimensions - Weight (inch) (Can be set if Type = good) | |
| Package Dimensions - Width (inch) (Can be set if Type = good) | |
| Shippable (Can be set if Type = good) | |
| Statement Description (Can be set if Type = service) | |
| Unit Label (Can be set if Type = service) | |
| Product URL (Can be set if Type = good) | |
| Image1 | |
| Image2 | |
| Image3 | |
| Image4 | |
| Image5 | |
| Image6 | |
| Image7 | |
| Image8 | |
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 create a product:
| Required Parameters | |
|---|---|
| Name | Fill-in the parameter... |
| Type (Good or Service) | Fill-in the parameter... |
| Optional Parameters | |
| Active | |
| Description | |
| Caption (Can be set if Type = good) | |
| Package Dimensions - Height (inch) (Can be set if Type = good) | |
| Package Dimensions - Length (inch) (Can be set if Type = good) | |
| Package Dimensions - Weight (inch) (Can be set if Type = good) | |
| Package Dimensions - Width (inch) (Can be set if Type = good) | |
| Shippable (Can be set if Type = good) | |
| Statement Description (Can be set if Type = service) | |
| Unit Label (Can be set if Type = service) | |
| Product URL (Can be set if Type = good) | |
| Image1 | |
| Image2 | |
| Image3 | |
| Image4 | |
| Image5 | |
| Image6 | |
| Image7 | |
| Image8 | |
ODBC application
Use these SQL queries in your ODBC application data source:
Inserts a Product
Inserts a product
INSERT INTO Products
( [Name]
, [Caption]
, [Description]
, [Type]
--, [UnitLabel] --only when product type=service
, [Active]
, [PackageDimensionsHeight]
, [PackageDimensionsWidth]
, [PackageDimensionsLength]
, [PackageDimensionsWeight]
, [URL]
, [Image1]
, [Image2]
, [Image3]
)
VALUES('SSIS PowerPack 3'
, 'SSIS Caption 3'
, 'SSIS PowerPack description long ....'
, 'good' --or service
--, 'Unit label' --only when product type=service
, 'True' --active ?
, '12'
, '13'
, '14'
, '1000'
, 'https://zappysys.com/products/ssis-powerpack/'
, 'https://zappysys.com/images/tech/web-api-logo.png'
, 'https://zappysys.com/images/tech/xml-logo.png'
, 'https://zappysys.com/images/tech/salesforce-logo.png'
)
create_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:
Inserts a Product
Inserts a product
DECLARE @MyQuery NVARCHAR(MAX) = 'INSERT INTO Products
( [Name]
, [Caption]
, [Description]
, [Type]
--, [UnitLabel] --only when product type=service
, [Active]
, [PackageDimensionsHeight]
, [PackageDimensionsWidth]
, [PackageDimensionsLength]
, [PackageDimensionsWeight]
, [URL]
, [Image1]
, [Image2]
, [Image3]
)
VALUES(''SSIS PowerPack 3''
, ''SSIS Caption 3''
, ''SSIS PowerPack description long ....''
, ''good'' --or service
--, ''Unit label'' --only when product type=service
, ''True'' --active ?
, ''12''
, ''13''
, ''14''
, ''1000''
, ''https://zappysys.com/products/ssis-powerpack/''
, ''https://zappysys.com/images/tech/web-api-logo.png''
, ''https://zappysys.com/images/tech/xml-logo.png''
, ''https://zappysys.com/images/tech/salesforce-logo.png''
)';
EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];
create_product endpoint belongs to
Products
table(s), and can therefore be used via those table(s).