COMMERCE QUERY

Query API 3.0

OrderInfo

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

OrderInfoType

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)

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

OrderInfo

orderIdinteger(int64)

The order identifier.

typeIdinteger(int32)

The order info 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.

order(Order (object or null))

One of:

type(OrderInfoType (object or null))

One of:

{
  "orderId": 0,
  "typeId": 0,
  "value": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientId": 0,
  "order": {
    "buyerCustomer": { … },
    "id": 0,
    "clientId": 0,
    "applicationId": 0,
    "quotationId": 0,
    "orderNo": "string",
    "orderDate": "2019-08-24T14:15:22Z",
    "buyerCompanyCode": "string",
    "buyerCompanyId": 0,
    "buyerCustomerCode": "string",
    "buyerCustomerId": 0,
    "payerCompanyCode": "string",
    "payerCompanyId": 0,
    "payerCustomerCode": "string",
    "payerCustomerId": 0,
    "resellerCompanyCode": "string",
    "resellerCompanyId": 0,
    "resellerCustomerCode": "string",
    "resellerCustomerId": 0,
    "groupCode": "string",
    "statusId": 0,
    "salesRepContactId": 0,
    "source": "string",
    "deliveryTerms": "string",
    "deliveryMode": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "isPartDelivery": true,
    "paymentTerms": "string",
    "currencyId": 0,
    "vatRate": 0,
    "cashDiscount": 0,
    "lineDiscount": 0,
    "freightCost": 0,
    "orderFee": 0,
    "deliveryAttention": "string",
    "deliveryCareOf": "string",
    "deliveryAddressLine1": "string",
    "deliveryAddressLine2": "string",
    "deliveryZipCode": "string",
    "deliveryCity": "string",
    "deliveryRegion": "string",
    "deliveryCountryId": 0,
    "ledgerAccount": "string",
    "department": "string",
    "centre": "string",
    "externalPurchaseNo": "string",
    "salesCode": "string",
    "deliveryMark": "string",
    "invoiceMark": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "payerCustomerInfoId": 0,
    "estimatedDeliveryTime": "2019-08-24T14:15:22Z",
    "deliveryTime": "2019-08-24T14:15:22Z",
    "buyerCustomerInfoId": 0,
    "shipToCustomerInfoId": 0,
    "externalRef": "string",
    "paymentMethodId": 0,
    "deliveryMethodId": 0,
    "orderTypeId": 0,
    "isForgotten": true,
    "forgottenBy": 0,
    "forgottenDate": "2019-08-24T14:15:22Z",
    "dropPointCustomerInfoId": 0,
    "dropPointCode": "string",
    "year": 0,
    "week": 0,
    "tmsReference": "string",
    "buyer": { … },
    "deliveryNote": [ … ],
    "dropPoint": { … },
    "invoice": [ … ],
    "infos": [ … ],
    "items": [ … ],
    "payer": { … },
    "quotation": { … },
    "shipTo": { … }
  },
  "type": {
    "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": [ … ]
  }
}

OrderInfoTypeCulture

typeIdinteger(int32)

The info type identifier.

cultureCodestring or null[ 0 .. 16 ] characters

The culture code (e.g. en-US).

namestring or null[ 0 .. 50 ] characters

The culture specific name of the order info type.

descriptionstring or null[ 0 .. 500 ] characters

The culture specific description of the order info type.

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.

clientIdinteger or null(int32)

The client identifier.

type(OrderInfoType (object or null))

One of:

{
  "typeId": 0,
  "cultureCode": "string",
  "name": "string",
  "description": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientId": 0,
  "type": {
    "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": [ … ]
  }
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations