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]

Parameters

Parameter

Label

Required

Options

Description

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

Option	Value
true	true
false	false

description

Description

caption

Caption (Can be set if Type = good)

package_dimensions_height

Package Dimensions - Height (inch) (Can be set if Type = good)

package_dimensions_length

Package Dimensions - Length (inch) (Can be set if Type = good)

package_dimensions_weight

Package Dimensions - Weight (inch) (Can be set if Type = good)

package_dimensions_width

Package Dimensions - Width (inch) (Can be set if Type = good)

shippable

Shippable (Can be set if Type = good)

Option	Value
True	True
False	False

statement_descriptor

Statement Description (Can be set if Type = service)

unit_label

Unit Label (Can be set if Type = service)

url

Product URL (Can be set if Type = good)

image1

Image1

image2

Image2

image3

Image3

image4

Image4

image5

Image5

image6

Image6

image7

Image7

image8

Image8

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
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`

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
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