Skip to main content
Post Product

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category" Default = show all fields.

Body

The Product to be saved.

Information about a Product from the ERP system. This may be fetched from SuperOffice Product table through the SO Connector Carrier object for Product. Services for the Product Carrier is available from the Quote Agent.

ProductId
integer<int32>

Primary key

ERPProductKey
string

Reference/foreign key to the product in the given pricelist in the product supplier system, if it exists there.

ERPPriceListKey
string

Foreign key to the price list that this product is a part of, or the primary key of the pricelist if this is a built-in pricelist.

Name
string

The name to use in the user interface.

Description
string

The description to use, with potentially several lines. Will be used as tool-tip to use in the list user interface too.

Code
string

The product code / article number in the product supplier system.

PriceUnit
string

What is the unit (meter, ton, bushel, microsecond, gradus, τρυβλίον, 五合枡, دونم or whatever); read-only for lines that originate in defined products

QuantityUnit
string

What is the unit (meter, ton, bushel, microsecond, gradus, τρυβλίον, 五合枡, دونم or whatever); Connector handles conversion relative to PriceUnit if they are different

IsSubscription
boolean

Is this a subscription product, sold in repeating intervals/amounts?

SubscriptionUnit
string

Either a List id to an id from a connector provided list, or, if the connection doesn’t support lists, a text with the actual subscription unit.

DefaultSubscriptionQuantity
number<double>

The default number of SubscriptionUnits to suggest when creating quote lines from this product

ItemNumber
string

Line item number, NOR: «Postnummer». Specific numbers from some hierarchy, for instance “1.4.3.2P”. Typically used to sort the items in the quote by some standard way.

Url
string

URL to product information web page.

ProductCategoryKey
string

Either a List id to an id from a connector provided list, or, if the connection doesn’t support lists, a text with the actual product category.

ProductFamilyKey
string

Either a List id to an id from a connector provided list, or, if the connection doesn't support lists, a text with the actual product family.

ProductTypeKey
string

Either a List id to an id from a connector provided list, or, if the connection doesn’t support lists, a text with the actual product type.

VAT
number<double>

Tax/VAT if available from ERP system. THIS IS A PERCENTAGE. In the Superoffice product register, this field is available in the product admin GUI.

VATInfo
string

A field for putting VATInfo you need to show in the final quoteDocument, like the VAT type that is used. Not used in any business logic in SuperOffice; available to document templates.

UnitCost
number<double>

The cost price. Might not be given, use Decimal.MinValue to signal this.

UnitMinimumPrice
number<double>

The minimum price this salesman can offer to his customer. This might be cost price if there is no policy. Might not be given, use Decimal.MinValue to signal this.

UnitListPrice
number<double>

(Basic Price, normal price, standard price.) This is the basic price from which the discount is computed from. The ListPrice will stay the same even when a larger amount is ordered.

InAssortment
boolean

True for products that should currently be offered, false when the product is discontinued and should not ordinarily be offered. When false the product no longer appears in search results.

Supplier
string

In SuperOffice, an id from the contact table, when saved as an ERP cache, the name of the supplier

SupplierCode
string

Suppliers part code/number or other key-like field

Rights
string

Field1=right&Field2=right, etc. of any fields that have non-standard field access rights. Rights can be one of: N (=None or Hidden), R (=Read-only), W (=Writeable), M (=Mandatory). The fields will mostly be from the Quoteline table, but some added fields that are conceptually part of the quoteline, like Image will also be possibly to set rights on. Will be used by SuperOffice to control the user interface when showing the record.

Rule
string

The names of one or more calculation rules that are in effect for this line, comma-separated case-insensitive. Will NOT be used by SuperOffice.

ExtraInfo
object[]

Extra information, supplied by QuoteConnector, used by a future dynamic GUI extension

RawExtraInfo
string

Read-only extra information in plain text, supplied by QuoteConnector, used by a future dynamic GUI extension

ExtraField1
string

This a simple field for adding information that the Connector can provide, and that the qoute document need to display.

ExtraField2
string

This a simple field for adding information that the Connector can provide, and that the qoute document need to display.

ExtraField3
string

This a simple field for adding information that the Connector can provide, and that the qoute document need to display.

ExtraField4
string

This a simple field for adding information that the Connector can provide, and that the qoute document need to display.

ExtraField5
string

This a simple field for adding information that the Connector can provide, and that the qoute document need to display.

InStock
number<double>

Negative numbers will be interpreted as how many is ordered. Might not be available.

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.

Response

OK

Information about a Product from the ERP system. This may be fetched from SuperOffice Product table through the SO Connector Carrier object for Product. Services for the Product Carrier is available from the Quote Agent.

ProductId
integer<int32>

Primary key

ERPProductKey
string

Reference/foreign key to the product in the given pricelist in the product supplier system, if it exists there.

ERPPriceListKey
string

Foreign key to the price list that this product is a part of, or the primary key of the pricelist if this is a built-in pricelist.

Name
string

The name to use in the user interface.

Description
string

The description to use, with potentially several lines. Will be used as tool-tip to use in the list user interface too.

Code
string

The product code / article number in the product supplier system.

PriceUnit
string

What is the unit (meter, ton, bushel, microsecond, gradus, τρυβλίον, 五合枡, دونم or whatever); read-only for lines that originate in defined products

QuantityUnit
string

What is the unit (meter, ton, bushel, microsecond, gradus, τρυβλίον, 五合枡, دونم or whatever); Connector handles conversion relative to PriceUnit if they are different

IsSubscription
boolean

Is this a subscription product, sold in repeating intervals/amounts?

SubscriptionUnit
string

Either a List id to an id from a connector provided list, or, if the connection doesn’t support lists, a text with the actual subscription unit.

DefaultSubscriptionQuantity
number<double>

The default number of SubscriptionUnits to suggest when creating quote lines from this product

ItemNumber
string

Line item number, NOR: «Postnummer». Specific numbers from some hierarchy, for instance “1.4.3.2P”. Typically used to sort the items in the quote by some standard way.

Url
string

URL to product information web page.

ProductCategoryKey
string

Either a List id to an id from a connector provided list, or, if the connection doesn’t support lists, a text with the actual product category.

ProductFamilyKey
string

Either a List id to an id from a connector provided list, or, if the connection doesn't support lists, a text with the actual product family.

ProductTypeKey
string

Either a List id to an id from a connector provided list, or, if the connection doesn’t support lists, a text with the actual product type.

VAT
number<double>

Tax/VAT if available from ERP system. THIS IS A PERCENTAGE. In the Superoffice product register, this field is available in the product admin GUI.

VATInfo
string

A field for putting VATInfo you need to show in the final quoteDocument, like the VAT type that is used. Not used in any business logic in SuperOffice; available to document templates.

UnitCost
number<double>

The cost price. Might not be given, use Decimal.MinValue to signal this.

UnitMinimumPrice
number<double>

The minimum price this salesman can offer to his customer. This might be cost price if there is no policy. Might not be given, use Decimal.MinValue to signal this.

UnitListPrice
number<double>

(Basic Price, normal price, standard price.) This is the basic price from which the discount is computed from. The ListPrice will stay the same even when a larger amount is ordered.

InAssortment
boolean

True for products that should currently be offered, false when the product is discontinued and should not ordinarily be offered. When false the product no longer appears in search results.

Supplier
string

In SuperOffice, an id from the contact table, when saved as an ERP cache, the name of the supplier

SupplierCode
string

Suppliers part code/number or other key-like field

Rights
string

Field1=right&Field2=right, etc. of any fields that have non-standard field access rights. Rights can be one of: N (=None or Hidden), R (=Read-only), W (=Writeable), M (=Mandatory). The fields will mostly be from the Quoteline table, but some added fields that are conceptually part of the quoteline, like Image will also be possibly to set rights on. Will be used by SuperOffice to control the user interface when showing the record.

Rule
string

The names of one or more calculation rules that are in effect for this line, comma-separated case-insensitive. Will NOT be used by SuperOffice.

ExtraInfo
object[]

Extra information, supplied by QuoteConnector, used by a future dynamic GUI extension

RawExtraInfo
string

Read-only extra information in plain text, supplied by QuoteConnector, used by a future dynamic GUI extension

ExtraField1
string

This a simple field for adding information that the Connector can provide, and that the qoute document need to display.

ExtraField2
string

This a simple field for adding information that the Connector can provide, and that the qoute document need to display.

ExtraField3
string

This a simple field for adding information that the Connector can provide, and that the qoute document need to display.

ExtraField4
string

This a simple field for adding information that the Connector can provide, and that the qoute document need to display.

ExtraField5
string

This a simple field for adding information that the Connector can provide, and that the qoute document need to display.

InStock
number<double>

Negative numbers will be interpreted as how many is ordered. Might not be available.

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.