COMMERCE QUERY
/
Query API 3.0
/
Application
/
Gets all customer info types.

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 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": [ … ]
  }
]

Gets all client customer flags.

Request

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of client customer flags. Both customer and company enabled flags are included.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the customer flag.

clientIdinteger(int32)

The client identifier.

groupIdinteger(int32)

The group identifier.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the customer flag.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the customer flag.

availableOnCustomerboolean

Indicates whether available on customer is enabled (CustomerFlag).

availableOnCompanyboolean

Indicates whether available on company is enabled (CompanyFlag).

isActiveboolean

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

isDefaultboolean

Indicates whether the customer flag is default, not used anymore.

externalReferencestring or null[ 0 .. 50 ] characters

The external reference, called 'Code' in other APIs and in the admin tool.

sortOrderinteger or null(int32)

The sort order for display purposes.

clientCompanyFlagArray of objects or null(ClientCompanyFlag)
clientCustomerFlagArray of objects or null(ClientCustomerFlag)
culturesArray of objects or null(CustomerFlagCulture)
group(CustomerFlagGroup (object or null))
One of:
]
Response
application/json
[
  {
    "id": 0,
    "clientId": 0,
    "groupId": 0,
    "defaultName": "string",
    "defaultDescription": "string",
    "availableOnCustomer": true,
    "availableOnCompany": true,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "isDefault": true,
    "externalReference": "string",
    "sortOrder": 0,
    "clientCompanyFlag": [ … ],
    "clientCustomerFlag": [ … ],
    "cultures": [ … ],
    "group": { … }
  }
]

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations