COMMERCE QUERY
/
Query API 3.0
/
Application
/
Gets all variant groups.

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

Gets all client sales areas.

Request

Headers
ApplicationIdintegerrequired

Application ID

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

Gets all customer info types.

Request

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of customer info types. The custom fields configured by the client for customer, company and store (division) records.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the customer info type.

clientIdinteger(int32)

The client identifier.

groupIdinteger(int32)

The group identifier, Customer Info (1), Division Info (4), Company Info (6), Supplier Info (7).

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the customer info type.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the customer info type.

sortOrderinteger(int32)

The sort order for display purposes.

isActiveboolean

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

clientCompanyInfoArray of objects or null(ClientCompanyInfo)
clientCustomerInfoArray of objects or null(ClientCustomerInfo)
clientDivisionInfoArray of objects or null(ClientDivisionInfo)
clientSupplierInfoArray of objects or null(ClientSupplierInfo)
culturesArray of objects or null(CustomerInfoTypeCulture)
]
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",
    "clientCompanyInfo": [ … ],
    "clientCustomerInfo": [ … ],
    "clientDivisionInfo": [ … ],
    "clientSupplierInfo": [ … ],
    "cultures": [ … ]
  }
]

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations