COMMERCE QUERY

Query API 3.0

ClientCompanyInfo

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

CustomerFlagGroupCulture

groupIdinteger(int32)

The customer flaggroup identifier.

cultureCodestring or null[ 0 .. 16 ] characters

The culture code (e.g. en-US).

namestring or null[ 0 .. 50 ] characters

The culture specific name of the customer flag group.

descriptionstring or null[ 0 .. 500 ] characters

The culture specific description of the customer flag group.

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.

group(CustomerFlagGroup (object or null))

One of:

{
  "groupId": 0,
  "cultureCode": "string",
  "name": "string",
  "description": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientId": 0,
  "group": {
    "id": 0,
    "clientId": 0,
    "defaultName": "string",
    "defaultDescription": "string",
    "isMultipleChoice": true,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "customerFlag": [ … ],
    "cultures": [ … ]
  }
}

ClientCompanyInfo

idinteger(int32)

The unique identifier of the client company info type.

companyIdinteger(int32)

The company identifier.

typeIdinteger(int32)

The type identifier of the client company info.

valuestringnon-emptyrequired

The value of the client company info.

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.

company(ClientCompany (object or null))

One of:

type(CustomerInfoType (object or null))

One of:

{
  "id": 0,
  "companyId": 0,
  "typeId": 0,
  "value": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientId": 0,
  "company": {
    "id": 0,
    "key": "string",
    "clientId": 0,
    "companyCodePrefix": "string",
    "companyCode": "string",
    "typeId": 0,
    "logoPath": "string",
    "organizationNo": "string",
    "name": "string",
    "emailAddress": "string",
    "phoneNumber": "string",
    "faxNumber": "string",
    "parentCompanyId": 0,
    "referId": 0,
    "referUrl": "string",
    "useBillingAddressAsShippingAddress": true,
    "oldCompanyCodePrefix": "string",
    "oldCompanyCode": "string",
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "logoKey": "string",
    "normalizedOrganizationNo": "string",
    "applicationId": 0,
    "vatNo": "string",
    "addresses": [ … ],
    "deliveryMethods": [ … ],
    "discounts": [ … ],
    "flags": [ … ],
    "infos": [ … ],
    "paymentMethods": [ … ],
    "priceLists": [ … ],
    "customers": [ … ],
    "inverseParentCompany": [ … ],
    "parentCompany": {}
  },
  "type": {
    "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": [ … ]
  }
}

CustomerInfoType

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)

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

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations