Update or create a product (upsert) | Solvimon

Requires the PRODUCT.CREATE or PRODUCT.UPDATE permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

Query parameters

identifier_fieldstringOptional

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

custom_field_referencestringOptional

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

field_actionsmap from strings to stringsOptional

The list of actions for specific fields.

Request

This endpoint expects an object.

category_idstringRequired

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

namestringRequiredformat: "^.*$"0-256 characters

referencestringRequiredformat: "^\S+$"0-256 characters

product_typeenumRequired

Allowed values:

categoryobject or nullOptional

parent_product_idstring or nullOptional

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

descriptionstring or nullOptionalformat: "^.*$"0-256 characters

statusenum or nullOptional

The status of the product.

Allowed values:

tax_categoryenum or nullOptional

The default tax category applied to the product.

Allowed values:

featureslist of objects or nullOptional

The features associated with the product.

custom_fieldslist of objects or nullOptional

display_orderinteger or nullOptional

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

linked_integrationslist of objects or nullOptional

billing_entity_idstring or nullOptional

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

Response

Created

category_idstring

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

namestringformat: "^.*$"0-256 characters

referencestringformat: "^\S+$"0-256 characters

product_typeenum

Allowed values:

object_typestring or nullRead-only

idstring or nullRead-only

categoryobject or null

parent_product_idstring or null

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

descriptionstring or nullformat: "^.*$"0-256 characters

statusenum or null

The status of the product.

Allowed values:

tax_categoryenum or null

The default tax category applied to the product.

Allowed values:

featureslist of objects or null

The features associated with the product.

custom_fieldslist of objects or null

display_orderinteger or null

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

linked_integrationslist of objects or null

billing_entity_idstring or null

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

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	curl -X PUT https://test.api.solvimon.com/v1/products \
2	-H "X-API-KEY: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"category_id": "cat_987654321",
6	"name": "Premium Cloud Storage",
7	"reference": "premium_cloud_storage_001",
8	"product_type": "DEFAULT",
9	"custom_fields": [
10	{
11	"reference": "storage_capacity",
12	"value": "1TB"
13	}
14	]
15	}'

1	{
2	"category_id": "cat_987654321",
3	"name": "Premium Cloud Storage",
4	"reference": "premium_cloud_storage_001",
5	"product_type": "DEFAULT",
6	"object_type": "PRODUCT",
7	"id": "prod_123456789",
8	"category": {
9	"name": "Cloud Services",
10	"reference": "cloud_services",
11	"object_type": "PRODUCT_CATEGORY",
12	"id": "cat_987654321",
13	"description": "Category for all cloud-based service products",
14	"tax_category": "STANDARD",
15	"display_order": 10
16	},
17	"parent_product_id": "prod_000000001",
18	"description": "High capacity cloud storage solution with enhanced security features.",
19	"status": "DRAFT",
20	"tax_category": "STANDARD",
21	"features": [
22	{
23	"reference": "encryption_feature",
24	"id": "feat_001"
25	}
26	],
27	"custom_fields": [
28	{
29	"id": "cf_123",
30	"reference": "storage_capacity",
31	"value": "1TB",
32	"values": [
33	"500GB",
34	"1TB",
35	"2TB"
36	],
37	"integration_details": {
38	"payment_gateway_variant": "ADYEN",
39	"id": "int_456",
40	"reference": "payment_gateway_adyen",
41	"adyen": {
42	"recurring_detail_reference": "recurring_789"
43	},
44	"stripe": {
45	"payment_method_id": "pm_abc123"
46	}
47	}
48	}
49	],
50	"display_order": 5,
51	"linked_integrations": [
52	{
53	"id": "int_001",
54	"link_details": [
55	{
56	"url": "https://dashboard.solvimon.com/integrations/adyen",
57	"custom_field_name": "payment_gateway"
58	}
59	]
60	}
61	],
62	"billing_entity_id": "bill_ent_321"
63	}

Authentication

Path parameters

Headers

Query parameters

Request

Response

Errors