Last updated

Connect Order schemas

Import of order statuses, delivery notes and invoices and sending out new orders to integrated systems.

Address

Boxstring

Box information. Max length: 100

CareOfstring

Care of information. Max length: 100

Citystring

City. Max length: 50

Countrystring

Country code in ISO 3166-1 alpha-2 format, e.g. SE, BY. Max length: 2

Line1string

First line of address. Max length: 100

Line2string

Second line of address. Max length: 100

Regionstring

Region. Max length: 50

Typestring

Always null. Deprecated

ZipCodestring

Zip code. Max length: 50

CancelOrderRequest

ClientOrderRefinteger(int32)required

Basket/Quotation id. Used for order matching.

ErpOrderNostringrequired

ERP order number. Used for order matching.

PaymentsArray of objects(Payment)(Payment)

If supplied, a cancel call is made for all included payments. Required property for each Payment is PaymentRef.

ClientCustomer

Companyobject(Company)(Company)

Represents a company.

Personobject(Person)(Person)

Represents information about person related to an order.

CodeValue

Codestring

Configurable identifier in Norce Commerce. This has erroneous behaviour.

Code2string

Configurable identifier in Norce Commerce.

Idinteger(int32)

Norce Commerce internal id for the info type (use code instead)

Valuestring

The value set to the item from an integrated system to Norce Commerce.

Company

AdditionalInfoArray of objects(CodeValue)(CodeValue)

Always null, deprecated.

AddressesArray of objects(Address)(Address)

Always null, deprecated.

Codestring

Company code. If exists the company is already in ERP. Max length: 50

DeliveryCodeLimitboolean

Always false, deprecated.

DeliveryCodesArray of strings

Always null, deprecated.

Emailstring

Always null, deprecated.

Faxstring

Always null, deprecated.

IsActiveboolean

Always false, deprecated.

Namestring

Company name. Max length: 100

PaymentCodeLimitboolean

Always false, decprecated.

PaymentCodesArray of strings

Always null, deprecated.

Phonestring

Always null, deprecated.

PriceListCodesArray of strings

Always null, deprecated.

PriceListLimitboolean

Always false, deprecated.

VatNostring

VAT number. Max length: 50

DeliveryNote

Boxstring

Box information. Max length: 100

CareOfstring

Care of information. Max length: 100

Citystring

City. Max length: 50

Countrystring

Country code in ISO 3166-1 alpha-2 format, e.g. SE, BY. Max length: 2

Line1string

First line of address. Max length: 100

Line2string

Second line of address. Max length: 100

Regionstring

Region. Max length: 50

Typestring

Always null. Deprecated

ZipCodestring

Zip code. Max length: 50

DeliveryNoteItem

ItemNostringrequired

Part no of delivered item.

Qtynumberrequired

Quantity of items shipped.

RowNumbernumberrequired

Delivery note line number.

Commentstring

Supplier comment.

Descriptionstring

Item description.

Idinteger

Always null, deprecated.

DeliveryNotePackage

Idinteger

Always null, deprecated

ParcelNumberstring

Tracking number.

StatusIdinteger(int32)

Parcel status:<br>4 = Delivered<br>6 = Canceled<br>11 = Ready for pickup<br>12 = Pickedup<br>20 = Reserved

Discount

Amountnumber

Discount amount.

Codestring

Discount code. Used for discount matching in Norce Commerce.

Typestring

Discount type

Fee

Amountnumber

Fee amount.

Descriptionstring

Fee description.

Typeinteger(int32)

Fee type.<br>0 = Shipping<br>1 = Invoice

VatRatenumber

VAT in percent.

ApplicationKeystring(Guid)

Application from where the order is created.

Invoice

ClientOrderRefinteger(int32)required

Reference basket/quotation id.

CurrencyCodestringrequired

Currency code, e.g. SEK. Max length: 3

ErpOrderNostringrequired

Reference ERP order number.

InvoiceDatestring(DateTime)required

Invoice creation date.

InvoiceNostring

Invoice identification number. Must be unique.

AddressLine1string

First line of receiver's address.

AddressLine2string

Second line of receiver's address.

ApplicationKeystring(Guid)

Application identifier.

Attentionstring

Receiver attention.

CareOfstring

Receiver care of.

Citystring

Receiver's city.

Commentstring

Client comment.

Countrystring

Receiver's country.

CountryCodestring

Country code (e.g. 'SE') explicit set for invoice to be forwarded to PSP.

