COMMERCE QUERY
/
Query API 3.0
/
Metadata
/
Get Core service document

Commerce Query API (v3.0)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Playground

https://{slug}.api-se.playground.norce.tech/commerce/query/3.0/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/query/3.0/

Production

https://{slug}.api-se.norce.tech/commerce/query/3.0/

Schemas

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations

Get Core metadata

Request

Gets the OData metadata document (CSDL) that describes the entity types, properties and entity sets under /Core.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  'https://customer-slug.api-se.playground.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": [ … ]
  }
}

Get Application metadata

Request

Gets the OData metadata document (CSDL) that describes the entity types, properties and entity sets under /Application.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  'https://customer-slug.api-se.playground.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": [ … ]
  }
}

Get Customers metadata

Request

Gets the OData metadata document (CSDL) that describes the entity types, properties and entity sets under /Customers.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  'https://customer-slug.api-se.playground.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": [ … ]
  }
}

Get Products metadata

Request

Gets the OData metadata document (CSDL) that describes the entity types, properties and entity sets under /Products.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  'https://customer-slug.api-se.playground.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": [ … ]
  }
}

Get Orders metadata

Request

Gets the OData metadata document (CSDL) that describes the entity types, properties and entity sets under /Orders.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  'https://customer-slug.api-se.playground.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": [ … ]
  }
}

Get Shopping metadata

Request

Gets the OData metadata document (CSDL) that describes the entity types, properties and entity sets under /Shopping.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  'https://customer-slug.api-se.playground.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": [ … ]
  }
}

Get Core service document

Request

Gets the OData service document that lists the entity sets under /Core.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.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": [
    { … }
  ]
}

Get Application service document

Request

Gets the OData service document that lists the entity sets under /Application.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.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": [
    { … }
  ]
}

Get Customers service document

Request

Gets the OData service document that lists the entity sets under /Customers.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.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": [
    { … }
  ]
}

Get Products service document

Request

Gets the OData service document that lists the entity sets under /Products.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.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": [
    { … }
  ]
}

Get Orders service document

Request

Gets the OData service document that lists the entity sets under /Orders.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.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": [
    { … }
  ]
}

Get Shopping service document

Request

Gets the OData service document that lists the entity sets under /Shopping.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.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": [
    { … }
  ]
}