Salta ai contenuti
Wine SuiteWine SuiteManuale Wine Suite

List products with filters

POST
/v2/product-catalog/products/query
curl --request POST \
  --url https://api-crm-staging.divinea.com/api/v2/product-catalog/products/query \
  --header 'APIKey: <APIKey>' \
  --header 'Content-Type: application/json' \
  --data '{ "activeChannelsOnly": true, "categoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "includeInactive": true, "statuses": [ "example" ] }'

Authorizations

Sezione intitolata “Authorizations”

Request Body

Sezione intitolata “Request Body”

Request

Media typeapplication/json
ListProductsRequest
object
activeChannelsOnly
boolean
categoryId
string format: uuid
includeInactive
boolean
statuses
Array<string>
Examplegenerated
{
  "activeChannelsOnly": true,
  "categoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "includeInactive": true,
  "statuses": [
    "example"
  ]
}

Responses

Sezione intitolata “Responses”

200

Sezione intitolata “200”

OK

Media type*/*
Array<object>
ProductCatalogProduct
object
active
boolean
attributeAssignments
Array<object>
ProductAttributeAssignment
object
attributeId
integer format: int64
attributeValueId
integer format: int64
createdAt
string format: date-time
id
integer format: int64
productId
string format: uuid
barcode
string
categories
Array<object>
ProductCatalogCategory
object
categoryId
ProductCatalogCategoryId
object
id
string format: uuid
descriptionTranslationId
string
descriptionTranslations
object
key
additional properties
string
id
string format: uuid
nameEn
string
nameIt
string
nameTranslationId
string
nameTranslations
object
key
additional properties
string
parentCategoryId
string format: uuid
priority
integer format: int32
productsCount
integer format: int32
wineryId
string format: uuid
channels
Array<object>
ProductCatalogChannel
object
active
boolean
id
string format: uuid
maxUnitsPerOrder
integer format: int32
priceCents
integer format: int64
wineryChannelId
string format: uuid
defaultVatRate
number
descriptionEn
string
descriptionIt
string
descriptionTranslationId
string
descriptionTranslations
object
key
additional properties
string
displayOrder
integer format: int32
displayStatus
string
files
Array<object>
Map«string,object»
object
key
additional properties
object
fiscalNatureId
string format: uuid
hasVariants
boolean
id
string format: uuid
inventoryQuantity
integer format: int32
inventoryTrackingActive
boolean
isBundle
boolean
isGiftCard
boolean
metaDescriptionTranslationId
string
metaTitleTranslationId
string
metadata
Array<object>
ProductMetadata
object
active
boolean
id
integer format: int64
metadataName
string
metadataValue
string
productId
string format: uuid
updatedAt
string format: date-time
validityFrom
string format: date
validityTo
string format: date
nameEn
string
nameIt
string
nameTranslationId
string
nameTranslations
object
key
additional properties
string
orderingAll
integer format: int32
orderingCategory
integer format: int32
pointOfSaleWineSuiteId
string format: uuid
posNameTranslationId
string
posNameTranslations
object
key
additional properties
string
priceCents
integer format: int64
priceCurrency
string
productId
string format: uuid
publishedAt
string format: date-time
shortDescriptionTranslationId
string
showPos
boolean
showWebsite
boolean
sku
string
status
string
Allowed values: ACTIVE ARCHIVED DRAFT
typeId
string
unitsPerCase
integer format: int32
validityFrom
string format: date
validityTo
string format: date
variantCount
integer format: int32
variantMasterId
string format: uuid
variantMinPriceCents
integer format: int64
weight
number format: double
wineryId
string format: uuid