COMMERCE QUERY
/
Query API 3.0
/
Application
/
Gets all client divisions.

Query (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

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

Schemas

Application

Operations

Gets all order info types.

Request

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of order info types. The custom fields configured by the client for order, and orderitem records.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the order info type.

clientIdinteger(int32)

The client identifier.

applicationIdinteger(int32)

The application identifier.

codestring[ 0 .. 50 ] charactersrequired

The code of the order info type.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the order info type.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the order info type.

sortOrderinteger or null(int32)

The sort order for display purposes.

isActiveboolean

Indicates whether the order info type 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.

groupIdinteger(int32)

The group identifier, Order (1), OrderItem (2).

orderInfoArray of objects or null(OrderInfo)
culturesArray of objects or null(OrderInfoTypeCulture)
orderItemInfoArray of objects or null(OrderItemInfo)
]
Response
application/json
[
  {
    "id": 0,
    "clientId": 0,
    "applicationId": 0,
    "code": "string",
    "defaultName": "string",
    "defaultDescription": "string",
    "sortOrder": 0,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "groupId": 0,
    "orderInfo": [ … ],
    "cultures": [ … ],
    "orderItemInfo": [ … ]
  }
]

Gets all client divisions.

Request

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of client divisions. Divisions are called "stores" in admin and commerce services.

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

Gets all product relation types.

Request

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of product relation types.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the product relation type.

clientIdinteger(int32)

The client identifier.

codestring[ 0 .. 50 ] charactersrequired

The code of the product relation type.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the product relation type.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the product relation type.

isBidirectionalboolean

Indicates whether the product relation type is bidirectional.

isActiveboolean

Indicates whether the product relation type is active.

sortOrderinteger or null(int32)

The sort order for display purposes.

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.

culturesArray of objects or null(ProductRelationTypeCulture)
]
Response
application/json
[
  {
    "id": 0,
    "clientId": 0,
    "code": "string",
    "defaultName": "string",
    "defaultDescription": "string",
    "isBidirectional": true,
    "isActive": true,
    "sortOrder": 0,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "cultures": [ … ]
  }
]

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations