COMMERCE QUERY

Query API 3.0

ApplicationAccountApplicationRole

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

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

ApplicationAccountApplicationRole

idinteger(int32)

The unique identifier of the application account application role.

accountIdinteger(int32)

The account identifier.

applicationIdinteger or null(int32)

The application identifier.

applicationRoleIdinteger(int32)

The application role identifier.

isActiveboolean

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

clientIdinteger or null(int32)

The client identifier.

account(ApplicationAccount (object or null))

One of:

applicationRole(ApplicationRole (object or null))

One of:

{
  "id": 0,
  "accountId": 0,
  "applicationId": 0,
  "applicationRoleId": 0,
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientId": 0,
  "account": {
    "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": { … },
    "role": { … }
  },
  "applicationRole": {
    "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": [ … ]
  }
}

ClientCustomer

idinteger(int32)

The unique identifier of the client customer.

keystring(guid)

The unique key of the client customer.

clientIdinteger(int32)

The client identifier.

customerCodePrefixstring or null[ 0 .. 10 ] characters

The customer code prefix.

customerCodestring or null[ 0 .. 50 ] characters

The customer code.

typeIdinteger(int32)

The type identifier, Person (1).

emailAddressstring or null[ 0 .. 255 ] characters

The email address.

socialSecurityNumberstring or null[ 0 .. 50 ] characters

The social security number.

titlestring or null[ 0 .. 10 ] characters

The title (e.g. Mr, Ms).

firstNamestring or null[ 0 .. 100 ] characters

The first name.

middleNamestring or null[ 0 .. 100 ] characters

The middle name.

lastNamestring or null[ 0 .. 100 ] characters

The last name.

suffixstring or null[ 0 .. 10 ] characters

The name suffix.

phoneNumberstring or null[ 0 .. 50 ] characters

The phone number.

cellPhoneNumberstring or null[ 0 .. 50 ] characters

The cell phone number.

referIdinteger or null(int32)

The refer identifier, not used anymore.

referUrlstring or null[ 0 .. 255 ] characters

The refer URL, not used anymore.

useBillingAddressAsShippingAddressboolean

Indicates whether the billing address is used as the shipping address.

oldCustomerNoPrefixstring or null[ 0 .. 10 ] characters

The old customer number prefix.

oldCustomerNostring or null[ 0 .. 50 ] characters

The old customer number, used for historical reference.

replacementCustomerIdinteger or null(int32)

The replacement customer identifier, used for historical reference.

isActiveboolean

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

lastOrderDatestring or null(date-time)

The date of the last order placed by this customer.

normalizedSocialSecurityNumberstring or null[ 0 .. 50 ] characters

The normalized social security number.

applicationIdinteger or null(int32)

The application identifier, used when customers and companies are application specific.

isForgottenboolean

Indicates whether the client customer is forgotten.

forgottenByinteger or null(int32)

The identifier of the user who marked the customer as forgotten.

forgottenDatestring or null(date-time)

The date and time the customer was marked as forgotten.

stoppedDatestring or null(date-time)

The date and time the customer was stopped.

stoppedByinteger or null(int32)

The identifier of the user who stopped the customer.

crmIdstring or null[ 0 .. 50 ] characters

The CRM identifier.

accountArray of objects or null(ApplicationAccount)

addressesArray of objects or null(ClientCustomerAddress)

companiesArray of objects or null(ClientCustomerCompany)

flagsArray of objects or null(ClientCustomerFlag)

infosArray of objects or null(ClientCustomerInfo)

ordersArray of objects(Order)

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

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations