Archive a product | Solvimon

curl -X POST https://test.api.solvimon.com/v1/products//archive \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "category_id": "b7e2f1a4-3c5d-4e6f-8a9b-0c1d2e3f4a5b",
  "name": "Wireless Bluetooth Headphones",
  "reference": "WBH-2024",
  "product_type": "DEFAULT",
  "object_type": "product",
  "id": "a3f1c9d2-7b4e-4f8a-9c3d-2e5b7f6a1d9e",
  "category": {
    "name": "Electronics",
    "reference": "ELEC-001",
    "object_type": "category",
    "id": "b7e2f1a4-3c5d-4e6f-8a9b-0c1d2e3f4a5b",
    "description": "Category for all electronic devices and accessories",
    "tax_category": "STANDARD",
    "display_order": 10
  },
  "parent_product_id": "d4f5e6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
  "description": "High-quality wireless headphones with noise cancellation",
  "status": "DRAFT",
  "tax_category": "STANDARD",
  "features": [
    {
      "reference": "FEATURE-BLUETOOTH-5.0",
      "id": "f1a2b3c4-d5e6-7f8a-9b0c-1d2e3f4a5b6c"
    }
  ],
  "custom_fields": [
    {
      "id": "c1d2e3f4-a5b6-c7d8-e9f0-123456789abc",
      "reference": "CUSTOM-WARRANTY",
      "value": "2 years",
      "values": [
        "1 year",
        "2 years",
        "3 years"
      ],
      "integration_details": {
        "payment_gateway_variant": "ADYEN",
        "id": "int-9876543210",
        "reference": "INT-ADYEN-001",
        "adyen": {
          "recurring_detail_reference": "recurring-ref-12345"
        },
        "stripe": {
          "payment_method_id": "pm_1GqIC8Lz0qyl6XeWzXxYz123"
        }
      }
    }
  ],
  "display_order": 5,
  "linked_integrations": [
    {
      "id": "int-1234567890",
      "link_details": [
        {
          "url": "https://integration.example.com/product/wireless-headphones",
          "custom_field_name": "integration_link"
        }
      ]
    }
  ],
  "billing_entity_id": "billing-entity-001"
}

Requires the PRODUCT.STATUS.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

resourceIdOrReferencestringRequiredDefaults to

The ID of the resource for which the action is posted.

Query parameters

align_product_item_statusbooleanOptional

Updates the status of product items to the status of the Product, e.g. if theDD Product is Activated, the product items are activated

Response

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

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors