COMMERCE QUERY
/
Query API 3.0
/
Products
/
Gets a delta export of product variants changed within the specified time offset, excluding a specific SKU 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 a full export of product variants, filtered by SKU type IDs to include.

Request

Path
skuTypeIdsToIncludestringrequired

A comma-separated list of SKU type IDs to include.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  'https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Products/Variants/ProductService.GetExportProductVariantFull(skuTypeIdsToInclude={skuTypeIdsToInclude})' \
  -H 'ApplicationId: 0'

Responses

A queryable collection of product variants for export.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the variant.

clientIdinteger(int32)

The client identifier.

defaultNamestring or null[ 0 .. 255 ] characters

The default name of the variant.

defaultImagePathstring or null[ 0 .. 255 ] characters

The default image path, not used anymore.

defaultThumbnailImagePathstring or null[ 0 .. 255 ] characters

The default thumbnail image path, not used anymore.

defaultCampaignImagePathstring or null[ 0 .. 255 ] characters

The default campaign image path, not used anymore.

defaultLargeImagePathstring or null[ 0 .. 255 ] characters

The default large image path, not used anymore.

groupIdinteger or null(int32)

The VariantGroup identifier.

aliasstring or null[ 0 .. 255 ] characters

The alias. Not used anymore.

defaultTitlestring or null[ 0 .. 255 ] characters

The default title. For SEO purposes.

defaultTagsstring or null

The default tags, not commonly used anymore.

defaultMetaTagsstring or null

The default meta tags, for SEO purposes.

defaultMetaDescriptionstring or null

The default meta description, for SEO purposes.

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.

imageKeystring or null(guid)

The image key.

codestring or null[ 0 .. 50 ] characters

The code of the variant. Grouping variants together.

defaultUniqueUrlNamestring[ 0 .. 500 ] charactersrequired

The default unique url name.

keystring(guid)

The key. Not used anymore.

defaultImageAltTextstring or null

The default image alt text.

variantGroup(VariantGroup (object or null))
One of:
productsArray of objects or null(Product)
culturesArray of objects or null(VariantCulture)
]
Response
application/json
[
  {
    "id": 0,
    "clientId": 0,
    "defaultName": "string",
    "defaultImagePath": "string",
    "defaultThumbnailImagePath": "string",
    "defaultCampaignImagePath": "string",
    "defaultLargeImagePath": "string",
    "groupId": 0,
    "alias": "string",
    "defaultTitle": "string",
    "defaultTags": "string",
    "defaultMetaTags": "string",
    "defaultMetaDescription": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "imageKey": "string",
    "code": "string",
    "defaultUniqueUrlName": "string",
    "key": "string",
    "defaultImageAltText": "string",
    "variantGroup": { … },
    "products": [ … ],
    "cultures": [ … ]
  }
]

Gets a delta export of product variants changed within the specified time offset, excluding a specific SKU type.

Request

Path
skuTypeIdToExcludeinteger(int32)required

The SKU type ID to exclude from the results.

offsetInMinutesinteger(int32)required

The number of minutes to look back for changes.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  'https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Products/Variants/ProductService.GetExportProductVariantDelta(skuTypeIdToExclude={skuTypeIdToExclude},offsetInMinutes={offsetInMinutes})' \
  -H 'ApplicationId: 0'

Responses

A queryable collection of recently changed product variants for export.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the variant.

clientIdinteger(int32)

The client identifier.

defaultNamestring or null[ 0 .. 255 ] characters

The default name of the variant.

defaultImagePathstring or null[ 0 .. 255 ] characters

The default image path, not used anymore.

defaultThumbnailImagePathstring or null[ 0 .. 255 ] characters

The default thumbnail image path, not used anymore.

defaultCampaignImagePathstring or null[ 0 .. 255 ] characters

The default campaign image path, not used anymore.

defaultLargeImagePathstring or null[ 0 .. 255 ] characters

The default large image path, not used anymore.

groupIdinteger or null(int32)

The VariantGroup identifier.

aliasstring or null[ 0 .. 255 ] characters

The alias. Not used anymore.

defaultTitlestring or null[ 0 .. 255 ] characters

The default title. For SEO purposes.

defaultTagsstring or null

The default tags, not commonly used anymore.

defaultMetaTagsstring or null

The default meta tags, for SEO purposes.

defaultMetaDescriptionstring or null

The default meta description, for SEO purposes.

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.

imageKeystring or null(guid)

The image key.

codestring or null[ 0 .. 50 ] characters

The code of the variant. Grouping variants together.

defaultUniqueUrlNamestring[ 0 .. 500 ] charactersrequired

The default unique url name.

keystring(guid)

The key. Not used anymore.

defaultImageAltTextstring or null

The default image alt text.

variantGroup(VariantGroup (object or null))
One of:
productsArray of objects or null(Product)
culturesArray of objects or null(VariantCulture)
]
Response
application/json
[
  {
    "id": 0,
    "clientId": 0,
    "defaultName": "string",
    "defaultImagePath": "string",
    "defaultThumbnailImagePath": "string",
    "defaultCampaignImagePath": "string",
    "defaultLargeImagePath": "string",
    "groupId": 0,
    "alias": "string",
    "defaultTitle": "string",
    "defaultTags": "string",
    "defaultMetaTags": "string",
    "defaultMetaDescription": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "imageKey": "string",
    "code": "string",
    "defaultUniqueUrlName": "string",
    "key": "string",
    "defaultImageAltText": "string",
    "variantGroup": { … },
    "products": [ … ],
    "cultures": [ … ]
  }
]

Gets a delta export of product variants changed within the specified time offset, filtered by SKU type IDs to include.

Request

Path
skuTypeIdsToIncludestringrequired

A comma-separated list of SKU type IDs to include.

offsetInMinutesinteger(int32)required

The number of minutes to look back for changes.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  'https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Products/Variants/ProductService.GetExportProductVariantDelta(skuTypeIdsToInclude={skuTypeIdsToInclude},offsetInMinutes={offsetInMinutes})' \
  -H 'ApplicationId: 0'

Responses

A queryable collection of recently changed product variants for export.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the variant.

clientIdinteger(int32)

The client identifier.

defaultNamestring or null[ 0 .. 255 ] characters

The default name of the variant.

defaultImagePathstring or null[ 0 .. 255 ] characters

The default image path, not used anymore.

defaultThumbnailImagePathstring or null[ 0 .. 255 ] characters

The default thumbnail image path, not used anymore.

defaultCampaignImagePathstring or null[ 0 .. 255 ] characters

The default campaign image path, not used anymore.

defaultLargeImagePathstring or null[ 0 .. 255 ] characters

The default large image path, not used anymore.

groupIdinteger or null(int32)

The VariantGroup identifier.

aliasstring or null[ 0 .. 255 ] characters

The alias. Not used anymore.

defaultTitlestring or null[ 0 .. 255 ] characters

The default title. For SEO purposes.

defaultTagsstring or null

The default tags, not commonly used anymore.

defaultMetaTagsstring or null

The default meta tags, for SEO purposes.

defaultMetaDescriptionstring or null

The default meta description, for SEO purposes.

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.

imageKeystring or null(guid)

The image key.

codestring or null[ 0 .. 50 ] characters

The code of the variant. Grouping variants together.

defaultUniqueUrlNamestring[ 0 .. 500 ] charactersrequired

The default unique url name.

keystring(guid)

The key. Not used anymore.

defaultImageAltTextstring or null

The default image alt text.

variantGroup(VariantGroup (object or null))
One of:
productsArray of objects or null(Product)
culturesArray of objects or null(VariantCulture)
]
Response
application/json
[
  {
    "id": 0,
    "clientId": 0,
    "defaultName": "string",
    "defaultImagePath": "string",
    "defaultThumbnailImagePath": "string",
    "defaultCampaignImagePath": "string",
    "defaultLargeImagePath": "string",
    "groupId": 0,
    "alias": "string",
    "defaultTitle": "string",
    "defaultTags": "string",
    "defaultMetaTags": "string",
    "defaultMetaDescription": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "imageKey": "string",
    "code": "string",
    "defaultUniqueUrlName": "string",
    "key": "string",
    "defaultImageAltText": "string",
    "variantGroup": { … },
    "products": [ … ],
    "cultures": [ … ]
  }
]

Shopping

Operations

Metadata

Operations