COMMERCE QUERY

Query API 3.0

ClientDivision

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

ClientDivisionInfo

idinteger(int32)

The unique identifier of the client division info type.

divisionIdinteger(int32)

The division identifier.

typeIdinteger(int32)

The type identifier.

valuestringnon-emptyrequired

The value.

updatedstring(date-time)

The date and time the record was last updated.

updatedByinteger(int32)

The identifier of the user who last updated the record.

clientIdinteger or null(int32)

The client identifier.

division(ClientDivision (object or null))

One of:

type(CustomerInfoType (object or null))

One of:

{
  "id": 0,
  "divisionId": 0,
  "typeId": 0,
  "value": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientId": 0,
  "division": {
    "id": 0,
    "clientId": 0,
    "divisionCode": "string",
    "defaultName": "string",
    "defaultGroupName": "string",
    "defaultSubGroupName": "string",
    "defaultDescription": "string",
    "defaultImagePath": "string",
    "isPublic": true,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "key": "string",
    "imageKey": "string",
    "defaultUniqueUrlName": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "emailAddress": "string",
    "phoneNumber": "string",
    "faxNumber": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "zipCode": "string",
    "city": "string",
    "region": "string",
    "countryId": 0,
    "openHoursWeekday": "string",
    "openHoursSaturday": "string",
    "openHoursSunday": "string",
    "applications": [ … ],
    "cultures": [ … ],
    "infos": [ … ],
    "priceLists": [ … ],
    "warehouses": [ … ]
  },
  "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": [ … ]
  }
}

ClientDivision

idinteger(int32)

The unique identifier of the division (store).

clientIdinteger(int32)

The client identifier.

divisionCodestring or null[ 0 .. 50 ] characters

The division (store) code.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the division (store).

defaultGroupNamestring or null[ 0 .. 50 ] characters

The default group name of the division (store).

defaultSubGroupNamestring or null[ 0 .. 50 ] characters

The default sub group name of the division (store).

defaultDescriptionstring or null

The default description of the division (store).

defaultImagePathstring or null[ 0 .. 255 ] characters

The default image path, not used anymore.

isPublicboolean

Indicates whether the division (store) is public.

isActiveboolean

Indicates whether the division (store) 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.

keystring(guid)

The key.

imageKeystring or null(guid)

The image key.

defaultUniqueUrlNamestring[ 0 .. 100 ] charactersrequired

The default unique url name.

latitudenumber or null(double)

The latitude.

longitudenumber or null(double)

The longitude.

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.

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.

openHoursWeekdaystring or null[ 0 .. 255 ] characters

The open hours weekday.

openHoursSaturdaystring or null[ 0 .. 255 ] characters

The open hours saturday.

openHoursSundaystring or null[ 0 .. 255 ] characters

The open hours sunday.

applicationsArray of objects or null(ClientDivisionApplication)

culturesArray of objects or null(ClientDivisionCulture)

infosArray of objects or null(ClientDivisionInfo)

priceListsArray of objects or null(ClientDivisionPriceList)

warehousesArray of objects or null(ClientDivisionWarehouse)

{
  "id": 0,
  "clientId": 0,
  "divisionCode": "string",
  "defaultName": "string",
  "defaultGroupName": "string",
  "defaultSubGroupName": "string",
  "defaultDescription": "string",
  "defaultImagePath": "string",
  "isPublic": true,
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "key": "string",
  "imageKey": "string",
  "defaultUniqueUrlName": "string",
  "latitude": 0.1,
  "longitude": 0.1,
  "emailAddress": "string",
  "phoneNumber": "string",
  "faxNumber": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "zipCode": "string",
  "city": "string",
  "region": "string",
  "countryId": 0,
  "openHoursWeekday": "string",
  "openHoursSaturday": "string",
  "openHoursSunday": "string",
  "applications": [
    { … }
  ],
  "cultures": [
    { … }
  ],
  "infos": [
    { … }
  ],
  "priceLists": [
    { … }
  ],
  "warehouses": [
    { … }
  ]
}

ClientDivisionApplication

divisionIdinteger(int32)

The division (store) identifier.

applicationIdinteger(int32)

The application identifier.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

clientIdinteger or null(int32)

The client identifier.

division(ClientDivision (object or null))

One of:

{
  "divisionId": 0,
  "applicationId": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "clientId": 0,
  "division": {
    "id": 0,
    "clientId": 0,
    "divisionCode": "string",
    "defaultName": "string",
    "defaultGroupName": "string",
    "defaultSubGroupName": "string",
    "defaultDescription": "string",
    "defaultImagePath": "string",
    "isPublic": true,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "key": "string",
    "imageKey": "string",
    "defaultUniqueUrlName": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "emailAddress": "string",
    "phoneNumber": "string",
    "faxNumber": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "zipCode": "string",
    "city": "string",
    "region": "string",
    "countryId": 0,
    "openHoursWeekday": "string",
    "openHoursSaturday": "string",
    "openHoursSunday": "string",
    "applications": [ … ],
    "cultures": [ … ],
    "infos": [ … ],
    "priceLists": [ … ],
    "warehouses": [ … ]
  }
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations