Query (v1)

Download OpenAPI description
Languages
Servers

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

Schemas

ClientCompanyPaymentMethod

companyIdinteger(int32)

The company identifier.

codestring or null[ 0 .. 50 ] characters

The code of the client company payment method.

isActiveboolean

Indicates whether the client company payment method 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.

clientIdinteger or null(int32)

The client identifier.

invoiceCaptureCodestring or null[ 0 .. 100 ] characters

The invoice capture code.

company(ClientCompany (object or null))
One of:
{ "companyId": 0, "code": "string", "isActive": true, "created": "2019-08-24T14:15:22Z", "createdBy": 0, "updated": "2019-08-24T14:15:22Z", "updatedBy": 0, "clientId": 0, "invoiceCaptureCode": "string", "company": { "id": 0, "key": "string", "clientId": 0, "companyCodePrefix": "string", "companyCode": "string", "typeId": 0, "logoPath": "string", "organizationNo": "string", "name": "string", "emailAddress": "string", "phoneNumber": "string", "faxNumber": "string", "parentCompanyId": 0, "referId": 0, "referUrl": "string", "useBillingAddressAsShippingAddress": true, "oldCompanyCodePrefix": "string", "oldCompanyCode": "string", "isActive": true, "created": "2019-08-24T14:15:22Z", "createdBy": 0, "updated": "2019-08-24T14:15:22Z", "updatedBy": 0, "logoKey": "string", "normalizedOrganizationNo": "string", "applicationId": 0, "vatNo": "string", "addresses": [], "deliveryMethods": [], "discounts": [], "flags": [], "infos": [], "paymentMethods": [], "priceLists": [], "customers": [], "inverseParentCompany": [], "parentCompany": {} } }

ClientCompanyPriceList

companyIdinteger(int32)

The company identifier.

priceListIdinteger(int32)

The price list identifier.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

isExclusiveboolean

Indicates whether the client company price list is exclusive.

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.

company(ClientCompany (object or null))
One of:
{ "companyId": 0, "priceListId": 0, "created": "2019-08-24T14:15:22Z", "createdBy": 0, "isExclusive": true, "updated": "2019-08-24T14:15:22Z", "updatedBy": 0, "clientId": 0, "company": { "id": 0, "key": "string", "clientId": 0, "companyCodePrefix": "string", "companyCode": "string", "typeId": 0, "logoPath": "string", "organizationNo": "string", "name": "string", "emailAddress": "string", "phoneNumber": "string", "faxNumber": "string", "parentCompanyId": 0, "referId": 0, "referUrl": "string", "useBillingAddressAsShippingAddress": true, "oldCompanyCodePrefix": "string", "oldCompanyCode": "string", "isActive": true, "created": "2019-08-24T14:15:22Z", "createdBy": 0, "updated": "2019-08-24T14:15:22Z", "updatedBy": 0, "logoKey": "string", "normalizedOrganizationNo": "string", "applicationId": 0, "vatNo": "string", "addresses": [], "deliveryMethods": [], "discounts": [], "flags": [], "infos": [], "paymentMethods": [], "priceLists": [], "customers": [], "inverseParentCompany": [], "parentCompany": {} } }

Order

buyerCustomer(ClientCustomer (object or null))
One of:
idinteger(int64)

The unique identifier of the order.

clientIdinteger(int32)

The client identifier.

applicationIdinteger(int32)

The application identifier.

quotationIdinteger or null(int32)

The quotation identifier.

orderNostring[ 0 .. 50 ] charactersrequired

The order number, commonly same as quotation id unless overriden from the ERP confirmation response.

orderDatestring(date-time)

The date the order was placed.

buyerCompanyCodestring or null[ 0 .. 50 ] characters

The buyer company code.

buyerCompanyIdinteger or null(int32)

The buyer company identifier.

buyerCustomerCodestring or null[ 0 .. 50 ] characters

The buyer customer code.

buyerCustomerIdinteger or null(int32)

The buyer customer identifier.

payerCompanyCodestring or null[ 0 .. 50 ] characters

The payer company code.

payerCompanyIdinteger or null(int32)

The payer company identifier.

payerCustomerCodestring or null[ 0 .. 50 ] characters

The payer customer code.

payerCustomerIdinteger or null(int32)

The payer customer identifier.

resellerCompanyCodestring or null[ 0 .. 50 ] characters

The reseller company code, not used anymore.

resellerCompanyIdinteger or null(int32)

The reseller company identifier, not used anymore.

resellerCustomerCodestring or null[ 0 .. 50 ] characters

The reseller customer code, not used anymore.

resellerCustomerIdinteger or null(int32)

The reseller customer identifier, not used anymore.

groupCodestring or null[ 0 .. 50 ] characters

The group code, not used anymore.

statusIdinteger(int32)

The status identifier, common values are Created (0), Allocation (1), Confirmed (2), Delivered (4), Invoiced (5), Cancelled (6), Partly delivered (8).

salesRepContactIdinteger or null(int32)

The sales representative contact identifier, not used anymore.

sourcestring or null[ 0 .. 255 ] characters

The source of the order, 'WEB' is reserved for orders coming through Norce shopping and checkout processes.

deliveryTermsstring or null[ 0 .. 10 ] characters

The delivery terms, not used anymore.

deliveryModestring or null[ 0 .. 50 ] characters

The delivery mode, code from the DeliveryMethod setting.

deliveryDatestring or null(date-time)

The delivery date.

isPartDeliveryboolean

Indicates whether the order is partly delivered, can be true if goods ordered is partly delivered by a DeliveryNote.

paymentTermsstring or null[ 0 .. 100 ] characters

The payment terms, code from the PaymentMethod setting.

currencyIdinteger(int32)

The currency identifier.

vatRatenumber(decimal)

The VAT rate, not used anymore.

cashDiscountnumber(decimal)

The cash discount amount, not used anymore.

lineDiscountnumber(decimal)

The line discount amount, not used anymore.

freightCostnumber(decimal)

The freight cost excluding VAT, the same as the lineamount on the freight order item.

orderFeenumber(decimal)

The order fee, not used anymore.

deliveryAttentionstring or null[ 0 .. 100 ] characters

The delivery attention line, often name of the delivery recipient.

deliveryCareOfstring or null[ 0 .. 100 ] characters

The delivery care of line.

deliveryAddressLine1string or null[ 0 .. 255 ] characters

The first line of the delivery address.

deliveryAddressLine2string or null[ 0 .. 255 ] characters

The second line of the delivery address.

deliveryZipCodestring or null[ 0 .. 50 ] characters

The delivery zip code.

deliveryCitystring or null[ 0 .. 50 ] characters

The delivery city.

deliveryRegionstring or null[ 0 .. 100 ] characters

The delivery region.

deliveryCountryIdinteger or null(int32)

The delivery country identifier.

ledgerAccountstring or null[ 0 .. 50 ] characters

The ledger account, not used anymore.

departmentstring or null[ 0 .. 10 ] characters

The department, not used anymore.

centrestring or null[ 0 .. 10 ] characters

The centre, not used anymore.

externalPurchaseNostring or null[ 0 .. 50 ] characters

The external purchase number, not used anymore, usually has the quotation id.

salesCodestring or null[ 0 .. 50 ] characters

The sales code, not used anymore.

deliveryMarkstring or null[ 0 .. 255 ] characters

The delivery mark, copied from the CustomerOrderReference in the Quotation.

invoiceMarkstring or null[ 0 .. 255 ] characters

The invoice mark, copied from the CustomerInvoiceReference in the Quotation.

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.

payerCustomerInfoIdinteger or null(int64)

The payer customer info identifier, lookup key for CustomerInfo, where customer data is stored for guest customers, not having a ClientCustomer record.

estimatedDeliveryTimestring or null(date-time)

The estimated delivery time, not used anymore.

deliveryTimestring or null(date-time)

The actual delivery time, not used anymore.

buyerCustomerInfoIdinteger or null(int64)

The buyer customer info identifier, lookup key for CustomerInfo, where customer data is stored for guest customers, not having a ClientCustomer record.

shipToCustomerInfoIdinteger or null(int64)

The ship-to customer info identifier, lookup key for CustomerInfo, where customer data is stored for guest customers, not having a ClientCustomer record.

externalRefstring or null[ 0 .. 50 ] characters

The external reference, not used anymore.

paymentMethodIdinteger or null(int32)

The payment method identifier.

deliveryMethodIdinteger or null(int32)

The delivery method identifier.

orderTypeIdinteger or null(int32)

The order type identifier, Customer Order (1), Purchase Order (2), Recurring Order (3), Recurring Order Template (4), External Order (5).

isForgottenboolean

Indicates whether the order is forgotten, not used anymore.

forgottenByinteger or null(int32)

The identifier of the user who marked the order as forgotten, not used anymore.

forgottenDatestring or null(date-time)

The date and time the order was marked as forgotten, not used anymore.

dropPointCustomerInfoIdinteger or null(int64)

The drop point customer info identifier, lookup key for CustomerInfo.

dropPointCodestring or null[ 0 .. 50 ] characters

The drop point code.

yearinteger or null(int32)

The year.

weekinteger or null(int32)

The week number.

tmsReferencestring or null[ 0 .. 255 ] characters

The TMS reference, a reference identifier from the Transport system, not commonly used.

buyer(CustomerInfo (object or null))
One of:
deliveryNoteArray of objects or null(DeliveryNote)
dropPoint(CustomerInfo (object or null))
One of:
invoiceArray of objects or null(Invoice)
infosArray of objects or null(OrderInfo)
itemsArray of objects or null(OrderItem)
payer(CustomerInfo (object or null))
One of:
quotation(Quotation (object or null))
One of:
shipTo(CustomerInfo (object or null))
One of:
{ "buyerCustomer": { "id": 0, "key": "string", "clientId": 0, "customerCodePrefix": "string", "customerCode": "string", "typeId": 0, "emailAddress": "string", "socialSecurityNumber": "string", "title": "string", "firstName": "string", "middleName": "string", "lastName": "string", "suffix": "string", "phoneNumber": "string", "cellPhoneNumber": "string", "referId": 0, "referUrl": "string", "useBillingAddressAsShippingAddress": true, "oldCustomerNoPrefix": "string", "oldCustomerNo": "string", "replacementCustomerId": 0, "isActive": true, "created": "2019-08-24T14:15:22Z", "createdBy": 0, "updated": "2019-08-24T14:15:22Z", "updatedBy": 0, "lastOrderDate": "2019-08-24T14:15:22Z", "normalizedSocialSecurityNumber": "string", "applicationId": 0, "isForgotten": true, "forgottenBy": 0, "forgottenDate": "2019-08-24T14:15:22Z", "stoppedDate": "2019-08-24T14:15:22Z", "stoppedBy": 0, "crmId": "string", "account": [], "addresses": [], "companies": [], "flags": [], "infos": [], "orders": [] }, "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": { "id": 0, "firstName": "string", "lastName": "string", "emailAddress": "string", "phoneNumber": "string", "cellPhoneNumber": "string", "created": "2019-08-24T14:15:22Z", "createdBy": 0, "rowid": "string", "companyName": "string", "careOf": "string", "addressLine1": "string", "addressLine2": "string", "zipCode": "string", "city": "string", "region": "string", "countryId": 0, "clientId": 0, "shippingPhoneNumber": "string", "gln": "string", "orderBuyerCustomerInfo": [], "orderDropPointCustomerInfo": [], "orderPayerCustomerInfo": [], "orderShipToCustomerInfo": [] }, "deliveryNote": [ {} ], "dropPoint": { "id": 0, "firstName": "string", "lastName": "string", "emailAddress": "string", "phoneNumber": "string", "cellPhoneNumber": "string", "created": "2019-08-24T14:15:22Z", "createdBy": 0, "rowid": "string", "companyName": "string", "careOf": "string", "addressLine1": "string", "addressLine2": "string", "zipCode": "string", "city": "string", "region": "string", "countryId": 0, "clientId": 0, "shippingPhoneNumber": "string", "gln": "string", "orderBuyerCustomerInfo": [], "orderDropPointCustomerInfo": [], "orderPayerCustomerInfo": [], "orderShipToCustomerInfo": [] }, "invoice": [ {} ], "infos": [ {} ], "items": [ {} ], "payer": { "id": 0, "firstName": "string", "lastName": "string", "emailAddress": "string", "phoneNumber": "string", "cellPhoneNumber": "string", "created": "2019-08-24T14:15:22Z", "createdBy": 0, "rowid": "string", "companyName": "string", "careOf": "string", "addressLine1": "string", "addressLine2": "string", "zipCode": "string", "city": "string", "region": "string", "countryId": 0, "clientId": 0, "shippingPhoneNumber": "string", "gln": "string", "orderBuyerCustomerInfo": [], "orderDropPointCustomerInfo": [], "orderPayerCustomerInfo": [], "orderShipToCustomerInfo": [] }, "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": [] }, "shipTo": { "id": 0, "firstName": "string", "lastName": "string", "emailAddress": "string", "phoneNumber": "string", "cellPhoneNumber": "string", "created": "2019-08-24T14:15:22Z", "createdBy": 0, "rowid": "string", "companyName": "string", "careOf": "string", "addressLine1": "string", "addressLine2": "string", "zipCode": "string", "city": "string", "region": "string", "countryId": 0, "clientId": 0, "shippingPhoneNumber": "string", "gln": "string", "orderBuyerCustomerInfo": [], "orderDropPointCustomerInfo": [], "orderPayerCustomerInfo": [], "orderShipToCustomerInfo": [] } }

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations