Patch or create product by store identifier

Request

PATCH https://api.connectif.cloud/products/product-id/{id}

Path parameters

Parameter name Value Description Additional
id string

Store identifier of the product to patch or create

Required

Request body

The request body takes a complete ProductCreation resource, containing the following writable properties:

{
    "availability": "string",
    "brand": "string",
    "categories": [
        "string"
    ],
    "customField1": "string",
    "customField2": "string",
    "customField3": "string",
    "description": "string",
    "discountedAmount": "number",
    "discountedPercentage": "number",
    "imageUrl": "string",
    "inStockUnits": "integer",
    "isBlacklisted": "boolean",
    "name": "string",
    "priority": "integer",
    "productDetailUrl": "string",
    "publishedAt": "date-time",
    "rating": "number",
    "ratingCount": "integer",
    "relatedExternalProductIds": [
        "string"
    ],
    "reviewCount": "integer",
    "tags": [
        "string"
    ],
    "thumbnailUrl": "string",
    "unitPrice": "number",
    "unitPriceOriginal": "number",
    "unitPriceWithoutVAT": "number"
}

Properties

Name Type Description Additional
availability string

It defines the availability of the product in the store and can have any of the next values "instock" and "outofstock. The default value for this field is instock"

Possible values are:

  • instock
  • outofstock
Optional
brand string

The brand of the product

Optional
categories[] array of string

The categories of the product. In case of sub-categories the symbol "/" must be used to represent the hierarchy, i.e.: [ "Latest Arrivals", "Pc/Keyboards/Special" ]

Optional
customField1 string

Field reserved for custom purposes 1

Optional
customField2 string

Field reserved for custom purposes 2

Optional
customField3 string

Field reserved for custom purposes 3

Optional
description string

The description of the product

Optional
discountedAmount number

The price of the product discounted comparing with unitPrice

Optional
discountedPercentage number

The discount percentage of the product comparing unitPrice with unitPriceOriginal

Optional
imageUrl string

The image url of the product

Optional
inStockUnits integer

The number of items in stock of the product

Optional
isBlacklisted boolean

This field indicates if the product is in the recommendation black list. If true the product won't never show up in product recommendation retrieved by the Workflow Node Get Products. The default value is false.

Optional
name string

The name of the product

priority integer

Priority or preference level of this product. The default value is 0.

Optional
productDetailUrl string

The detail url of the product, must be accessible

publishedAt date-time

Date in ISO8601 format of the first time the product appeared in the store catalog

Optional
rating number

The product rating

Optional
ratingCount integer

The number of ratings of the product

Optional
relatedExternalProductIds[] array of string

Array containing customer store product id related with this product

Optional
reviewCount integer

The number of reviews of the product

Optional
tags[] array of string

The tags of the product

Optional
thumbnailUrl string

The image thumbnail url of the product

Optional
unitPrice number

The unit price of the product

unitPriceOriginal number

The unit price of the product before applying any discount

Optional
unitPriceWithoutVAT number

The unit price of the product before applying any taxes

Optional

Authorization

This request requires the use of one of following authorization methods: API key .

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

Success.

Product
201 Created

Success.

Product
400 Bad Request

Bad request, i.e.: invalid json.

HttpError
401 Unauthorized

Not authorized to access API.

403 Forbidden

Permission not granted to the API Key or account has been blocked.

HttpError
415 Unsupported Media Type

Request without application/json Content-Type header.

HttpError
422 Unprocessable Entity

Resource contains validation errors.

HttpUnprocessableEntityError
429 Too Many Requests

Requests rate limit reached.