COMMERCE QUERY

Query API 3.0

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations

Metadata_GetMetadata

Request

Headers

ApplicationIdintegerrequired

Application ID

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

Responses

Bodyapplication/json

schemaElementsArray of objects or null(IEdmSchemaElement)

vocabularyAnnotationsArray of objects or null(IEdmVocabularyAnnotation)

referencedModelsArray of objects or null(IEdmModel)

declaredNamespacesArray of strings or null

directValueAnnotationsManager(IEdmDirectValueAnnotationsManager (object or null))

One of:

object or null(IEdmDirectValueAnnotationsManager)

entityContainer(IEdmEntityContainer (object or null))

One of:

Response

application/json

{
  "schemaElements": [
    { … }
  ],
  "vocabularyAnnotations": [
    { … }
  ],
  "referencedModels": [
    {}
  ],
  "declaredNamespaces": [
    "string"
  ],
  "directValueAnnotationsManager": {},
  "entityContainer": {
    "elements": [ … ]
  }
}

Metadata_GetMetadata2

Request

Headers

ApplicationIdintegerrequired

Application ID

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

Responses

Bodyapplication/json

schemaElementsArray of objects or null(IEdmSchemaElement)

vocabularyAnnotationsArray of objects or null(IEdmVocabularyAnnotation)

referencedModelsArray of objects or null(IEdmModel)

declaredNamespacesArray of strings or null

directValueAnnotationsManager(IEdmDirectValueAnnotationsManager (object or null))

One of:

object or null(IEdmDirectValueAnnotationsManager)

entityContainer(IEdmEntityContainer (object or null))

One of:

Response

application/json

{
  "schemaElements": [
    { … }
  ],
  "vocabularyAnnotations": [
    { … }
  ],
  "referencedModels": [
    {}
  ],
  "declaredNamespaces": [
    "string"
  ],
  "directValueAnnotationsManager": {},
  "entityContainer": {
    "elements": [ … ]
  }
}

Metadata_GetMetadata3

Request

Headers

ApplicationIdintegerrequired

Application ID

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

Responses

Bodyapplication/json

schemaElementsArray of objects or null(IEdmSchemaElement)

vocabularyAnnotationsArray of objects or null(IEdmVocabularyAnnotation)

referencedModelsArray of objects or null(IEdmModel)

declaredNamespacesArray of strings or null

directValueAnnotationsManager(IEdmDirectValueAnnotationsManager (object or null))

One of:

object or null(IEdmDirectValueAnnotationsManager)

entityContainer(IEdmEntityContainer (object or null))

One of:

Response

application/json

{
  "schemaElements": [
    { … }
  ],
  "vocabularyAnnotations": [
    { … }
  ],
  "referencedModels": [
    {}
  ],
  "declaredNamespaces": [
    "string"
  ],
  "directValueAnnotationsManager": {},
  "entityContainer": {
    "elements": [ … ]
  }
}

Metadata_GetMetadata4

Request

Headers

ApplicationIdintegerrequired

Application ID

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

Responses

Bodyapplication/json

schemaElementsArray of objects or null(IEdmSchemaElement)

vocabularyAnnotationsArray of objects or null(IEdmVocabularyAnnotation)

referencedModelsArray of objects or null(IEdmModel)

declaredNamespacesArray of strings or null

directValueAnnotationsManager(IEdmDirectValueAnnotationsManager (object or null))

One of:

object or null(IEdmDirectValueAnnotationsManager)

entityContainer(IEdmEntityContainer (object or null))

One of:

Response

application/json

{
  "schemaElements": [
    { … }
  ],
  "vocabularyAnnotations": [
    { … }
  ],
  "referencedModels": [
    {}
  ],
  "declaredNamespaces": [
    "string"
  ],
  "directValueAnnotationsManager": {},
  "entityContainer": {
    "elements": [ … ]
  }
}

Metadata_GetMetadata5

Request

Headers

ApplicationIdintegerrequired

Application ID

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

Responses

Bodyapplication/json

schemaElementsArray of objects or null(IEdmSchemaElement)

vocabularyAnnotationsArray of objects or null(IEdmVocabularyAnnotation)

referencedModelsArray of objects or null(IEdmModel)

declaredNamespacesArray of strings or null

directValueAnnotationsManager(IEdmDirectValueAnnotationsManager (object or null))

One of:

object or null(IEdmDirectValueAnnotationsManager)

entityContainer(IEdmEntityContainer (object or null))

One of:

Response

application/json

{
  "schemaElements": [
    { … }
  ],
  "vocabularyAnnotations": [
    { … }
  ],
  "referencedModels": [
    {}
  ],
  "declaredNamespaces": [
    "string"
  ],
  "directValueAnnotationsManager": {},
  "entityContainer": {
    "elements": [ … ]
  }
}

Metadata_GetMetadata6

Request

Headers

ApplicationIdintegerrequired

Application ID

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

Responses

Bodyapplication/json

schemaElementsArray of objects or null(IEdmSchemaElement)

vocabularyAnnotationsArray of objects or null(IEdmVocabularyAnnotation)

referencedModelsArray of objects or null(IEdmModel)

declaredNamespacesArray of strings or null

directValueAnnotationsManager(IEdmDirectValueAnnotationsManager (object or null))

One of:

object or null(IEdmDirectValueAnnotationsManager)

entityContainer(IEdmEntityContainer (object or null))

One of:

Response

application/json

{
  "schemaElements": [
    { … }
  ],
  "vocabularyAnnotations": [
    { … }
  ],
  "referencedModels": [
    {}
  ],
  "declaredNamespaces": [
    "string"
  ],
  "directValueAnnotationsManager": {},
  "entityContainer": {
    "elements": [ … ]
  }
}

Metadata_GetServiceDocument

Request

Headers

ApplicationIdintegerrequired

Application ID

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

Responses

Bodyapplication/json

typeAnnotation(ODataTypeAnnotation (object or null))

One of:

entitySetsArray of objects or null(ODataEntitySetInfo)

singletonsArray of objects or null(ODataSingletonInfo)

functionImportsArray of objects or null(ODataFunctionImportInfo)

Response

application/json

{
  "typeAnnotation": {
    "typeName": "string",
    "type": { … }
  },
  "entitySets": [
    { … }
  ],
  "singletons": [
    { … }
  ],
  "functionImports": [
    { … }
  ]
}

Metadata_GetServiceDocument2

Request

Headers

ApplicationIdintegerrequired

Application ID

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

Responses

Bodyapplication/json

typeAnnotation(ODataTypeAnnotation (object or null))

One of:

entitySetsArray of objects or null(ODataEntitySetInfo)

singletonsArray of objects or null(ODataSingletonInfo)

functionImportsArray of objects or null(ODataFunctionImportInfo)

Response

application/json

{
  "typeAnnotation": {
    "typeName": "string",
    "type": { … }
  },
  "entitySets": [
    { … }
  ],
  "singletons": [
    { … }
  ],
  "functionImports": [
    { … }
  ]
}

Metadata_GetServiceDocument3

Request

Headers

ApplicationIdintegerrequired

Application ID

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

Responses

Bodyapplication/json

typeAnnotation(ODataTypeAnnotation (object or null))

One of:

entitySetsArray of objects or null(ODataEntitySetInfo)

singletonsArray of objects or null(ODataSingletonInfo)

functionImportsArray of objects or null(ODataFunctionImportInfo)

Response

application/json

{
  "typeAnnotation": {
    "typeName": "string",
    "type": { … }
  },
  "entitySets": [
    { … }
  ],
  "singletons": [
    { … }
  ],
  "functionImports": [
    { … }
  ]
}

Metadata_GetServiceDocument4

Request

Headers

ApplicationIdintegerrequired

Application ID

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

Responses

Bodyapplication/json

typeAnnotation(ODataTypeAnnotation (object or null))

One of:

entitySetsArray of objects or null(ODataEntitySetInfo)

singletonsArray of objects or null(ODataSingletonInfo)

functionImportsArray of objects or null(ODataFunctionImportInfo)

Response

application/json

{
  "typeAnnotation": {
    "typeName": "string",
    "type": { … }
  },
  "entitySets": [
    { … }
  ],
  "singletons": [
    { … }
  ],
  "functionImports": [
    { … }
  ]
}

Metadata_GetServiceDocument5

Request

Headers

ApplicationIdintegerrequired

Application ID

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

Responses

Bodyapplication/json

typeAnnotation(ODataTypeAnnotation (object or null))

One of:

entitySetsArray of objects or null(ODataEntitySetInfo)

singletonsArray of objects or null(ODataSingletonInfo)

functionImportsArray of objects or null(ODataFunctionImportInfo)

Response

application/json

{
  "typeAnnotation": {
    "typeName": "string",
    "type": { … }
  },
  "entitySets": [
    { … }
  ],
  "singletons": [
    { … }
  ],
  "functionImports": [
    { … }
  ]
}

Metadata_GetServiceDocument6

Request

Headers

ApplicationIdintegerrequired

Application ID

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

Responses

Bodyapplication/json

typeAnnotation(ODataTypeAnnotation (object or null))

One of:

entitySetsArray of objects or null(ODataEntitySetInfo)

singletonsArray of objects or null(ODataSingletonInfo)

functionImportsArray of objects or null(ODataFunctionImportInfo)

Response

application/json

{
  "typeAnnotation": {
    "typeName": "string",
    "type": { … }
  },
  "entitySets": [
    { … }
  ],
  "singletons": [
    { … }
  ],
  "functionImports": [
    { … }
  ]
}

Query (v1)

Schemas

Application

Core

Customers

Order

Products

Shopping

Metadata

Metadata_GetMetadata

Request

Responses

Did the information on the page help you?

Metadata_GetMetadata2

Request

Responses

Did the information on the page help you?

Metadata_GetMetadata3

Request

Responses

Did the information on the page help you?

Metadata_GetMetadata4

Request

Responses

Did the information on the page help you?

Metadata_GetMetadata5

Request

Responses

Did the information on the page help you?

Metadata_GetMetadata6

Request

Responses

Did the information on the page help you?

Metadata_GetServiceDocument

Request

Responses

Did the information on the page help you?

Metadata_GetServiceDocument2

Request

Responses

Did the information on the page help you?

Metadata_GetServiceDocument3

Request

Responses

Did the information on the page help you?

Metadata_GetServiceDocument4

Request

Responses

Did the information on the page help you?

Metadata_GetServiceDocument5

Request

Responses

Did the information on the page help you?

Metadata_GetServiceDocument6

Request

Responses

Did the information on the page help you?