products

Update or create a product (upsert)

Requires the PRODUCT.CREATE or PRODUCT.UPDATE permission.

put/v{version}/products

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/products
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

Query parameters

identifier_fieldstring

Which field to use to identify whether the resource exists or not

custom_field_referencestring

Which custom field to use to identify whether the resource exists or not

field_actionsobject

The list of actions for specific fields.

Headers

x-platform-idstring

Platform ID.

Request body

object_typestring nullable
idstring nullable
category_idstring

The resource ID of the product category, that belongs to the product.

parent_product_idstring nullable

The resource ID of the original product, to which the product will belong to.

namestring
referencestring
descriptionstring nullable
status'DRAFT' | 'ACTIVE' | 'ARCHIVED' | 'DEPRECATED'

The status of the product.

product_type'DEFAULT' | 'ADDON'
tax_category'STANDARD' | 'NO_TAX' | 'EXEMPT'

The default tax category applied to the product.

display_orderinteger nullable

Determines the order in which products are displayed on overview pages and invoices. The lowest number gets the highest priority.

billing_entity_idstring nullable

The resource ID of the billing entity linked to this product.

customer_idstring nullable

Response

Created

object_typestring nullable
idstring nullable
category_idstring

The resource ID of the product category, that belongs to the product.

parent_product_idstring nullable

The resource ID of the original product, to which the product will belong to.

namestring
referencestring
descriptionstring nullable
status'DRAFT' | 'ACTIVE' | 'ARCHIVED' | 'DEPRECATED'

The status of the product.

product_type'DEFAULT' | 'ADDON'
tax_category'STANDARD' | 'NO_TAX' | 'EXEMPT'

The default tax category applied to the product.

display_orderinteger nullable

Determines the order in which products are displayed on overview pages and invoices. The lowest number gets the highest priority.

billing_entity_idstring nullable

The resource ID of the billing entity linked to this product.

customer_idstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.