COMMERCE QUERY

Query API 3.0

QuotationItemInfo

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

ShoppingInfoType

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)

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

QuotationItemInfo

idinteger(int64)

The unique identifier of the quotation item info.

quotationItemIdinteger(int32)

The quotation item identifier.

typeIdinteger(int32)

The type identifier.

valuestring or null

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.

quotationItem(QuotationItem (object or null))

One of:

type(ShoppingInfoType (object or null))

One of:

{
  "id": 0,
  "quotationItemId": 0,
  "typeId": 0,
  "value": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientId": 0,
  "quotationItem": {
    "id": 0,
    "quotationId": 0,
    "lineNumber": 0,
    "customerLineCode": "string",
    "statusId": 0,
    "partNo": "string",
    "productNameWhenCreated": "string",
    "bundlePartno": "string",
    "bundleTypeId": 0,
    "qty": 0,
    "onHandWhenCreated": 0,
    "priceSale": 0,
    "priceSaleWhenCreated": 0,
    "priceListId": 0,
    "patternId": 0,
    "vatCode": 0,
    "vatValue": 0,
    "promotionIdSeed": "string",
    "campaignId": 0,
    "searchString": "string",
    "categoryItemId": 0,
    "parentPartnoId": "string",
    "parentLineNumber": 0,
    "comment": "string",
    "externalData": "string",
    "refererId": 0,
    "refererUrl": "string",
    "priceReseller": 0,
    "isLocked": true,
    "totalPriceSaleExVat": 0,
    "totalPriceSaleIncVat": 0,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "expectedDeliveryDate": "2019-08-24T14:15:22Z",
    "requirementPromotionIdSeed": "string",
    "isPriceManual": true,
    "qty2": 0,
    "clientId": 0,
    "priceListLocked": true,
    "rowId": "string",
    "quotation": { … },
    "infos": [ … ]
  },
  "type": {
    "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": [ … ]
  }
}

QuotationItem

idinteger(int32)

The unique identifier of the quotation item.

quotationIdinteger(int32)

The quotation identifier.

lineNumberinteger(int32)

The line number. Should be unique within the same quotation.

customerLineCodestring or null[ 0 .. 50 ] characters

The customer line code. Optional. It can be used to store the line code from customer system for reference.

statusIdinteger(int32)

The status identifier.

partNostring[ 0 .. 50 ] charactersrequired

The part number.

productNameWhenCreatedstring or null[ 0 .. 255 ] characters

The product name when created.

bundlePartnostring or null[ 0 .. 50 ] characters

The bundle partno. If the quotation item is part of a bundle, this field indicates the partno of the bundle. Not commonly used.

bundleTypeIdinteger or null(int32)

The bundle type identifier.

qtyinteger(int32)

The quantity of the quotation item.

onHandWhenCreatedinteger or null(int32)

The on hand value when created.

priceSalenumber or null(decimal)

The unit price.

priceSaleWhenCreatednumber or null(decimal)

The unit price when created.

priceListIdinteger(int32)

The price list identifier.

patternIdinteger or null(int32)

The pattern identifier.

vatCodeinteger or null(int32)

The vat code.

vatValuenumber or null(decimal)

The vat amount.

promotionIdSeedstring or null[ 0 .. 50 ] characters

The promotion id seed. Comma separated list of promotion ids. Used for tracking which promotions have been applied to the quotation item.

campaignIdinteger or null(int32)

The campaign identifier. Not used anymore.

searchStringstring or null[ 0 .. 50 ] characters

The search string. Not used anymore.

categoryItemIdinteger or null(int32)

The category item identifier. Not used anymore.

parentPartnoIdstring or null[ 0 .. 50 ] characters

The parent partno identifier. Used when item is a child to a bundle or grouped together with other items.

parentLineNumberinteger or null(int32)

The parent line number. Used when item is a child to a bundle or grouped together with other items.

commentstring or null[ 0 .. 255 ] characters

A comment or note.

externalDatastring or null

The external data. Not commonly used, info types is used instead.

refererIdinteger or null(int32)

The referer identifier. Not commonly used, info types is used instead.

refererUrlstring or null[ 0 .. 255 ] characters

The referer url. Not commonly used, info types is used instead.

priceResellernumber or null(decimal)

The price reseller. Not commonly used, info types is used instead.

isLockedboolean or null

Indicates whether the quotation item is locked. When a quotation item is in a locked state, it cannot be modified.

totalPriceSaleExVatnumber or null(decimal)

The total price sale excluding vat. Subtotal of the sale price * quantity.

totalPriceSaleIncVatnumber or null(decimal)

The total price sale including vat. Subtotal of the sale price (including vat) * quantity.

createdstring(date-time)

The date and time the record was created.

createdByinteger or null(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

expectedDeliveryDatestring or null(date-time)

The expected delivery date. Not commonly used, info types is used instead.

requirementPromotionIdSeedstring or null[ 0 .. 255 ] characters

Comma separated list of promotions that has this item in its requirement.

isPriceManualboolean or null

Indicates whether the quotation item is a manual price.

qty2number or null(decimal)

The qty2. The quantity, but supports decimal value. Not commonly used. Not commonly supported by external payment systems.

clientIdinteger or null(int32)

The client identifier.

priceListLockedboolean

Indicates whether price list is locked on the item. Best price selection is not applied.

rowIdstring(byte)non-emptyrequired

The row identifier. Used internally for Concurrency checks.

quotation(Quotation (object or null))

One of:

infosArray of objects or null(QuotationItemInfo)

{
  "id": 0,
  "quotationId": 0,
  "lineNumber": 0,
  "customerLineCode": "string",
  "statusId": 0,
  "partNo": "string",
  "productNameWhenCreated": "string",
  "bundlePartno": "string",
  "bundleTypeId": 0,
  "qty": 0,
  "onHandWhenCreated": 0,
  "priceSale": 0,
  "priceSaleWhenCreated": 0,
  "priceListId": 0,
  "patternId": 0,
  "vatCode": 0,
  "vatValue": 0,
  "promotionIdSeed": "string",
  "campaignId": 0,
  "searchString": "string",
  "categoryItemId": 0,
  "parentPartnoId": "string",
  "parentLineNumber": 0,
  "comment": "string",
  "externalData": "string",
  "refererId": 0,
  "refererUrl": "string",
  "priceReseller": 0,
  "isLocked": true,
  "totalPriceSaleExVat": 0,
  "totalPriceSaleIncVat": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "expectedDeliveryDate": "2019-08-24T14:15:22Z",
  "requirementPromotionIdSeed": "string",
  "isPriceManual": true,
  "qty2": 0,
  "clientId": 0,
  "priceListLocked": true,
  "rowId": "string",
  "quotation": {
    "id": 0,
    "applicationId": 0,
    "salesContactId": 0,
    "buyerAccountKey": "string",
    "buyerAccountId": 0,
    "payerAccountId": 0,
    "payerAccountKey": "string",
    "statusId": 0,
    "isPrimary": true,
    "name": "string",
    "validTo": "2019-08-24T14:15:22Z",
    "isDeletable": true,
    "comment": "string",
    "rejectionReasonId": 0,
    "modified": "2019-08-24T14:15:22Z",
    "browsed": "2019-08-24T14:15:22Z",
    "paymentMethodId": 0,
    "deliveryMethodId": 0,
    "ipAddress": "string",
    "payerFirstName": "string",
    "payerMiddleName": "string",
    "payerLastName": "string",
    "payerCellPhoneNumber": "string",
    "payerEmail": "string",
    "currencyId": 0,
    "resellerCustomerId": 0,
    "isLocked": true,
    "discountCode": "string",
    "isActive": true,
    "parentQuotationId": 0,
    "clientId": 0,
    "buyerCompanyId": 0,
    "payerCompanyId": 0,
    "hasPaymentTransaction": true,
    "buyerFirstName": "string",
    "buyerMiddleName": "string",
    "buyerLastName": "string",
    "buyerCellPhoneNumber": "string",
    "buyerEmail": "string",
    "customerOrderReference": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "referId": 0,
    "referUrl": "string",
    "payerSocialSecurityNumber": "string",
    "buyerCustomerId": 0,
    "payerCustomerId": 0,
    "shipToCustomerId": 0,
    "rowId": "string",
    "deleteDate": "2019-08-24T14:15:22Z",
    "pickupCode": "string",
    "attestedBy": 0,
    "modifiedBy": 0,
    "typeId": 0,
    "doHold": true,
    "deliveryMethodCode": "string",
    "freightPrice": 0,
    "customerInvoiceReference": "string",
    "year": 0,
    "week": 0,
    "salesAreaId": 0,
    "payerPhoneNumber": "string",
    "buyerPhoneNumber": "string",
    "order": [ … ],
    "addresses": [ … ],
    "infos": [ … ],
    "items": [ … ]
  },
  "infos": [
    { … }
  ]
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations