Connect Order schemas

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

Address

Box	string Box information. Max length: 100
CareOf	string Care of information. Max length: 100
City	string City. Max length: 50
Country	string Country code in ISO 3166-1 alpha-2 format, e.g. SE, BY. Max length: 2
Line1	string First line of address. Max length: 100
Line2	string Second line of address. Max length: 100
Region	string Region. Max length: 50
Type	string Always null. Deprecated
ZipCode	string Zip code. Max length: 50

CancelOrderRequest

ClientOrderRef required	integer <int32> Basket/Quotation id. Used for order matching.
ErpOrderNo required	string ERP order number. Used for order matching.
	Array of objects <Payment> (Payment) If supplied, a cancel call is made for all included payments. Required property for each Payment is PaymentRef.

ClientCustomer

	object <Company> (Company) Represents a company.
	object <Person> (Person) Represents information about person related to an order.

CodeValue

Code	string Configurable identifier in Norce Commerce. This has erroneous behaviour.
Code2	string Configurable identifier in Norce Commerce.
Id	integer <int32> Norce Commerce internal id for the info type (use code instead)
Value	string The value set to the item from an integrated system to Norce Commerce.

Company

	Array of objects <CodeValue> (CodeValue) Always null, deprecated.
	Array of objects <Address> (Address) Always null, deprecated.
Code	string Company code. If exists the company is already in ERP. Max length: 50
DeliveryCodeLimit	boolean Always false, deprecated.
DeliveryCodes	Array of strings Always null, deprecated.
Email	string Always null, deprecated.
Fax	string Always null, deprecated.
IsActive	boolean Always false, deprecated.
Name	string Company name. Max length: 100
PaymentCodeLimit	boolean Always false, decprecated.
PaymentCodes	Array of strings Always null, deprecated.
Phone	string Always null, deprecated.
PriceListCodes	Array of strings Always null, deprecated.
PriceListLimit	boolean Always false, deprecated.
VatNo	string VAT number. Max length: 50

DeliveryNote

DeliveryDate required	string <DateTime> Date when order was shipped/delivered.
NoteNo required	string Delivery note identification number.
OrderNo required	string Order number that was shipped.
BuyerCompanyCode	string Customer code (if company).
BuyerCustomerCode	string Customer code
	object <Address> (Address) Represents person or company address.
DeliveryAttention	string Attention name for receiver.
DeliveryMode	string Delivery mode/method.
DeliveryName	string Name of person to receive package.
	Array of objects <DeliveryNoteItem> (DeliveryNoteItem) List of delivered items.
	Array of objects <DeliveryNotePackage> (DeliveryNotePackage) List of packages for delivery tracking.
DivisionCode	string Division code
IsPrinted	boolean Always null, deprecated
NoteText	string Additional comments for delivery.
StatusId	integer <int32> Related order status. 4 = Delivered 8 = Partly Delivered 19 = Ready for reservation.

DeliveryNoteItem

ItemNo required	string Part no of delivered item.
Qty required	number Quantity of items shipped.
RowNumber required	number Delivery note line number.
Comment	string Supplier comment.
Description	string Item description.
Id	integer Always null, deprecated.

DeliveryNotePackage

Id	integer Always null, deprecated
ParcelNumber	string Tracking number.
StatusId	integer <int32> Parcel status: 4 = Delivered 6 = Canceled 11 = Ready for pickup 12 = Pickedup 20 = Reserved

Discount

Amount	number Discount amount.
Code	string Discount code. Used for discount matching in Norce Commerce.
Type	string Discount type

Fee

Amount	number Fee amount.
Description	string Fee description.
Type	integer <int32> Fee type. 0 = Shipping 1 = Invoice
VatRate	number VAT in percent.

Header

ApplicationKey

string <Guid>

Application from where the order is created.

Invoice

ClientOrderRef required	integer <int32> Reference basket/quotation id.
CurrencyCode required	string Currency code, e.g. SEK. Max length: 3
ErpOrderNo required	string Reference ERP order number.
InvoiceDate required	string <DateTime> Invoice creation date.
InvoiceNo	string Invoice identification number. Must be unique.
AddressLine1	string First line of receiver's address.
AddressLine2	string Second line of receiver's address.
ApplicationKey	string <Guid> Application identifier.
Attention	string Receiver attention.
CareOf	string Receiver care of.
City	string Receiver's city.
Comment	string Client comment.
Country	string Receiver's country.
CountryCode	string Country code (e.g. 'SE') explicit set for invoice to be forwarded to PSP.
CreditedInvoiceNo	string Invoice number of the invoice to credit (Only mandatory for credits).
CultureCode	string Culture code (e.g. 'sv-SE') explicit set for invoice to be forwarded to PSP.
DeliveryDate	string <DateTime> Date when order was shipped.
Gln	string Global location number. Identifier for company/customer.
GroupCode	string Code used for grouping of invoices (for partial invoicing).
InvoiceDueDate	string <DateTime> Last date for invoice payments.
InvoiceRoundOff	number Total invoice round off.
IsLastInvoiceForOrder	boolean Determines if all invoices already received in case of partial payments. Null is considered as true.
	Array of objects <InvoiceItem> (InvoiceItem) List of invoiced order items. Mandatory for PSP capture.
Name	string Receiver name
	object <Payment> (Payment) Represents successful payment reservation. Either PaymentCode or PaymentRef must be provided.
PaymentMethodCode	string Code for payment method used (for receipts).
PaymentMethodName	string Name of payment method used (for receipts).
Region	string Receiver's region.
SuppressPspCall	boolean Set to true to suppress a PSP call for this invoice. Invoice will be stored as information only.
TotalAmount	number Deprecated
Vat	number VAT amount
VatRoundOff	number Deprecated
ZipCode	string Receiver's zip code.

InvoiceItem

PartNo required	string Item part no.
Quantity required	integer <int32> Quantity of invoiced items.
UnitPrice required	number Unit price
Description	string Item description. Mandatory for PSP capture.
Discount	number Deprecated
LineAmount	number Deprecated
LineNo	number Line number.
PriceList	string Item price list.
ProductName	string Product name.
SalePrice	number Deprecated
UnitVat	number Unit VAT amount. Mandatory for PSP capture.
VatRate	number VAT rate in percent. Mandatory for PSP capture.

OrderInfo

Code required	string Info code. Used for info matching.
Value	string Value to set

OrderItem

Discount required	number Discount
LineNo required	integer <int32> Norce Commerce generated row identifier. Unique within the order.
PartNo required	string Article number (Part No) in Norce Commerce.
Quantity required	integer <int32> Number of items ordered.
Quantity2 required	number Item quantity for non-integer values.
Type required	string Type of product. Enum: "Undefined" "ErpStandard" "Refurbished" "Freight" "Insurance" "GiftCertificate" "Bid" "Download" "Structure" "Invoice" "Demo" "Service" "Installation" "Accumulation" "Standard" "StandardAfterCreated" "Donation" "Brand" "EnvironmentalFee" "PackingFee"
TypeGroup required	string Product type group. Enum: "Undefined" "Physical" "Virtual" "Fee" "Service" "AddedFee"
UnitPrice required	number Sale price for one item only excluding VAT (to get the row amount you multiply with quantity).
UnitPriceOriginal required	number Sale price before discounts.
UnitVat required	number VAT amount for one item (to get the row VAT multiply with quantity).
VatRate required	number VAT in percent
	Array of objects <CodeValue> (CodeValue) Client specific information on order item.
Comment	string Row comment.
Description	string Product description (ERP name in Norce Commerce).
ErpPartNo	string Article number in ERP (usually same as PartNo, different for SKU type 13 'Accumulation').
InternalProductId	integer <int32> Internal product id in Norce Commerce.
ParentLineNo	integer <int32> Exists if the row is a child to another row, e.g. in case of service articles or items in a package/bundle.
PriceListNo	integer <int32> Price list from which the price is derived.
	Array 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.
	Array of objects <Promotion> (Promotion) List of all promotions applied to the order item.
UnitOfMeasure	string Unit of measurement, e.g. pieces, mm, g.

OrderRequest

	Array of objects <CodeValue> (CodeValue) Client specific information on the order
	object <ClientCustomer> (ClientCustomer) Represents customer, either a person or a company.
ClientOrderRef	string Usually weborder number (basket id in Norce Commerce). For orders from external source this is their number. Max length: 50
CurrencyCode	string Currency code in ISO 4217 format, e.g. "SEK", "EUR", "USD". Max length: 3
CustomerOrderComment	string Comment field
CustomerOrderRef	string Buyers reference, usually added in the checkout for B2B orders. Max length: 50
	Array of objects <Discount> (Discount) List of order discounts that are not represented on order lines. Not commonly used.
DoHold	boolean True if web solution thinks that this order should be manually validated before processed
ErpOrderNo	string Usually empty. If exists this is a suggestion from web solution which order number the order should have in ERP. Max length: 50
	Array of objects <Fee> (Fee) Collection of fees on the order. Not commonly used, the fees are mostly implemented as order items with TypeGroup "Fee".
	object <Header> (Header) Header information about order.
	Array of objects <OrderItem> (OrderItem) Collection of order rows. Other than the articles this collection can also contain fees such as freight.
OrderType	integer <int32> Order type: 1 = Order 3 = Subscription/Recurring order 5 = External order
	Array 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.
ReferId	integer <int32> If order is created from a referral like an ad
SalesContactCode	string Code of sales contact if a sales rep should be marked as seller. Max length: 50
SalesContactDivision	string Code of sales department if a sales dep should be marked as seller. Max length: 50
	object <ClientCustomer> (ClientCustomer) Represents customer, either a person or a company.
	object <ClientCustomer> (ClientCustomer) Represents customer, either a person or a company.
	object <ShippingAdvice> (ShippingAdvice) Represents order shipping information
Source	string Order source. Should be WEB for all orders created from client web sites.
SubmitDate	string <DateTime> Timestamp when order was created in Norce Commerce.

OrderResponse

HasErpOrderNo required	boolean True if ErpOrder number is provided.
StatusCode required	string Order response status. Allowed values are "OK" or "Failed". Max length: 50 Enum: "OK" "Failed"
Description	string Use this for a more information if status code is failed. Max length: 255
ErpOrderNo	string Order number from the ERP, if available. Can be sent in with SendOrderStatus as well. Max length: 50

Payment

PaymentCode required	integer <int32> Payment code. Used for payment matching.
PaymentMethodCode required	string Payment method that should be sent in to the ERP, the code is configurable in Norce Commerce.
PaymentRef required	string Transaction identifier from 3rd party, like payment service provider.
	Array of objects <CodeValue> (CodeValue) 3rd party specific information abount payment (client and PSP decides what this can contain).
Amount	number Amount paid or reserved including VAT after rounding rules.
CurrencyCode	string Currency code in ISO 4217 format, e.g. "SEK", "EUR", "USD". Max length: 3

Person

	object <Address> (Address) Represents person or company address.
CellPhone	string Mobile phone number. Max length: 50
CompanyCode	string Always null, deprecated.
CustomerCode	string Customer code. If exists the person is already in ERP. Max length: 50
Email	string Personal email. Max length: 255
FirstName	string Person name. Max length: 50
IsActive	boolean Deprecated
JobTitle	string Person job title. Max length: 10
LastName	string Person surname. Max length: 50
PrivatePhone	string Private phone number. Max length: 50
SSN	string Social security number. Max length: 50
WorkPhone	string Work phone number. Max length: 50

PickupStore

	Array of objects <CodeValue> (CodeValue) 3rd party specific information on pickup point (client and transporter decides what this can contain).
	object <Address> (Address) Represents person or company address.
Code	string Transporter code for store.
IsDropPoint	boolean Determines if store is pick up point.
Name	string Store name

PriceListItem

IsActive	boolean Sets item in price list to active or inactive.
IsStandardPriceList	boolean Determines if price list is standard.
PriceListName	string Name of price list. Max length: 50
QtyBreak	integer <int32> Threshold value for applying price list based on item quantity.
UnitPrice	number Sale price for one item only excluding VAT.

Promotion

AppliedAmount	number Amount applied to the order item from this promotion.
DiscountCode	string External code for the promotion (if configured in Norce Commerce). Max length: 50
Id	integer <int32> Norce Commerce internal id for the promotion.
Name	string Name of the promotion. Max length: 255

SendOrderStatusRequest

ClientOrderRef required	integer <int32> Quotation/basket id. Used for order matching as reference.
ErpOrderNo required	string ERP order number. Used for order matching.
OrderStatus required	string Order status. Enum: "Allocation" "Confirmed" "BackOrder" "Delivered" "Invoiced" "Cancelled" "CreditControl" "PartlyDelivered" "Acknowledged" "ErpConfirmed" "ReadyForPickup" "PickedUp" "NotPickedUp" "OnHold" "WaitingForCancel" "WaitingForOnHoldRemoved" "CancelError" "AcknowledgementError" "ReadyForReservation" "Reserved"
AccountId	integer <int32> Norce Commerce account used for order update.
	Array of objects <OrderInfo> (OrderInfo) List of additional order information fields.

Shipment

ApplicationKey required	string <uuid> Application identifier
DeliveryNoteNo required	string External identifier for the delivery note.
InvoiceNo required	string External identifier for related invoice.
ShipmentNo required	string External identifier for shipment.
SourceWarehouseCode required	string External identifier for the warehouse to ship items from.
TargetWarehouseCode required	string External identifier for the warehouse to receive the items.
Barcode	string Barcode for whole shipment (individual shipment packages may have individual barcodes)
CarrierName	string Carrier service name
CarrierReference	string Carrier service shipment reference
CarrierTrackingUrl	string <uri> Carrier service tracking url.
Comment	string User comment.
	Array of objects <ShipmentItem> (ShipmentItem) Items in the shipment
ReceiverName	string Name of receiver
SenderName	string Name of sender
	Array of objects <ShipmentPackage> (ShipmentPackage) List of shipment parts.
	object <Address> (Address) Represents person or company address.
	object <Address> (Address) Represents person or company address.

ShipmentItem

LineNo required	integer <int32> Line number
PartNo required	string The item's part number
Quantity required	integer <int32> Quantity of the item
Name	string Name of the item.
PackageNo	string External reference to which shipment package that includes this item.
Price	number Deprecated. Use PurchaseCost.
PurchaseCost	number Purchase cost of the item.
UnitCost	number Unit cost of the item.

ShipmentPackage

PackageNo required	string External identifier for the package. May be referenced on a shipment item.
Barcode	string Barcode for the shipment package. Not necessarily the same a s the shipment barcode.
Comment	string General comment for shipment package.

ShippingAdvice

DeliveryMethodCode	string Delivery method sent to ERP, configurable in Norce Commerce
DoSMSNotify	boolean True if buyer expects SMS notifications when delivery is ready.
IsComplete	boolean True if it is expected that the order is shipped only once, no partial deliveries.
IsFeeChargedOnce	boolean True if it is expected that the freight fee should be charged one time even if order is delivered in several dispatches.
	object <PickupStore> (PickupStore) Represents pickup store for an order
ShipAdvisorOrderCode	string Code of the order from the shipping advisor (if Norce Commerce has integration to it).
TmsReference	string Shipping reference from PSP or other TMS if available.

WarehouseTransaction

required	Array of objects <WarehouseTransactionItem> (WarehouseTransactionItem) List of items for the warehouse transaction.
TransactionNo required	string External identifier for the warehouse transaction.
WarehouseCode required	string External identifier of the affected warehouse.
Comment	string General comment.
DeliveryNoteNo	string Optional delivery note number if transaction has delivery note connection.
ExternalReference	string Optional external reference.
LocationCode	string External identifier of the affected location.
OrderNo	string Optional order reference if transaction has order connection.
PurchaseOrderNo	string Optional purchase order reference if transaction has purchase order connection.
ReasonCode	string Reason for transaction (user defined).
TransactionDate	string <DateTime> Date of the transaction.
Type	string Type of warehouse transaction.

WarehouseTransactionItem

PartNo required	string Item part number.
Qty required	number Quantity of item in transaction.
Amount	number Value of item in transaction.
LineNumber	number Item line number.
RemainingAmount	number Remaining amount of the item.
RemainingQty	number Remaining quantity of the item.