COMMERCE QUERY

Query API 3.0

ClientCompanyFlag

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

ClientCompanyDiscount

companyIdinteger(int32)

The company identifier.

clientIdinteger(int32)

The client identifier.

typeIdinteger(int32)

The type identifier, Category (1), Product Flag (3).

valueCodestring or null[ 0 .. 50 ] characters

The value code, either category code or product flag code.

discountPctnumber(decimal)

The discount in pct.

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.

priceListTypeIdSeedstring or null[ 0 .. 50 ] characters

The price list type id seed, comma separated list of price list types.

company(ClientCompany (object or null))

One of:

{
  "companyId": 0,
  "clientId": 0,
  "typeId": 0,
  "valueCode": "string",
  "discountPct": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "priceListTypeIdSeed": "string",
  "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": {}
  }
}

ClientCompanyFlag

companyIdinteger(int32)

The company identifier.

flagIdinteger(int32)

The flag identifier.

isActiveboolean

Indicates whether the client company flag is active.

stoppedDatestring or null(date-time)

The stopped date.

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.

company(ClientCompany (object or null))

One of:

flag(CustomerFlag (object or null))

One of:

{
  "companyId": 0,
  "flagId": 0,
  "isActive": true,
  "stoppedDate": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "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": {}
  },
  "flag": {
    "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": { … }
  }
}

CustomerFlag

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:

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

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations