Product resource

Methods

  • get - Get product detail by Id
  • get - Get product detail by store identifier
  • patch - Patch or create product by store identifier

Resource

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

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", "outofstock", "unverified" and "discontinued"

Possible values are:

  • instock
  • outofstock
  • unverified
  • discontinued
 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
createdAt date-time

The date of product created in Connectif catalog in ISO8601 format
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
id string

The Connectif Catalog identifier of the product
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.

 Optional
name string

The name of the product
priority integer

Priority or preference level of this product

 Optional
productDetailUrl string

The detail url of the product, must be accessible
productId string

The external id of the product in your store
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
updatedAt date-time

The date of the last product update in ISO8601 format

 Optional