COMMERCE QUERY
/
Query API 3.0
/
Application
/
Gets all shopping info types.

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 client customer flags.

Request

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of client customer flags. Both customer and company enabled flags are included.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the customer flag.

clientIdinteger(int32)

The client identifier.

groupIdinteger(int32)

The group identifier.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the customer flag.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the customer flag.

availableOnCustomerboolean

Indicates whether available on customer is enabled (CustomerFlag).

availableOnCompanyboolean

Indicates whether available on company is enabled (CompanyFlag).

isActiveboolean

Indicates whether the customer flag 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.

isDefaultboolean

Indicates whether the customer flag is default, not used anymore.

externalReferencestring or null[ 0 .. 50 ] characters

The external reference, called 'Code' in other APIs and in the admin tool.

sortOrderinteger or null(int32)

The sort order for display purposes.

clientCompanyFlagArray of objects or null(ClientCompanyFlag)
clientCustomerFlagArray of objects or null(ClientCustomerFlag)
culturesArray of objects or null(CustomerFlagCulture)
group(CustomerFlagGroup (object or null))
One of:
]
Response
application/json
[
  {
    "id": 0,
    "clientId": 0,
    "groupId": 0,
    "defaultName": "string",
    "defaultDescription": "string",
    "availableOnCustomer": true,
    "availableOnCompany": true,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "isDefault": true,
    "externalReference": "string",
    "sortOrder": 0,
    "clientCompanyFlag": [ … ],
    "clientCustomerFlag": [ … ],
    "cultures": [ … ],
    "group": { … }
  }
]

Gets all shopping info types.

Request

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of shopping info types. The custom fields configured by the client for basket, and basketitem records.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the shopping info type.

clientIdinteger(int32)

The client identifier.

groupIdinteger(int32)

The group identifier.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the shopping info type.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the shopping info type.

dataTypestring[ 0 .. 50 ] charactersrequired

The data type. Contextual information for interpreting the value of the shopping info. For example, it could be 'string', 'decimal', 'date', etc.

defaultValuestring or null

The default value.

sortOrderinteger(int32)

The sort order for display purposes.

isActiveboolean

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

codestring or null[ 0 .. 50 ] characters

The code of the shopping info type.

quotationInfoArray of objects or null(QuotationInfo)
quotationItemInfoArray of objects or null(QuotationItemInfo)
culturesArray of objects or null(ShoppingInfoTypeCulture)
]
Response
application/json
[
  {
    "id": 0,
    "clientId": 0,
    "groupId": 0,
    "defaultName": "string",
    "defaultDescription": "string",
    "dataType": "string",
    "defaultValue": "string",
    "sortOrder": 0,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "code": "string",
    "quotationInfo": [ … ],
    "quotationItemInfo": [ … ],
    "cultures": [ … ]
  }
]

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

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations