COMMERCE QUERY
/
Query API 3.0
/
Products
/
Gets all product up-sell relations. Maps from the unified ProductRelation model, filtering by the "upsell" relation type.

Query (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://norcecommerce.api-se.norce.tech/commerce/query/3.0/

Schemas

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Gets all product cross-sell relations. Maps from the unified ProductRelation model, filtering by the "crosssell" relation type.

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Products/ProductCrossell \
  -H 'ApplicationId: 0'

Responses

A queryable collection of product cross-sell relations.

Bodyapplication/jsonArray [
productIdinteger(int32)
clientIdinteger(int32)
crossellProductIdinteger(int32)
sortOrderinteger or null(int32)
populationRuleIdinteger or null(int32)
isActiveboolean
createdstring(date-time)
createdByinteger(int32)
updatedstring or null(date-time)
updatedByinteger or null(int32)
isProductVariantUniqueboolean
isCrossellProductVariantUniqueboolean
]
Response
application/json
[
  {
    "productId": 0,
    "clientId": 0,
    "crossellProductId": 0,
    "sortOrder": 0,
    "populationRuleId": 0,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "isProductVariantUnique": true,
    "isCrossellProductVariantUnique": true
  }
]

Gets all product up-sell relations. Maps from the unified ProductRelation model, filtering by the "upsell" relation type.

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Products/ProductUpsell \
  -H 'ApplicationId: 0'

Responses

A queryable collection of product up-sell relations.

Bodyapplication/jsonArray [
productIdinteger(int32)
clientIdinteger(int32)
upsellProductIdinteger(int32)
defaultDescriptionstring or null
sortOrderinteger or null(int32)
populationRuleIdinteger or null(int32)
isActiveboolean
createdstring(date-time)
createdByinteger(int32)
updatedstring or null(date-time)
updatedByinteger or null(int32)
isProductVariantUniqueboolean
isUpsellProductVariantUniqueboolean
culturesArray of objects(ProductUpsellCulture)
]
Response
application/json
[
  {
    "productId": 0,
    "clientId": 0,
    "upsellProductId": 0,
    "defaultDescription": "string",
    "sortOrder": 0,
    "populationRuleId": 0,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "isProductVariantUnique": true,
    "isUpsellProductVariantUnique": true,
    "cultures": [ … ]
  }
]

Gets all product relations (all types).

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Products/ProductRelations \
  -H 'ApplicationId: 0'

Responses

A queryable collection of all product relations.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the product relation.

clientIdinteger(int32)

The client identifier.

productIdinteger(int32)

The identifier of the product having the relation.

relatedProductIdinteger(int32)

The identifier of the related product.

typeIdinteger(int32)

The product relation type identifier.

sortOrderinteger or null(int32)

The sort order for display purposes.

populationRuleIdinteger or null(int32)

The population rule identifier, if the relation is automatically created.

isProductVariantUniqueboolean

Indicates whether the product with the relation is a specific variant.

isRelatedProductVariantUniqueboolean

Indicates whether the related product is a specific variant.

defaultNamestring or null[ 0 .. 255 ] characters

The default name of the related product, overrides the related product's name, not commonly used.

defaultSubHeaderstring or null[ 0 .. 255 ] characters

The default sub header of the related product, overrides the related product's sub header, not commonly used.

defaultSubDescriptionstring or null

The default sub description of the related product, overrides the related product's sub description, not commonly used.

defaultDescriptionHeaderstring or null[ 0 .. 255 ] characters

The default description header of the related product, overrides the related product's description header, not commonly used.

defaultDescriptionstring or null

The default description of the related product, overrides the related product's description, not commonly used.

isActiveboolean

Indicates whether the product relation is active.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

product(Product (object or null))
One of:
culturesArray of objects or null(ProductRelationCulture)
relatedProduct(Product (object or null))
One of:
]
Response
application/json
[
  {
    "id": 0,
    "clientId": 0,
    "productId": 0,
    "relatedProductId": 0,
    "typeId": 0,
    "sortOrder": 0,
    "populationRuleId": 0,
    "isProductVariantUnique": true,
    "isRelatedProductVariantUnique": true,
    "defaultName": "string",
    "defaultSubHeader": "string",
    "defaultSubDescription": "string",
    "defaultDescriptionHeader": "string",
    "defaultDescription": "string",
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "product": { … },
    "cultures": [ … ],
    "relatedProduct": { … }
  }
]

Shopping

Operations

Metadata

Operations