CreditedInvoiceNostring

Invoice number of the invoice to credit (Only mandatory for credits).

CultureCodestring

Culture code (e.g. 'sv-SE') explicit set for invoice to be forwarded to PSP.

DeliveryDatestring(DateTime)

Date when order was shipped.

Glnstring

Global location number. Identifier for company/customer.

GroupCodestring

Code used for grouping of invoices (for partial invoicing).

InvoiceDueDatestring(DateTime)

Last date for invoice payments.

InvoiceRoundOffnumber

Total invoice round off.

IsLastInvoiceForOrderboolean

Determines if all invoices already received in case of partial payments. Null is considered as true.

ItemsArray of objects(InvoiceItem)(InvoiceItem)

List of invoiced order items. Mandatory for PSP capture.

Namestring

Receiver name

Paymentobject(Payment)(Payment)

Represents successful payment reservation. Either PaymentCode or PaymentRef must be provided.

PaymentMethodCodestring

Code for payment method used (for receipts).

PaymentMethodNamestring

Name of payment method used (for receipts).

Regionstring

Receiver's region.

SuppressPspCallboolean

Set to true to suppress a PSP call for this invoice. Invoice will be stored as information only.

TotalAmountnumber

Deprecated

Vatnumber

VAT amount

VatRoundOffnumber

Deprecated

ZipCodestring

Receiver's zip code.

InvoiceItem

PartNostringrequired

Item part no.

Quantityinteger(int32)required

Quantity of invoiced items.

UnitPricenumberrequired

Unit price

Descriptionstring

Item description. Mandatory for PSP capture.

Discountnumber

Deprecated

LineAmountnumber

Deprecated

LineNonumber

Line number.

PriceListstring

Item price list.

ProductNamestring

Product name.

SalePricenumber

Deprecated

UnitVatnumber

Unit VAT amount. Mandatory for PSP capture.

VatRatenumber

VAT rate in percent. Mandatory for PSP capture.

OrderInfo

Codestringrequired

Info code. Used for info matching.

Valuestring

Value to set

OrderItem

Discountnumberrequired

Discount

LineNointeger(int32)required

Norce Commerce generated row identifier. Unique within the order.

PartNostringrequired

Article number (Part No) in Norce Commerce.

Quantityinteger(int32)required

Number of items ordered.

Quantity2numberrequired

Item quantity for non-integer values.

Typestringrequired

Type of product.

Enum"Undefined""ErpStandard""Refurbished""Freight""Insurance""GiftCertificate""Bid""Download""Structure""Invoice"
TypeGroupstringrequired

Product type group.

Enum"Undefined""Physical""Virtual""Fee""Service""AddedFee"
UnitPricenumberrequired

Sale price for one item only excluding VAT (to get the row amount you multiply with quantity).

UnitPriceOriginalnumberrequired

Sale price before discounts.

UnitVatnumberrequired

VAT amount for one item (to get the row VAT multiply with quantity).

VatRatenumberrequired

VAT in percent

AdditionalInfoArray of objects(CodeValue)(CodeValue)

Client specific information on order item.

Commentstring

Row comment.

Descriptionstring

Product description (ERP name in Norce Commerce).

ErpPartNostring

Article number in ERP (usually same as PartNo, different for SKU type 13 'Accumulation').

InternalProductIdinteger(int32)

Internal product id in Norce Commerce.

ParentLineNointeger(int32)

Exists if the row is a child to another row, e.g. in case of service articles or items in a package/bundle.

PriceListNointeger(int32)

Price list from which the price is derived.

PriceListsArray of objects(PriceListItem)(PriceListItem)

All price lists that the unit price original is based on. This is a list of all pricelists in the hierarchy.

PromotionsArray of objects(Promotion)(Promotion)

List of all promotions applied to the order item.

UnitOfMeasurestring

Unit of measurement, e.g. pieces, mm, g.

OrderRequest

AdditionalInfoArray of objects(CodeValue)(CodeValue)

Client specific information on the order

BillToobject(ClientCustomer)(ClientCustomer)

Represents customer, either a person or a company.

ClientOrderRefstring

Usually weborder number (basket id in Norce Commerce). For orders from external source this is their number. Max length: 50

CurrencyCodestring

Currency code in ISO 4217 format, e.g. "SEK", "EUR", "USD". Max length: 3

CustomerOrderCommentstring

Comment field

CustomerOrderRefstring

Buyers reference, usually added in the checkout for B2B orders. Max length: 50

DiscountsArray of objects(Discount)(Discount)

List of order discounts that are not represented on order lines. Not commonly used.

DoHoldboolean

True if web solution thinks that this order should be manually validated before processed

ErpOrderNostring

Usually empty. If exists this is a suggestion from web solution which order number the order should have in ERP. Max length: 50

FeesArray of objects(Fee)(Fee)

Collection of fees on the order. Not commonly used, the fees are mostly implemented as order items with TypeGroup "Fee".

Headerobject(Header)(Header)

Header information about order.

ItemsArray of objects(OrderItem)(OrderItem)

Collection of order rows. Other than the articles this collection can also contain fees such as freight.

OrderTypeinteger(int32)

Order type:<br>1 = Order<br>3 = Subscription/Recurring order<br>5 = External order

PaymentsArray of objects(Payment)(Payment)

An order can have several payments. Usually this is only one, but sometime there are an additional payment method like giftcard or a voucher.

ReferIdinteger(int32)

If order is created from a referral like an ad

SalesContactCodestring

Code of sales contact if a sales rep should be marked as seller. Max length: 50

SalesContactDivisionstring

Code of sales department if a sales dep should be marked as seller. Max length: 50

SellToobject(ClientCustomer)(ClientCustomer)

Represents customer, either a person or a company.

ShipToobject(ClientCustomer)(ClientCustomer)

Represents customer, either a person or a company.

ShippingAdviceobject(ShippingAdvice)(ShippingAdvice)

Represents order shipping information

Sourcestring

Order source. Should be WEB for all orders created from client web sites.

SubmitDatestring(DateTime)

Timestamp when order was created in Norce Commerce.

OrderResponse

HasErpOrderNobooleanrequired

True if ErpOrder number is provided.

StatusCodestringrequired

Order response status. Allowed values are "OK" or "Failed". Max length: 50

Enum"OK""Failed"
Descriptionstring

Use this for a more information if status code is failed. Max length: 255

ErpOrderNostring

Order number from the ERP, if available. Can be sent in with SendOrderStatus as well. Max length: 50

Payment

PaymentCodeinteger(int32)required

Payment code. Used for payment matching.

PaymentMethodCodestringrequired

Payment method that should be sent in to the ERP, the code is configurable in Norce Commerce.

PaymentRefstringrequired

Transaction identifier from 3rd party, like payment service provider.

AdditionalInfoArray of objects(CodeValue)(CodeValue)

3rd party specific information abount payment (client and PSP decides what this can contain).

Amountnumber

Amount paid or reserved including VAT after rounding rules.

CurrencyCodestring

Currency code in ISO 4217 format, e.g. "SEK", "EUR", "USD". Max length: 3

Person

Addressobject(Address)(Address)

Represents person or company address.

CellPhonestring

Mobile phone number. Max length: 50

CompanyCodestring

Always null, deprecated.

CustomerCodestring

Customer code. If exists the person is already in ERP. Max length: 50

Emailstring

Personal email. Max length: 255

FirstNamestring

Person name. Max length: 50

IsActiveboolean

Deprecated

JobTitlestring

Person job title. Max length: 10

LastNamestring

Person surname. Max length: 50

PrivatePhonestring

Private phone number. Max length: 50

SSNstring

Social security number. Max length: 50

WorkPhonestring

Work phone number. Max length: 50

PickupStore

AdditionalInfoArray of objects(CodeValue)(CodeValue)

3rd party specific information on pickup point (client and transporter decides what this can contain).

Addressobject(Address)(Address)

Represents person or company address.

Codestring

Transporter code for store.

IsDropPointboolean

Determines if store is pick up point.

Namestring

Store name

PriceListItem

IsActiveboolean

Sets item in price list to active or inactive.

IsStandardPriceListboolean

Determines if price list is standard.

PriceListNamestring

Name of price list. Max length: 50

QtyBreakinteger(int32)

Threshold value for applying price list based on item quantity.

UnitPricenumber

Sale price for one item only excluding VAT.

Promotion

AppliedAmountnumber

Amount applied to the order item from this promotion.

DiscountCodestring

External code for the promotion (if configured in Norce Commerce). Max length: 50

Idinteger(int32)

Norce Commerce internal id for the promotion.

Namestring

Name of the promotion. Max length: 255

SendOrderStatusRequest

ClientOrderRefinteger(int32)required

Quotation/basket id. Used for order matching as reference.

ErpOrderNostringrequired

ERP order number. Used for order matching.

OrderStatusstringrequired

Order status.

Enum"Allocation""Confirmed""BackOrder""Delivered""Invoiced""Cancelled""CreditControl""PartlyDelivered""Acknowledged""ErpConfirmed"
AccountIdinteger(int32)

Norce Commerce account used for order update.

InfosArray of objects(OrderInfo)(OrderInfo)

List of additional order information fields.

Shipment

ApplicationKeystring(uuid)required

Application identifier

DeliveryNoteNostringrequired

External identifier for the delivery note.

InvoiceNostringrequired

External identifier for related invoice.

ShipmentNostringrequired

External identifier for shipment.

SourceWarehouseCodestringrequired

External identifier for the warehouse to ship items from.

TargetWarehouseCodestringrequired

External identifier for the warehouse to receive the items.

Barcodestring

Barcode for whole shipment (individual shipment packages may have individual barcodes)

CarrierNamestring

Carrier service name

CarrierReferencestring

Carrier service shipment reference

CarrierTrackingUrlstring(uri)

Carrier service tracking url.

Commentstring

User comment.

ItemsArray of objects(ShipmentItem)(ShipmentItem)

Items in the shipment

ReceiverNamestring

Name of receiver

SenderNamestring

Name of sender

ShipmentPackagesArray of objects(ShipmentPackage)(ShipmentPackage)

List of shipment parts.

ShipmentWarehouseobject(Address)(Address)

Represents person or company address.

TargetWarehouseAddressobject(Address)(Address)

Represents person or company address.

ShipmentItem

LineNointeger(int32)required

Line number

PartNostringrequired

The item's part number

Quantityinteger(int32)required

Quantity of the item

Namestring

Name of the item.

PackageNostring

External reference to which shipment package that includes this item.

Pricenumber

Deprecated. Use PurchaseCost.

PurchaseCostnumber

Purchase cost of the item.

UnitCostnumber

Unit cost of the item.

ShipmentPackage

PackageNostringrequired

External identifier for the package. May be referenced on a shipment item.

Barcodestring

Barcode for the shipment package. Not necessarily the same a s the shipment barcode.

Commentstring

General comment for shipment package.

ShippingAdvice

DeliveryMethodCodestring

Delivery method sent to ERP, configurable in Norce Commerce

DoSMSNotifyboolean

True if buyer expects SMS notifications when delivery is ready.

IsCompleteboolean

True if it is expected that the order is shipped only once, no partial deliveries.

IsFeeChargedOnceboolean

True if it is expected that the freight fee should be charged one time even if order is delivered in several dispatches.

PickupStoreobject(PickupStore)(PickupStore)

Represents pickup store for an order

ShipAdvisorOrderCodestring

Code of the order from the shipping advisor (if Norce Commerce has integration to it).

TmsReferencestring

Shipping reference from PSP or other TMS if available.

WarehouseTransaction

ItemsArray of objects(WarehouseTransactionItem)(WarehouseTransactionItem)required

List of items for the warehouse transaction.

Items[].​PartNostringrequired

Item part number.

Items[].​Qtynumberrequired

Quantity of item in transaction.

Items[].​Amountnumber

Value of item in transaction.

Items[].​LineNumbernumber

Item line number.

Items[].​RemainingAmountnumber

Remaining amount of the item.

Items[].​RemainingQtynumber

Remaining quantity of the item.

TransactionNostringrequired

External identifier for the warehouse transaction.

WarehouseCodestringrequired

External identifier of the affected warehouse.

Commentstring

General comment.

DeliveryNoteNostring

Optional delivery note number if transaction has delivery note connection.

ExternalReferencestring

Optional external reference.

LocationCodestring

External identifier of the affected location.

OrderNostring

Optional order reference if transaction has order connection.

PurchaseOrderNostring

Optional purchase order reference if transaction has purchase order connection.

ReasonCodestring

Reason for transaction (user defined).

TransactionDatestring(DateTime)

Date of the transaction.

Typestring

Type of warehouse transaction.

WarehouseTransactionItem

PartNostringrequired

Item part number.

Qtynumberrequired

Quantity of item in transaction.

Amountnumber

Value of item in transaction.

LineNumbernumber

Item line number.

RemainingAmountnumber

Remaining amount of the item.

RemainingQtynumber

Remaining quantity of the item.