COMMERCE QUERY
/
Query API 3.0
/
Application
/
Gets all client sales areas.

Query (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

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

Schemas

Application

Operations

Gets all product info types.

Request

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of product info types. The custom fields configured by the client for price and onhand records.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the product info type.

clientIdinteger(int32)

The client identifier.

groupIdinteger(int32)

The info type group identifier, OnHandInfo (2), PriceListInfo (3).

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the product info type.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the product info type.

sortOrderinteger(int32)

The sort order for display purposes.

isActiveboolean

Indicates whether the product info type 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.

codestring or null[ 0 .. 50 ] characters

The code of the product info type.

clientProductSkuOnHandInfoArray of objects or null(ClientProductSkuOnHandInfo)
clientProductSkuPriceListInfoArray of objects or null(ClientProductSkuPriceListInfo)
culturesArray of objects or null(ProductInfoTypeCulture)
]
Response
application/json
[
  {
    "id": 0,
    "clientId": 0,
    "groupId": 0,
    "defaultName": "string",
    "defaultDescription": "string",
    "sortOrder": 0,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "code": "string",
    "clientProductSkuOnHandInfo": [ … ],
    "clientProductSkuPriceListInfo": [ … ],
    "cultures": [ … ]
  }
]

Gets all client sales areas.

Request

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of client sales areas. All sales areas configured for the client are included.

Bodyapplication/jsonArray [
clientIdinteger(int32)

The client identifier.

salesAreaIdinteger(int32)

The sales area identifier.

isPrimaryboolean

Indicates whether the client sales area is primary, default for the client, only one can be primary for the client.

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.

codestring or null[ 0 .. 50 ] characters

The code of the client sales area.

clientSalesAreaVatCodeArray of objects or null(ClientSalesAreaVatCode)
]
Response
application/json
[
  {
    "clientId": 0,
    "salesAreaId": 0,
    "isPrimary": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "code": "string",
    "clientSalesAreaVatCode": [ … ]
  }
]

Gets all variant groups.

Request

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of variant groups. Named variant type in admin and VariantDefinitionGroup in connect.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the variant group.

clientIdinteger(int32)

The client identifier.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the variant group.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the variant group.

isActiveboolean

Indicates whether the variant group 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.

codestring or null[ 0 .. 50 ] characters

The code of the variant group.

variantArray of objects or null(Variant)
culturesArray of objects or null(VariantGroupCulture)
groupTypesArray of objects or null(VariantGroupType)
]
Response
application/json
[
  {
    "id": 0,
    "clientId": 0,
    "defaultName": "string",
    "defaultDescription": "string",
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "code": "string",
    "variant": [ … ],
    "cultures": [ … ],
    "groupTypes": [ … ]
  }
]

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations