COMMERCE QUERY

Query API 3.0

ApplicationRole

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

ApplicationSalesArea

applicationIdinteger(int32)

The application identifier.

salesAreaIdinteger(int32)

The sales area identifier.

isPrimaryboolean

Indicates whether the application sales area is primary, only one primary sales area is allowed per application.

isActiveboolean

Indicates whether the application sales area 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.

clientIdinteger or null(int32)

The client identifier.

{
  "applicationId": 0,
  "salesAreaId": 0,
  "isPrimary": true,
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientId": 0
}

ApplicationRole

idinteger(int32)

The unique identifier of the application role.

applicationIdinteger or null(int32)

The application identifier.

clientIdinteger or null(int32)

The client identifier.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the application role.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the application role.

replacesApplicationRoleIdinteger or null(int32)

The replaces application role identifier.

isActiveboolean

Indicates whether the application role 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 application role is default.

codestring or null[ 0 .. 50 ] characters

The code of the application role.

applicationAccountArray of objects or null(ApplicationAccount)

applicationAccountApplicationRoleArray of objects or null(ApplicationAccountApplicationRole)

culturesArray of objects or null(ApplicationRoleCulture)

{
  "id": 0,
  "applicationId": 0,
  "clientId": 0,
  "defaultName": "string",
  "defaultDescription": "string",
  "replacesApplicationRoleId": 0,
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "isDefault": true,
  "code": "string",
  "applicationAccount": [
    { … }
  ],
  "applicationAccountApplicationRole": [
    { … }
  ],
  "cultures": [
    { … }
  ]
}

ApplicationAccount

idinteger(int32)

The unique identifier of the application account.

applicationIdinteger(int32)

The application identifier.

keystring(guid)

The key.

loginNamestring[ 0 .. 255 ] charactersrequired

The login name.

passwordstring(byte)[ 1 .. 4000 ] charactersrequired

The password.

typeIdinteger(int32)

The type identifier.

contactIdinteger or null(int32)

The contact identifier.

customerIdinteger or null(int32)

The customer identifier.

statusIdinteger(int32)

The status identifier.

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.

roleIdinteger or null(int32)

The role identifier.

clientIdinteger or null(int32)

The client identifier.

rolesArray of objects or null(ApplicationAccountApplicationRole)

customer(ClientCustomer (object or null))

One of:

role(ApplicationRole (object or null))

One of:

{
  "id": 0,
  "applicationId": 0,
  "key": "string",
  "loginName": "string",
  "password": "string",
  "typeId": 0,
  "contactId": 0,
  "customerId": 0,
  "statusId": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "roleId": 0,
  "clientId": 0,
  "roles": [
    { … }
  ],
  "customer": {
    "id": 0,
    "key": "string",
    "clientId": 0,
    "customerCodePrefix": "string",
    "customerCode": "string",
    "typeId": 0,
    "emailAddress": "string",
    "socialSecurityNumber": "string",
    "title": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "suffix": "string",
    "phoneNumber": "string",
    "cellPhoneNumber": "string",
    "referId": 0,
    "referUrl": "string",
    "useBillingAddressAsShippingAddress": true,
    "oldCustomerNoPrefix": "string",
    "oldCustomerNo": "string",
    "replacementCustomerId": 0,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "lastOrderDate": "2019-08-24T14:15:22Z",
    "normalizedSocialSecurityNumber": "string",
    "applicationId": 0,
    "isForgotten": true,
    "forgottenBy": 0,
    "forgottenDate": "2019-08-24T14:15:22Z",
    "stoppedDate": "2019-08-24T14:15:22Z",
    "stoppedBy": 0,
    "crmId": "string",
    "account": [ … ],
    "addresses": [ … ],
    "companies": [ … ],
    "flags": [ … ],
    "infos": [ … ],
    "orders": [ … ]
  },
  "role": {
    "id": 0,
    "applicationId": 0,
    "clientId": 0,
    "defaultName": "string",
    "defaultDescription": "string",
    "replacesApplicationRoleId": 0,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "isDefault": true,
    "code": "string",
    "applicationAccount": [ … ],
    "applicationAccountApplicationRole": [ … ],
    "cultures": [ … ]
  }
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations