COMMERCE QUERY

Query API 3.0

ClientCustomerAddress

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

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

ClientCustomerAddress

idinteger(int32)

The unique identifier of the client customer address.

customerIdinteger(int32)

The customer 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 .. 50 ] 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.

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 customer address.

isPrimaryboolean

Indicates whether the client customer address is primary.

customer(ClientCustomer (object or null))

One of:

{
  "id": 0,
  "customerId": 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,
  "clientId": 0,
  "shippingPhoneNumber": "string",
  "code": "string",
  "isPrimary": true,
  "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": [ … ]
  }
}

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

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations