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_idstringOptional

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

categoryobject or nullOptional

parent_product_idstring or nullOptional

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

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

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

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

statusenum or nullOptional

The status of the product.

Allowed values:

product_typeenumOptional

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

object_typestring or nullRead-only

idstring or nullRead-only

category_idstring

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

categoryobject or null

parent_product_idstring or null

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

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

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

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

statusenum or null

The status of the product.

Allowed values:

product_typeenum

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.

customer_idstring or nullRead-only

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	"reference": "prod-2024-001",
6	"custom_fields": [
7	{
8	"reference": "color",
9	"value": "red"
10	}
11	]
12	}'

1	{
2	"object_type": "PRODUCT",
3	"id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
4	"category_id": "cat-12345",
5	"category": {
6	"object_type": "PRODUCT_CATEGORY",
7	"id": "cat-12345",
8	"name": "Electronics",
9	"reference": "electronics",
10	"description": "Category for electronic devices and accessories",
11	"tax_category": "STANDARD",
12	"display_order": 10,
13	"customer_id": "cust-67890"
14	},
15	"parent_product_id": "parent-prod-001",
16	"name": "Wireless Headphones",
17	"reference": "prod-2024-001",
18	"description": "High-quality wireless headphones with noise cancellation",
19	"status": "DRAFT",
20	"product_type": "DEFAULT",
21	"tax_category": "STANDARD",
22	"features": [
23	{
24	"id": "feat-98765",
25	"reference": "bluetooth"
26	}
27	],
28	"custom_fields": [
29	{
30	"id": "cf-54321",
31	"reference": "color",
32	"value": "red",
33	"values": [
34	"red",
35	"black",
36	"white"
37	],
38	"integration_details": {
39	"id": "int-11223",
40	"reference": "stripe-integration",
41	"payment_gateway_variant": "ADYEN",
42	"adyen": {
43	"recurring_detail_reference": "recurring-ref-001"
44	},
45	"stripe": {
46	"payment_method_id": "pm_1GqIC8Lz0qyl6XeWz5aX9b2Y"
47	}
48	}
49	}
50	],
51	"display_order": 100,
52	"linked_integrations": [
53	{
54	"id": "link-33445",
55	"link_details": [
56	{
57	"url": "https://integration.example.com/product/prod-2024-001",
58	"custom_field_name": "integration_url"
59	}
60	]
61	}
62	],
63	"billing_entity_id": "billing-entity-7890",
64	"customer_id": "cust-67890"
65	}

Authentication

Path parameters

Headers

Query parameters

Request

Response

Errors