COMMERCE QUERY
/
Query API 3.0
/
Customers

Query (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

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

Schemas

Application

Operations

Core

Operations

Customers

Operations

Gets all customers.

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Customers/Customers \
  -H 'ApplicationId: 0'

Responses

A queryable collection of customers.

Bodyapplication/jsonArray [
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)
]
Response
application/json
[
  {
    "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": [ … ]
  }
]

Gets a single customer by its identifier.

Request

Path
idinteger(int32)required

The customer identifier.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  'https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Customers/Customers({id})' \
  -H 'ApplicationId: 0'

Responses

A single customer matching the specified identifier.

Bodyapplication/json
queryableArray of objects or null
Response
application/json
{
  "queryable": [
    { … }
  ]
}

Gets all companies.

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Customers/Companies \
  -H 'ApplicationId: 0'

Responses

A queryable collection of companies.

Bodyapplication/jsonArray [
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
]
Response
application/json
[
  {
    "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": {}
  }
]

Gets a single company by its identifier.

Request

Path
idinteger(int32)required

The company identifier.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  'https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Customers/Companies({id})' \
  -H 'ApplicationId: 0'

Responses

A single company matching the specified identifier.

Bodyapplication/json
queryableArray of objects or null
Response
application/json
{
  "queryable": [
    { … }
  ]
}

Gets all companies associated with a specific customer.

Request

Path
customerIdinteger(int32)required

The customer identifier.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  'https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Customers/Customers({customerId})/Companies' \
  -H 'ApplicationId: 0'

Responses

A queryable collection of companies linked to the specified customer.

Bodyapplication/jsonArray [
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
]
Response
application/json
[
  {
    "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": {}
  }
]

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations