COMMERCE QUERY

Query API 3.0

DeliveryNote

Commerce Query API (v3.0)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Playground

https://{slug}.api-se.playground.norce.tech/commerce/query/3.0/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/query/3.0/

Production

https://{slug}.api-se.norce.tech/commerce/query/3.0/

Schemas

CustomerInfo

idinteger(int64)

The unique identifier of the customer info.

firstNamestring or null[ 0 .. 100 ] characters

The first name.

lastNamestring or null[ 0 .. 100 ] characters

The last name.

emailAddressstring or null[ 0 .. 255 ] characters

The email address.

phoneNumberstring or null[ 0 .. 100 ] characters

The phone number.

cellPhoneNumberstring or null[ 0 .. 100 ] characters

The cell phone number.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

rowidstring(byte)non-emptyrequired

The rowid, used for concurrency control.

companyNamestring or null[ 0 .. 100 ] characters

The company name.

careOfstring or null[ 0 .. 100 ] characters

The care of.

addressLine1string or null[ 0 .. 255 ] characters

The first line of the address.

addressLine2string or null[ 0 .. 255 ] characters

The second line of the address.

zipCodestring or null[ 0 .. 50 ] characters

The zip code.

citystring or null[ 0 .. 50 ] characters

The city.

regionstring or null[ 0 .. 100 ] characters

The region.

countryIdinteger or null(int32)

The country identifier.

clientIdinteger or null(int32)

The client identifier.

shippingPhoneNumberstring or null[ 0 .. 100 ] characters

The shipping phone number.

glnstring or null[ 0 .. 50 ] characters

The GLN.

orderBuyerCustomerInfoArray of objects or null(Order)

orderDropPointCustomerInfoArray of objects or null(Order)

orderPayerCustomerInfoArray of objects or null(Order)

orderShipToCustomerInfoArray of objects or null(Order)

{
  "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

idinteger(int64)

The unique identifier of the delivery note.

clientIdinteger(int32)

The client identifier.

noteNostring[ 0 .. 50 ] charactersrequired

The note number from the ERP or WMS.

supplierIdinteger or null(int32)

The supplier identifier, not commonly used.

typeIdinteger(int32)

The type identifier, Order Delivery (1).

referenceOrderIdinteger(int64)

The reference order identifier, link to the Order.

buyerCompanyIdinteger or null(int32)

The buyer company identifier, not used anymore, check Order for customer information.

buyerCompanyCodestring or null[ 0 .. 50 ] characters

The buyer company code, not used anymore, check Order for customer information.

buyerCustomerIdinteger or null(int32)

The buyer customer identifier, not used anymore, check Order for customer information.

buyerCustomerCodestring or null[ 0 .. 50 ] characters

The buyer customer code, not used anymore, check Order for customer information.

payerCompanyIdinteger or null(int32)

The payer company identifier, not used anymore, check Order for customer information.

payerCompanyCodestring or null[ 0 .. 50 ] characters

The payer company code, not used anymore, check Order for customer information.

payerCustomerIdinteger or null(int32)

The payer customer identifier, not used anymore, check Order for customer information.

payerCustomerCodestring or null[ 0 .. 50 ] characters

The payer customer code, not used anymore, check Order for customer information.

resellerCompanyIdinteger or null(int32)

The reseller company identifier, not used anymore, check Order for customer information.

resellerCompanyCodestring or null[ 0 .. 50 ] characters

The reseller company code, not used anymore, check Order for customer information.

resellerCustomerIdinteger or null(int32)

The reseller customer identifier, not used anymore, check Order for customer information.

resellerCustomerCodestring or null[ 0 .. 50 ] characters

The reseller customer code, not used anymore, check Order for customer information.

groupCodestring or null[ 0 .. 50 ] characters

The group code, not used anymore.

deliveryNamestring or null[ 0 .. 100 ] characters

The delivery name, commonly the customer name.

deliveryAttentionstring or null[ 0 .. 100 ] characters

The delivery attention.

deliveryCareOfstring or null[ 0 .. 100 ] characters

The delivery care of.

deliveryAddressLine1string or null[ 0 .. 255 ] characters

The delivery address line1.

deliveryAddressLine2string or null[ 0 .. 255 ] characters

The delivery address line2.

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.

deliveryDatestring or null(date-time)

The delivery date.

quantitynumber or null(decimal)

The quantity.

volumenumber or null(decimal)

The volume.

weightnumber or null(decimal)

The weight.

isPrintedboolean

Indicates whether the delivery note is printed, not used anymore.

deliveryTermsstring or null[ 0 .. 10 ] characters

The delivery terms.

deliveryModestring or null[ 0 .. 255 ] characters

The delivery mode.

sourcestring or null[ 0 .. 255 ] characters

The source.

deliveryMarkstring or null[ 0 .. 255 ] characters

The delivery mark.

noteTextstring or null[ 0 .. 255 ] characters

The note text.

departmentstring or null[ 0 .. 10 ] characters

The department.

centrestring or null[ 0 .. 10 ] characters

The centre.

shippingNostring or null[ 0 .. 50 ] characters

The shipping number.

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.

deliveryAddressIdinteger or null(int64)

The delivery address identifier.

divisionCodestring or null[ 0 .. 50 ] characters

The division code.

statusIdinteger(int32)

The status identifier, Delivered (4), Partly Delivered (8).

isForgottenboolean

Indicates whether the delivery note is forgotten.

forgottenByinteger or null(int32)

The forgotten by.

forgottenDatestring or null(date-time)

The forgotten date.

itemsArray of objects or null(DeliveryNoteItem)

packagesArray of objects or null(DeliveryNotePackage)

{
  "id": 0,
  "clientId": 0,
  "noteNo": "string",
  "supplierId": 0,
  "typeId": 0,
  "referenceOrderId": 0,
  "buyerCompanyId": 0,
  "buyerCompanyCode": "string",
  "buyerCustomerId": 0,
  "buyerCustomerCode": "string",
  "payerCompanyId": 0,
  "payerCompanyCode": "string",
  "payerCustomerId": 0,
  "payerCustomerCode": "string",
  "resellerCompanyId": 0,
  "resellerCompanyCode": "string",
  "resellerCustomerId": 0,
  "resellerCustomerCode": "string",
  "groupCode": "string",
  "deliveryName": "string",
  "deliveryAttention": "string",
  "deliveryCareOf": "string",
  "deliveryAddressLine1": "string",
  "deliveryAddressLine2": "string",
  "deliveryZipCode": "string",
  "deliveryCity": "string",
  "deliveryRegion": "string",
  "deliveryCountryId": 0,
  "deliveryDate": "2019-08-24T14:15:22Z",
  "quantity": 0,
  "volume": 0,
  "weight": 0,
  "isPrinted": true,
  "deliveryTerms": "string",
  "deliveryMode": "string",
  "source": "string",
  "deliveryMark": "string",
  "noteText": "string",
  "department": "string",
  "centre": "string",
  "shippingNo": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "deliveryAddressId": 0,
  "divisionCode": "string",
  "statusId": 0,
  "isForgotten": true,
  "forgottenBy": 0,
  "forgottenDate": "2019-08-24T14:15:22Z",
  "items": [
    { … }
  ],
  "packages": [
    { … }
  ]
}

Address

idinteger(int64)

The unique identifier of the address.

typeIdinteger or null(int32)

The type identifier.

namestring or null[ 0 .. 100 ] characters

The name of the address.

attentionstring or null[ 0 .. 100 ] characters

The attention.

careOfstring or null[ 0 .. 100 ] characters

The care of.

line1string or null[ 0 .. 255 ] characters

The first line of the address.

line2string or null[ 0 .. 255 ] characters

The second line of the address.

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.

emailAddressstring or null[ 0 .. 255 ] characters

The email address.

phoneNumberstring or null[ 0 .. 50 ] characters

The phone number.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

rowidstring(byte)non-emptyrequired

The rowid, used for concurrency checks.

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.

{
  "id": 0,
  "typeId": 0,
  "name": "string",
  "attention": "string",
  "careOf": "string",
  "line1": "string",
  "line2": "string",
  "zipCode": "string",
  "city": "string",
  "region": "string",
  "countryId": 0,
  "emailAddress": "string",
  "phoneNumber": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "rowid": "string",
  "clientId": 0,
  "shippingPhoneNumber": "string",
  "gln": "string"
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations