COMMERCE QUERY

Query API 3.0

QuotationCustomerAddress

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

Quotation

idinteger(int32)

The unique identifier of the quotation.

applicationIdinteger(int32)

The application identifier.

salesContactIdinteger or null(int32)

The sales contact identifier, not used anymore.

buyerAccountKeystring(guid)

The buyer account key.

buyerAccountIdinteger or null(int32)

The buyer account identifier.

payerAccountIdinteger or null(int32)

The payer account identifier.

payerAccountKeystring or null(guid)

The payer account key.

statusIdinteger(int32)

The status identifier. Basket (3), Deleted (4), Accepted (5), Ready for payment (7), Payment Accepted (8), Saved (9), Order (10), Recurring order (21), Opened for post purchase upsell (22).

isPrimaryboolean

Indicates whether the quotation is primary, not used anymore.

namestring or null[ 0 .. 50 ] characters

The name of the quotation, used for saved baskets.

validTostring or null(date-time)

The end date, not commonly used. Use info type instead.

isDeletableboolean

Indicates whether the quotation is deletable.

commentstring or null[ 0 .. 250 ] characters

A comment or note.

rejectionReasonIdinteger or null(int32)

The rejection reason identifier, not commonly used.

modifiedstring or null(date-time)

The date and time the record was last updated.

browsedstring or null(date-time)

The browsed date and time, not used anymore.

paymentMethodIdinteger or null(int32)

The payment method identifier.

deliveryMethodIdinteger or null(int32)

The delivery method identifier.

ipAddressstring or null[ 0 .. 50 ] characters

The ip address.

payerFirstNamestring or null[ 0 .. 100 ] characters

The payer first name.

payerMiddleNamestring or null[ 0 .. 100 ] characters

The payer middle name.

payerLastNamestring or null[ 0 .. 100 ] characters

The payer last name.

payerCellPhoneNumberstring or null[ 0 .. 50 ] characters

The payer cell phone number.

payerEmailstring or null[ 0 .. 255 ] characters

The payer email.

currencyIdinteger(int32)

The currency identifier.

resellerCustomerIdinteger or null(int32)

The reseller customer identifier, not commonly used.

isLockedboolean or null

Indicates whether the quotation is locked. When a quotation is in a locked state, it cannot be modified. This is typically used to prevent changes to a quotation that is under review or has been accepted.

discountCodestring or null

The discount code, from the applied promotions, several codes are separated by a comma.

isActiveboolean or null

Indicates whether the quotation is active.

parentQuotationIdinteger or null(int32)

The parent quotation identifier, not commonly used. Used for linking to an original quotation.

clientIdinteger or null(int32)

The client identifier.

buyerCompanyIdinteger or null(int32)

The buyer company identifier.

payerCompanyIdinteger or null(int32)

The payer company identifier.

hasPaymentTransactionboolean or null

Indicates whether the quotation has payment transaction.

buyerFirstNamestring or null[ 0 .. 100 ] characters

The buyer first name.

buyerMiddleNamestring or null[ 0 .. 100 ] characters

The buyer middle name.

buyerLastNamestring or null[ 0 .. 100 ] characters

The buyer last name.

buyerCellPhoneNumberstring or null[ 0 .. 50 ] characters

The buyer cell phone number.

buyerEmailstring or null[ 0 .. 255 ] characters

The buyer email.

customerOrderReferencestring or null[ 0 .. 50 ] characters

The customer order reference. Usually used as a note on the delivery slip, copied to DeliveryMark on the Order here in Query and is called OrderReference in the Basket model in commerce services.

createdstring or null(date-time)

The date and time the record was created.

createdByinteger or null(int32)

The identifier of the user who created the record.

referIdinteger or null(int32)

The refer identifier, not commonly used.

referUrlstring or null[ 0 .. 255 ] characters

The refer url, not commonly used.

payerSocialSecurityNumberstring or null[ 0 .. 50 ] characters

The payer social security number, not commonly used.

buyerCustomerIdinteger or null(int32)

The buyer customer identifier.

payerCustomerIdinteger or null(int32)

The payer customer identifier.

shipToCustomerIdinteger or null(int32)

The ship to customer identifier.

rowIdstring(byte)non-emptyrequired

The row identifier, concurrency token, for internal use.

deleteDatestring or null(date-time)

The delete date, marked for deletion at specified date.

pickupCodestring or null[ 0 .. 50 ] characters

The pickup code.

attestedByinteger or null(int32)

The attested by, not commonly used.

modifiedByinteger or null(int32)

The identifier of the user who last updated the record.

typeIdinteger or null(int32)

The type identifier, normal basket (1), Saved (2), Template (3).

doHoldboolean

Indicates whether do hold is enabled, signal for manual check in ERP, not commonly used.

deliveryMethodCodestring or null[ 0 .. 255 ] characters

The delivery method code.

freightPricenumber or null(decimal)

The freight price.

customerInvoiceReferencestring or null[ 0 .. 50 ] characters

The customer invoice reference. Usually used as a note on the invoice, copied to InvoiceMark on the Order here in Query and is called InvoiceReference in the Basket model in commerce services.

yearinteger or null(int32)

Created year.

weekinteger or null(int32)

Created week.

salesAreaIdinteger or null(int32)

The sales area identifier.

payerPhoneNumberstring or null[ 0 .. 50 ] characters

The payer phone number.

buyerPhoneNumberstring or null[ 0 .. 50 ] characters

The buyer phone number.

orderArray of objects or null(Order)

addressesArray of objects or null(QuotationCustomerAddress)

infosArray of objects or null(QuotationInfo)

itemsArray of objects or null(QuotationItem)

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

QuotationCustomerAddress

idinteger(int32)

The unique identifier.

quotationIdinteger(int32)

The quotation identifier.

clientCustomerAddressIdinteger or null(int32)

The client customer address identifier, if its saved on the customer.

clientCompanyAddressIdinteger or null(int32)

The client company address identifier, if its saved on the company.

customerIdinteger or null(int32)

The customer identifier.

companyIdinteger or null(int32)

The company identifier.

typeIdinteger(int32)

The type identifier, Billing address (1), Shipping address (2), Visit address (3), drop point address (4).

careOfstring or null[ 0 .. 100 ] characters

The care of.

addressLine1string or null[ 0 .. 255 ] characters

The first line.

addressLine2string or null[ 0 .. 255 ] characters

The second line.

zipCodestring or null[ 0 .. 50 ] characters

The zip code.

citystring or null[ 0 .. 50 ] characters

The city.

regionstring or null[ 0 .. 50 ] characters

The region.

countryIdinteger or null(int32)

The country identifier.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

companyNamestring or null[ 0 .. 100 ] characters

The company name.

firstNamestring or null[ 0 .. 100 ] characters

The first name.

lastNamestring or null[ 0 .. 100 ] characters

The last name.

cellPhoneNumberstring or null[ 0 .. 50 ] characters

The cell phone number.

emailstring or null[ 0 .. 255 ] characters

The email.

clientIdinteger or null(int32)

The client identifier.

shippingPhoneNumberstring or null[ 0 .. 50 ] characters

The shipping phone number.

glnstring or null[ 0 .. 50 ] characters

The GLN.

quotation(Quotation (object or null))

One of:

{
  "id": 0,
  "quotationId": 0,
  "clientCustomerAddressId": 0,
  "clientCompanyAddressId": 0,
  "customerId": 0,
  "companyId": 0,
  "typeId": 0,
  "careOf": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "zipCode": "string",
  "city": "string",
  "region": "string",
  "countryId": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "companyName": "string",
  "firstName": "string",
  "lastName": "string",
  "cellPhoneNumber": "string",
  "email": "string",
  "clientId": 0,
  "shippingPhoneNumber": "string",
  "gln": "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": [ … ]
  }
}

QuotationInfo

idinteger(int64)

The unique identifier of the quotation info.

quotationIdinteger(int32)

The quotation 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.

quotation(Quotation (object or null))

One of:

type(ShoppingInfoType (object or null))

One of:

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

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations