products

Archive a product

Requires the PRODUCT.STATUS.UPDATE permission.

post/v{version}/products/{resourceIdOrReference}/archive

Request

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

Path parameters

versionstring required

version

resourceIdOrReferencestring required

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

Query parameters

align_product_item_statusboolean

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

Headers

x-platform-idstring

Platform ID.

Response

OK

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.