API Reference
Products

Update a product

1min
PATCH
Calling this endpoint will allow you to amend core attributes of the products via API. The attributes that can be amended are: name, description, type, productListReference, and contractReferences.
Authentication
Authorization
Path Parameters
productReference
*
Header Parameters
X-TokenId
X-SessionId
X-Version
*
Origin
Body Parameters
patchRequest
*
value
path
op
from
Responses
200
OK
Description
Response dto for Products.
productReference
name
description
type
status
productListReferences
createdDate
lastUpdatedDate
productParameters
pricing
images
credits
contractPricing
400
Bad Request <br />Product names cannot exceed 128 characters <br />Product descriptions cannot exceed 850 characters <br />Invalid product type provided, please provide either Digital or Physical <br />Invalid status provided. Please provide a status of Active or Inactive <br />Invalid PATCH operation <br />Invalid PATCH path <br />Invalid Contract type provided
401
Not Authorized
404
Not Found <br />Product cannot be found <br />Product list cannot be found <br />Product list is not associated to the product <br />Contract cannot be found
409
Conflict <br />A product already exists with the name provided <br />Contract {ContractReference} is already associated with product <br />Duplicate Contract reference provided
500
Internal Server Error
ο»Ώ

ο»Ώ

πŸ€”
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.

ο»Ώ