COMMERCE QUERY

Query API 3.0

ClientCompany

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

ClientCustomerCompany

customerIdinteger(int32)

The customer identifier.

companyIdinteger(int32)

The company identifier.

roleIdinteger or null(int32)

The role identifier, not used anymore.

customerCodePrefixstring or null[ 0 .. 10 ] characters

The customer code prefix.

customerCodestring or null[ 0 .. 50 ] characters

The code for the customer in the company.

departmentstring or null[ 0 .. 255 ] characters

The department.

organizationTitlestring or null[ 0 .. 50 ] characters

The organization title.

isPrimaryboolean

Indicates whether the company is primary for the customer.

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:

customer(ClientCustomer (object or null))

One of:

{
  "customerId": 0,
  "companyId": 0,
  "roleId": 0,
  "customerCodePrefix": "string",
  "customerCode": "string",
  "department": "string",
  "organizationTitle": "string",
  "isPrimary": true,
  "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": {}
  },
  "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": [ … ]
  }
}

ClientCompany

idinteger(int32)

The unique identifier of the client company.

keystring(guid)

The key.

clientIdinteger(int32)

The client identifier.

companyCodePrefixstring or null[ 0 .. 10 ] characters

The company code prefix.

companyCodestring or null[ 0 .. 50 ] characters

The company code.

typeIdinteger(int32)

The type identifier, Company (1).

logoPathstring or null[ 0 .. 255 ] characters

The logo path, not used anymore.

organizationNostring or null[ 0 .. 50 ] characters

The organization number.

namestring[ 0 .. 100 ] charactersrequired

The name of the client company.

emailAddressstring or null[ 0 .. 255 ] characters

The email address.

phoneNumberstring or null[ 0 .. 50 ] characters

The phone number.

faxNumberstring or null[ 0 .. 50 ] characters

The fax number, not used anymore.

parentCompanyIdinteger or null(int32)

The parent company identifier.

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 billing address as shipping address is used.

oldCompanyCodePrefixstring or null[ 0 .. 10 ] characters

The old company code prefix.

oldCompanyCodestring or null[ 0 .. 50 ] characters

The old company code, used for historical reference.

isActiveboolean

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

logoKeystring or null(guid)

The logo key.

normalizedOrganizationNostring or null[ 0 .. 50 ] characters

The normalized organization number.

applicationIdinteger or null(int32)

The application identifier.

vatNostring or null[ 0 .. 50 ] characters

The vat number.

addressesArray of objects or null(ClientCompanyAddress)

deliveryMethodsArray of objects or null(ClientCompanyDeliveryMethod)

discountsArray of objects or null(ClientCompanyDiscount)

flagsArray of objects or null(ClientCompanyFlag)

infosArray of objects or null(ClientCompanyInfo)

paymentMethodsArray of objects or null(ClientCompanyPaymentMethod)

priceListsArray of objects or null(ClientCompanyPriceList)

customersArray of objects or null(ClientCustomerCompany)

inverseParentCompanyArray of objects or null(ClientCompany)

parentCompanyClientCompany (object)

One of:

object ClientCompany Recursive

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

ClientCompanyAddress

idinteger(int32)

The unique identifier of the client company address.

companyIdinteger(int32)

The company identifier.

typeIdinteger(int32)

The type identifier.

careOfstring or null[ 0 .. 100 ] characters

The care of.

addressLine1string or null[ 0 .. 255 ] characters

The first line of the address.

addressLine2string or null[ 0 .. 255 ] characters

The second line of the address.

zipCodestring or null[ 0 .. 50 ] characters

The zip code.

citystring or null[ 0 .. 50 ] characters

The city.

regionstring or null[ 0 .. 100 ] characters

The region.

countryIdinteger or null(int32)

The country 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.

statusIdinteger or null(int32)

The status identifier, not used anymore.

statusUpdatedstring or null(date-time)

The status updated.

statusUpdatedByinteger or null(int32)

The status updated by.

glnstring or null[ 0 .. 50 ] characters

The GLN.

clientIdinteger or null(int32)

The client identifier.

shippingPhoneNumberstring or null[ 0 .. 50 ] characters

The shipping phone number.

codestring or null[ 0 .. 50 ] characters

The code of the client company address.

isPrimaryboolean

Indicates whether the client company address is primary.

company(ClientCompany (object or null))

One of:

{
  "id": 0,
  "companyId": 0,
  "typeId": 0,
  "careOf": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "zipCode": "string",
  "city": "string",
  "region": "string",
  "countryId": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "statusId": 0,
  "statusUpdated": "2019-08-24T14:15:22Z",
  "statusUpdatedBy": 0,
  "gln": "string",
  "clientId": 0,
  "shippingPhoneNumber": "string",
  "code": "string",
  "isPrimary": true,
  "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": {}
  }
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations