{"info":{"version":"4.0","title":"Documentation Norce Commerce Connect Order Service","description":"The Order Service has Entities and Operations concerned with orders created in Norce Commerce."},"paths":{"/webhooks":{"post":{"summary":"Create Order","tags":["Order Notification"],"description":"A post of the Order Request for the ERP or OMS,
Read more about the how to implement a receiver here","responses":{"200":{"description":"Order received successfully - No retries","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponse"}}}},"400":{"description":"Bad Request - Trigger retries"},"401":{"description":"Unauthorized - Trigger retries"},"408":{"description":"Request Timeout - Trigger retries"},"503":{"description":"Service Unavailable - Trigger retries"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRequest"}}},"required":true}}},"/Order/CancelOrder":{"post":{"tags":["Order"],"summary":"Cancel an order","description":"Cancel an order, and, if applicable, payment. Changes the order status to cancelled.","operationId":"CancelOrder","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelOrderRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CancelOrderRequest"}}},"required":true,"description":"Order cancellation request."}}},"/Order/CreateDeliveryNote":{"post":{"tags":["Order"],"summary":"Import a delivery note.","description":"Created a delivery note from another system in Norce.
Read more about the method here.","operationId":"CreateDeliveryNote","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryNote"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DeliveryNote"}}},"required":true,"description":"Delivery note to import."}}},"/Order/CreateInvoice":{"post":{"tags":["Invoice"],"summary":"Import an invoice.","description":"Creates an invoice from another system. Will capture/activate payment if applicable.
Read more about the method here.","operationId":"CreateInvoice","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Invoice"}}},"required":true,"description":"Invoice"}}},"/Order/CreditPayment":{"post":{"tags":["Invoice"],"summary":"Credit an Order","description":"Create a credit request that is sent to a payment service, if applicable. Must be related to an order, but can be a partly credit.
Read more about the method here.","operationId":"CreditPayment","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Invoice"}}},"required":true,"description":"Invoice to be credited."}}},"/Order/SendOrderStatus":{"post":{"tags":["Order"],"summary":"Update the status on an order.","description":"Updates the status on an order.
Read more about the method here.","operationId":"SendOrderStatus","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendOrderStatusRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SendOrderStatusRequest"}}},"required":true,"description":"Order status request."}}},"/Order/SendPosShipment":{"post":{"tags":["POS Shipment"],"summary":"Create a shipment request","description":"Sends shipment request to POS adapter. Must have a POS integration through Norce.","operationId":"SendPosShipment","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shipment"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Shipment"}}},"required":true,"description":"Shipment to send."}}}},"openapi":"3.0.4","servers":[{"url":"https://customer-slug.api-se.norce.tech/commerce/connect/4.0"}],"components":{"schemas":{"Address":{"description":"Represents person or company address.","properties":{"Box":{"description":"Box information. Max length: 100","type":"string"},"CareOf":{"description":"Care of information. Max length: 100","type":"string"},"City":{"description":"City. Max length: 50","type":"string"},"Country":{"description":"Country code in ISO 3166-1 alpha-2 format, e.g. SE, BY. Max length: 2","type":"string"},"Line1":{"description":"First line of address. Max length: 100","type":"string"},"Line2":{"description":"Second line of address. Max length: 100","type":"string"},"Region":{"description":"Region. Max length: 50","type":"string"},"Type":{"description":"Always null. Deprecated","type":"string"},"ZipCode":{"description":"Zip code. Max length: 50","type":"string"}},"type":"object","format":"Address"},"CancelOrderRequest":{"description":"Request for order cancellation. Either ClientOrderRef or ErpOrderNo must be provided.","properties":{"ClientOrderRef":{"description":"Basket/Quotation id. Used for order matching.","type":"integer","format":"int32"},"ErpOrderNo":{"description":"ERP order number. Used for order matching.","type":"string"},"Payments":{"description":"If supplied, a cancel call is made for all included payments. Required property for each Payment is PaymentRef.","type":"array","items":{"$ref":"#/components/schemas/Payment"}}},"type":"object","format":"CancelOrderRequest","required":["ClientOrderRef","ErpOrderNo"]},"ClientCustomer":{"description":"Represents customer, either a person or a company.","properties":{"Company":{"description":"If exists the buyer is a company, otherwise a Person.","$ref":"#/components/schemas/Company"},"Person":{"description":"Required, Norce Commerce only allows people to create orders. They can buy for a company, but the basket is always related to a person.","$ref":"#/components/schemas/Person"}},"type":"object","format":"ClientCustomer"},"CodeValue":{"description":"Represents a configurable information item that is stored in Norce Commerce but maintained by other integrated systems via the APIs. Preferable to use Code2 over Code.","properties":{"Code":{"description":"Configurable identifier in Norce Commerce. This has erroneous behaviour.","type":"string"},"Code2":{"description":"Configurable identifier in Norce Commerce.","type":"string"},"Id":{"description":"Norce Commerce internal id for the info type (use code instead)","type":"integer","format":"int32"},"Value":{"description":"The value set to the item from an integrated system to Norce Commerce.","type":"string"}},"type":"object","format":"CodeValue"},"Company":{"description":"Represents a company.","properties":{"AdditionalInfo":{"description":"Always null, deprecated.","type":"array","items":{"$ref":"#/components/schemas/CodeValue"}},"Addresses":{"description":"Always null, deprecated.","type":"array","items":{"$ref":"#/components/schemas/Address"}},"Code":{"description":"Company code. If exists the company is already in ERP. Max length: 50","type":"string"},"DeliveryCodeLimit":{"description":"Always false, deprecated.","type":"boolean"},"DeliveryCodes":{"description":"Always null, deprecated.","type":"array","items":{"type":"string"}},"Email":{"description":"Always null, deprecated.","type":"string"},"Fax":{"description":"Always null, deprecated.","type":"string"},"Id":{"description":"Norce internal company id. Use it to match the company when updating it through Norce Connect. Null when the order has no company id.","type":"integer","format":"int32","nullable":true},"IsActive":{"description":"Always false, deprecated.","type":"boolean"},"Name":{"description":"Company name. Max length: 100","type":"string"},"PaymentCodeLimit":{"description":"Always false, decprecated.","type":"boolean"},"PaymentCodes":{"description":"Always null, deprecated.","type":"array","items":{"type":"string"}},"Phone":{"description":"Always null, deprecated.","type":"string"},"PriceListCodes":{"description":"Always null, deprecated.","type":"array","items":{"type":"string"}},"PriceListLimit":{"description":"Always false, deprecated.","type":"boolean"},"VatNo":{"description":"VAT number. Max length: 50","type":"string"}},"type":"object","format":"Company"},"DeliveryNote":{"description":"Notification information about shipped order.","properties":{"DeliveryDate":{"description":"Date when order was shipped/delivered.","type":"string","format":"DateTime"},"NoteNo":{"description":"Delivery note identification number.","type":"string"},"OrderNo":{"description":"Order number that was shipped.","type":"string"},"BuyerCompanyCode":{"description":"Customer code (if company).","type":"string"},"BuyerCustomerCode":{"description":"Customer code","type":"string"},"DeliveryAddress":{"description":"Address where order shall be delivered.","$ref":"#/components/schemas/Address"},"DeliveryAttention":{"description":"Attention name for receiver.","type":"string"},"DeliveryMode":{"description":"Delivery mode/method.","type":"string"},"DeliveryName":{"description":"Name of person to receive package.","type":"string"},"DeliverynoteItems":{"description":"List of delivered items.","type":"array","items":{"$ref":"#/components/schemas/DeliveryNoteItem"}},"DeliveryNotePackages":{"description":"List of packages for delivery tracking.","type":"array","items":{"$ref":"#/components/schemas/DeliveryNotePackage"}},"DivisionCode":{"description":"Division code","type":"string"},"IsPrinted":{"description":"Always null, deprecated","type":"boolean"},"NoteText":{"description":"Additional comments for delivery.","type":"string"},"StatusId":{"description":"Related order status.
4 = Delivered
8 = Partly Delivered
19 = Ready for reservation.","type":"integer","format":"int32"}},"type":"object","format":"DeliveryNote","required":["DeliveryDate","NoteNo","OrderNo"]},"DeliveryNoteItem":{"description":"Information about delivered item.","properties":{"ItemNo":{"description":"Part no of delivered item.","type":"string"},"Qty":{"description":"Quantity of items shipped.","type":"number"},"RowNumber":{"description":"Delivery note line number.","type":"number"},"Comment":{"description":"Supplier comment.","type":"string"},"Description":{"description":"Item description.","type":"string"},"Id":{"description":"Always null, deprecated.","type":"integer"}},"type":"object","format":"DeliveryNoteItem","required":["ItemNo","Qty","RowNumber"]},"DeliveryNotePackage":{"description":"Package information for tracking.","properties":{"Id":{"description":"Always null, deprecated","type":"integer"},"ParcelNumber":{"description":"Tracking number.","type":"string"},"StatusId":{"description":"Parcel status:
4 = Delivered
6 = Canceled
11 = Ready for pickup
12 = Pickedup
20 = Reserved","type":"integer","format":"int32"}},"type":"object","format":"DeliveryNotePackage"},"Discount":{"description":"Order discount","properties":{"Amount":{"description":"Discount amount.","type":"number"},"Code":{"description":"Discount code. Used for discount matching in Norce Commerce.","type":"string"},"Type":{"description":"Discount type","type":"string"}},"type":"object","format":"Discount"},"Fee":{"description":"Represents a fee on an order","properties":{"Amount":{"description":"Fee amount.","type":"number"},"Description":{"description":"Fee description.","type":"string"},"Type":{"description":"Fee type.
0 = Shipping
1 = Invoice","type":"integer","format":"int32"},"VatRate":{"description":"VAT in percent.","type":"number"}},"type":"object","format":"Fee"},"Header":{"description":"Header information about order.","properties":{"ApplicationKey":{"description":"Application from where the order is created.","type":"string","format":"Guid"}},"type":"object","format":"Header"},"Invoice":{"description":"Invoice information. Either InvoiceNo or ClientOrderRef must be provided.","properties":{"ClientOrderRef":{"description":"Reference basket/quotation id.","type":"integer","format":"int32"},"CurrencyCode":{"description":"Currency code, e.g. SEK. Max length: 3","type":"string"},"ErpOrderNo":{"description":"Reference ERP order number.","type":"string"},"InvoiceDate":{"description":"Invoice creation date.","type":"string","format":"DateTime"},"InvoiceNo":{"description":"Invoice identification number. Must be unique.","type":"string"},"AddressLine1":{"description":"First line of receiver's address.","type":"string"},"AddressLine2":{"description":"Second line of receiver's address.","type":"string"},"ApplicationKey":{"description":"Application identifier.","type":"string","format":"Guid"},"Attention":{"description":"Receiver attention.","type":"string"},"CareOf":{"description":"Receiver care of.","type":"string"},"City":{"description":"Receiver's city.","type":"string"},"Comment":{"description":"Client comment.","type":"string"},"Country":{"description":"Receiver's country.","type":"string"},"CountryCode":{"description":"Country code (e.g. 'SE') explicit set for invoice to be forwarded to PSP.","type":"string"},"CreditedInvoiceNo":{"description":"Invoice number of the invoice to credit (Only mandatory for credits).","type":"string"},"CultureCode":{"description":"Culture code (e.g. 'sv-SE') explicit set for invoice to be forwarded to PSP.","type":"string"},"DeliveryDate":{"description":"Date when order was shipped.","type":"string","format":"DateTime"},"Gln":{"description":"Global location number. Identifier for company/customer.","type":"string"},"GroupCode":{"description":"Code used for grouping of invoices (for partial invoicing).","type":"string"},"InvoiceDueDate":{"description":"Last date for invoice payments.","type":"string","format":"DateTime"},"InvoiceRoundOff":{"description":"Total invoice round off.","type":"number"},"IsLastInvoiceForOrder":{"description":"Determines if all invoices already received in case of partial payments. Null is considered as true.","type":"boolean"},"Items":{"description":"List of invoiced order items. Mandatory for PSP capture.","type":"array","items":{"$ref":"#/components/schemas/InvoiceItem"}},"Name":{"description":"Receiver name","type":"string"},"Payment":{"description":"Payment details associated to invoice. Mandatory for PSP capture.","$ref":"#/components/schemas/Payment"},"PaymentMethodCode":{"description":"Code for payment method used (for receipts).","type":"string"},"PaymentMethodName":{"description":"Name of payment method used (for receipts).","type":"string"},"Region":{"description":"Receiver's region.","type":"string"},"SuppressPspCall":{"description":"Set to true to suppress a PSP call for this invoice. Invoice will be stored as information only.","type":"boolean"},"TotalAmount":{"description":"Deprecated","type":"number"},"Vat":{"description":"VAT amount","type":"number"},"VatRoundOff":{"description":"Deprecated","type":"number"},"ZipCode":{"description":"Receiver's zip code.","type":"string"}},"type":"object","format":"Invoice","required":["ClientOrderRef","CurrencyCode","ErpOrderNo","InvoiceDate","InoviceNo"]},"InvoiceItem":{"description":"Order item to be invoiced.","properties":{"PartNo":{"description":"Item part no.","type":"string"},"Quantity":{"description":"Quantity of invoiced items.","type":"integer","format":"int32"},"UnitPrice":{"description":"Unit price","type":"number"},"Description":{"description":"Item description. Mandatory for PSP capture.","type":"string"},"Discount":{"description":"Deprecated","type":"number"},"LineAmount":{"description":"Deprecated","type":"number"},"LineNo":{"description":"Line number.","type":"number"},"PriceList":{"description":"Item price list.","type":"string"},"ProductName":{"description":"Product name.","type":"string"},"SalePrice":{"description":"Deprecated","type":"number"},"UnitVat":{"description":"Unit VAT amount. Mandatory for PSP capture.","type":"number"},"VatRate":{"description":"VAT rate in percent. Mandatory for PSP capture.","type":"number"}},"type":"object","format":"InvoiceItem","required":["PartNo","Quantity","UnitPrice"]},"OrderInfo":{"description":"Additional client-defined order information","properties":{"Code":{"description":"Info code. Used for info matching.","type":"string"},"Value":{"description":"Value to set","type":"string"}},"type":"object","format":"OrderInfo","required":["Code"]},"OrderItem":{"description":"Represents order row","properties":{"Discount":{"description":"Discount","type":"number"},"LineNo":{"description":"Norce Commerce generated row identifier. Unique within the order.","type":"integer","format":"int32"},"PartNo":{"description":"Article number (Part No) in Norce Commerce.","type":"string"},"Quantity":{"description":"Number of items ordered.","type":"integer","format":"int32"},"Quantity2":{"description":"Item quantity for non-integer values.","type":"number"},"Type":{"description":"Type of product.","type":"string","enum":["Undefined","ErpStandard","Refurbished","Freight","Insurance","GiftCertificate","Bid","Download","Structure","Invoice","Demo","Service","Installation","Accumulation","Standard","StandardAfterCreated","Donation","Brand","EnvironmentalFee","PackingFee"]},"TypeGroup":{"description":"Product type group.","type":"string","enum":["Undefined","Physical","Virtual","Fee","Service","AddedFee"]},"UnitPrice":{"description":"Sale price for one item only excluding VAT (to get the row amount you multiply with quantity).","type":"number"},"UnitPriceOriginal":{"description":"Sale price before discounts.","type":"number"},"UnitVat":{"description":"VAT amount for one item (to get the row VAT multiply with quantity).","type":"number"},"VatRate":{"description":"VAT in percent","type":"number"},"AdditionalInfo":{"description":"Client specific information on order item.","type":"array","items":{"$ref":"#/components/schemas/CodeValue"}},"Comment":{"description":"Row comment.","type":"string"},"Description":{"description":"Product description (ERP name in Norce Commerce).","type":"string"},"ErpPartNo":{"description":"Article number in ERP (usually same as PartNo, different for SKU type 13 'Accumulation').","type":"string"},"InternalProductId":{"description":"Internal product id in Norce Commerce.","type":"integer","format":"int32"},"ParentLineNo":{"description":"Exists if the row is a child to another row, e.g. in case of service articles or items in a package/bundle.","type":"integer","format":"int32"},"PriceListNo":{"description":"Price list from which the price is derived.","type":"integer","format":"int32"},"PriceLists":{"description":"All price lists that the unit price original is based on. This is a list of all pricelists in the hierarchy.","type":"array","items":{"$ref":"#/components/schemas/PriceListItem"}},"Promotions":{"description":"List of all promotions applied to the order item.","type":"array","items":{"$ref":"#/components/schemas/Promotion"}},"UnitOfMeasure":{"description":"Unit of measurement, e.g. pieces, mm, g.","type":"string"}},"type":"object","format":"OrderItem","required":["Discount","LineNo","PartNo","Quantity","Quantity2","Type","TypeGroup","UnitPrice","UnitPriceOriginal","UnitVat","VatRate"]},"OrderRequest":{"description":"Represents a new order from Norce Commerce","properties":{"AdditionalInfo":{"description":"Client specific information on the order","type":"array","items":{"$ref":"#/components/schemas/CodeValue"}},"BillTo":{"description":"Information on payer","$ref":"#/components/schemas/ClientCustomer"},"ClientOrderRef":{"description":"Usually weborder number (basket id in Norce Commerce). For orders from external source this is their number. Max length: 50","type":"string"},"CurrencyCode":{"description":"Currency code in ISO 4217 format, e.g. \"SEK\", \"EUR\", \"USD\". Max length: 3","type":"string"},"CustomerOrderComment":{"description":"Comment field","type":"string"},"CustomerOrderRef":{"description":"Buyers reference, usually added in the checkout for B2B orders. Max length: 50","type":"string"},"Discounts":{"description":"List of order discounts that are not represented on order lines. Not commonly used.","type":"array","items":{"$ref":"#/components/schemas/Discount"}},"DoHold":{"description":"True if web solution thinks that this order should be manually validated before processed","type":"boolean"},"ErpOrderNo":{"description":"Usually empty. If exists this is a suggestion from web solution which order number the order should have in ERP. Max length: 50","type":"string"},"Fees":{"description":"Collection of fees on the order. Not commonly used, the fees are mostly implemented as order items with TypeGroup \"Fee\".","type":"array","items":{"$ref":"#/components/schemas/Fee"}},"Header":{"description":"Control information on the order request message","$ref":"#/components/schemas/Header"},"Items":{"description":"Collection of order rows. Other than the articles this collection can also contain fees such as freight.","type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"OrderType":{"description":"Order type:
1 = Order
3 = Subscription/Recurring order
5 = External order","type":"integer","format":"int32"},"Payments":{"description":"An order can have several payments. Usually this is only one, but sometime there are an additional payment method like giftcard or a voucher.","type":"array","items":{"$ref":"#/components/schemas/Payment"}},"ReferId":{"description":"If order is created from a referral like an ad","type":"integer","format":"int32"},"SalesContactCode":{"description":"Code of sales contact if a sales rep should be marked as seller. Max length: 50","type":"string"},"SalesContactDivision":{"description":"Code of sales department if a sales dep should be marked as seller. Max length: 50","type":"string"},"SellTo":{"description":"Information on the buyer.","$ref":"#/components/schemas/ClientCustomer"},"ShipTo":{"description":"Information on where and to whom the order will be delivered.","$ref":"#/components/schemas/ClientCustomer"},"ShippingAdvice":{"description":"Order shipping information.","$ref":"#/components/schemas/ShippingAdvice"},"Source":{"description":"Order source. Should be WEB for all orders created from client web sites.","type":"string"},"SubmitDate":{"description":"Timestamp when order was created in Norce Commerce.","type":"string","format":"DateTime"}},"type":"object","format":"OrderRequest"},"OrderResponse":{"description":"Represents successful order registration in receiving system.","properties":{"HasErpOrderNo":{"description":"True if ErpOrder number is provided.","type":"boolean"},"StatusCode":{"description":"Order response status. Allowed values are \"OK\" or \"Failed\". Max length: 50","type":"string","enum":["OK","Failed"]},"Description":{"description":"Use this for a more information if status code is failed. Max length: 255","type":"string"},"ErpOrderNo":{"description":"Order number from the ERP, if available. Can be sent in with SendOrderStatus as well. Max length: 50","type":"string"}},"type":"object","format":"OrderResponse","required":["HasErpOrderNo","StatusCode"]},"Payment":{"description":"Represents successful payment reservation. Either PaymentCode or PaymentRef must be provided.","properties":{"PaymentCode":{"description":"Payment code. Used for payment matching.","type":"integer","format":"int32"},"PaymentMethodCode":{"description":"Payment method that should be sent in to the ERP, the code is configurable in Norce Commerce.","type":"string"},"PaymentRef":{"description":"Transaction identifier from 3rd party, like payment service provider.","type":"string"},"AdditionalInfo":{"description":"3rd party specific information abount payment (client and PSP decides what this can contain).","type":"array","items":{"$ref":"#/components/schemas/CodeValue"}},"Amount":{"description":"Amount paid or reserved including VAT after rounding rules.","type":"number"},"CurrencyCode":{"description":"Currency code in ISO 4217 format, e.g. \"SEK\", \"EUR\", \"USD\". Max length: 3","type":"string"},"PaymentName":{"description":"Name of the payment selected at the provider, e.g. \"Card\", \"BankAccount\", \"Swish\". Names are PSP dependent.","type":"string"}},"type":"object","format":"Payment","required":["PaymentCode","PaymentMethodCode","PaymentRef"]},"Person":{"description":"Represents information about person related to an order.","properties":{"Address":{"description":"Address on the order.","$ref":"#/components/schemas/Address"},"CellPhone":{"description":"Mobile phone number. Max length: 50","type":"string"},"CompanyCode":{"description":"Always null, deprecated.","type":"string"},"CustomerCode":{"description":"Customer code. If exists the person is already in ERP. Max length: 50","type":"string"},"Email":{"description":"Personal email. Max length: 255","type":"string"},"FirstName":{"description":"Person name. Max length: 50","type":"string"},"IsActive":{"description":"Deprecated","type":"boolean"},"JobTitle":{"description":"Person job title. Max length: 10","type":"string"},"LastName":{"description":"Person surname. Max length: 50","type":"string"},"PrivatePhone":{"description":"Private phone number. Max length: 50","type":"string"},"SSN":{"description":"Social security number. Max length: 50","type":"string"},"WorkPhone":{"description":"Work phone number. Max length: 50","type":"string"}},"type":"object","format":"Person"},"PickupStore":{"description":"Represents pickup store for an order","properties":{"AdditionalInfo":{"description":"3rd party specific information on pickup point (client and transporter decides what this can contain).","type":"array","items":{"$ref":"#/components/schemas/CodeValue"}},"Address":{"description":"Store address information.","$ref":"#/components/schemas/Address"},"Code":{"description":"Transporter code for store.","type":"string"},"IsDropPoint":{"description":"Determines if store is pick up point.","type":"boolean"},"Name":{"description":"Store name","type":"string"}},"type":"object","format":"PickupStore"},"PriceListItem":{"description":"Price list applied to order item.","properties":{"IsActive":{"description":"Sets item in price list to active or inactive.","type":"boolean"},"IsStandardPriceList":{"description":"Determines if price list is standard.","type":"boolean"},"PriceListName":{"description":"Name of price list. Max length: 50","type":"string"},"QtyBreak":{"description":"Threshold value for applying price list based on item quantity.","type":"integer","format":"int32"},"UnitPrice":{"description":"Sale price for one item only excluding VAT.","type":"number"}},"type":"object","format":"PriceListItem"},"Promotion":{"description":"Represents a promotional discount on an order row.","properties":{"AppliedAmount":{"description":"Amount applied to the order item from this promotion.","type":"number"},"DiscountCode":{"description":"External code for the promotion (if configured in Norce Commerce). Max length: 50","type":"string"},"Id":{"description":"Norce Commerce internal id for the promotion.","type":"string"},"Name":{"description":"Name of the promotion. Max length: 255","type":"string"}},"type":"object","format":"Promotion"},"SendOrderStatusRequest":{"description":"Order update request. Either ClientOrderRef or ErpOrderNo must be provided.","properties":{"ClientOrderRef":{"description":"Quotation/basket id. Used for order matching as reference.","type":"integer","format":"int32"},"ErpOrderNo":{"description":"ERP order number. Used for order matching.","type":"string"},"OrderStatus":{"description":"Order status.","type":"string","enum":["Allocation","Confirmed","BackOrder","Delivered","Invoiced","Cancelled","CreditControl","PartlyDelivered","Acknowledged","ErpConfirmed","ReadyForPickup","PickedUp","NotPickedUp","OnHold","WaitingForCancel","WaitingForOnHoldRemoved","CancelError","AcknowledgementError","ReadyForReservation","Reserved"]},"AccountId":{"description":"Norce Commerce account used for order update.","type":"integer","format":"int32"},"Infos":{"description":"List of additional order information fields.","type":"array","items":{"$ref":"#/components/schemas/OrderInfo"}}},"type":"object","format":"SendOrderStatusRequest","required":["ClientOrderRef","ErpOrderNo","OrderStatus"]},"Shipment":{"description":"Information about shipment to POS system. Either DeliveryNoteNo or InvoiceNo and Items must be provided.","properties":{"ApplicationKey":{"description":"Application identifier","type":"string","format":"uuid"},"DeliveryNoteNo":{"description":"External identifier for the delivery note.","type":"string"},"InvoiceNo":{"description":"External identifier for related invoice.","type":"string"},"ShipmentNo":{"description":"External identifier for shipment.","type":"string"},"SourceWarehouseCode":{"description":"External identifier for the warehouse to ship items from.","type":"string"},"TargetWarehouseCode":{"description":"External identifier for the warehouse to receive the items.","type":"string"},"Barcode":{"description":"Barcode for whole shipment (individual shipment packages may have individual barcodes)","type":"string"},"CarrierName":{"description":"Carrier service name","type":"string"},"CarrierReference":{"description":"Carrier service shipment reference","type":"string"},"CarrierTrackingUrl":{"description":"Carrier service tracking url.","type":"string","format":"uri"},"Comment":{"description":"User comment.","type":"string"},"Items":{"description":"Items in the shipment","type":"array","items":{"$ref":"#/components/schemas/ShipmentItem"}},"ReceiverName":{"description":"Name of receiver","type":"string"},"SenderName":{"description":"Name of sender","type":"string"},"ShipmentPackages":{"description":"List of shipment parts.","type":"array","items":{"$ref":"#/components/schemas/ShipmentPackage"}},"ShipmentWarehouse":{"description":"Warehouse address to ship items from.","$ref":"#/components/schemas/Address"},"TargetWarehouseAddress":{"description":"Warehouse address to ship items to.","$ref":"#/components/schemas/Address"}},"type":"object","format":"Shipment","required":["ApplicationKey","DeliveryNoteNo","InvoiceNo","ShipmentNo","SourceWarehouseCode","TargetWarehouseCode"]},"ShipmentItem":{"description":"Items in a POS shipment","properties":{"LineNo":{"description":"Line number","type":"integer","format":"int32"},"PartNo":{"description":"The item's part number","type":"string"},"Quantity":{"description":"Quantity of the item","type":"integer","format":"int32"},"Name":{"description":"Name of the item.","type":"string"},"PackageNo":{"description":"External reference to which shipment package that includes this item.","type":"string"},"Price":{"description":"Deprecated. Use PurchaseCost.","type":"number"},"PurchaseCost":{"description":"Purchase cost of the item.","type":"number"},"UnitCost":{"description":"Unit cost of the item.","type":"number"}},"type":"object","format":"ShipmentItem","required":["LineNo","PartNo","Quantity"]},"ShipmentPackage":{"description":"Package in a POS shipment.","properties":{"PackageNo":{"description":"External identifier for the package. May be referenced on a shipment item.","type":"string"},"Barcode":{"description":"Barcode for the shipment package. Not necessarily the same a s the shipment barcode.","type":"string"},"Comment":{"description":"General comment for shipment package.","type":"string"}},"type":"object","format":"ShipmentPackage","required":["PackageNo"]},"ShippingAdvice":{"description":"Represents order shipping information","properties":{"DeliveryMethodCode":{"description":"Delivery method sent to ERP, configurable in Norce Commerce","type":"string"},"DoSMSNotify":{"description":"True if buyer expects SMS notifications when delivery is ready.","type":"boolean"},"IsComplete":{"description":"True if it is expected that the order is shipped only once, no partial deliveries.","type":"boolean"},"IsFeeChargedOnce":{"description":"True if it is expected that the freight fee should be charged one time even if order is delivered in several dispatches.","type":"boolean"},"PickupStore":{"description":"Represents a pickup point, if not exists for a pickup delivery method the transporter decides nearest pickup point from the delivery address.","$ref":"#/components/schemas/PickupStore"},"ShipAdvisorOrderCode":{"description":"Code of the order from the shipping advisor (if Norce Commerce has integration to it).","type":"string"},"TmsReference":{"description":"Shipping reference from PSP or other TMS if available.","type":"string"}},"type":"object","format":"ShippingAdvice"},"WarehouseTransaction":{"description":"Record of transaction of items. No actions are taken in Norce Commerce from this document. Information only.","properties":{"Items":{"description":"List of items for the warehouse transaction.","type":"array","items":{"$ref":"#/components/schemas/WarehouseTransactionItem"}},"TransactionNo":{"description":"External identifier for the warehouse transaction.","type":"string"},"WarehouseCode":{"description":"External identifier of the affected warehouse.","type":"string"},"Comment":{"description":"General comment.","type":"string"},"DeliveryNoteNo":{"description":"Optional delivery note number if transaction has delivery note connection.","type":"string"},"ExternalReference":{"description":"Optional external reference.","type":"string"},"LocationCode":{"description":"External identifier of the affected location.","type":"string"},"OrderNo":{"description":"Optional order reference if transaction has order connection.","type":"string"},"PurchaseOrderNo":{"description":"Optional purchase order reference if transaction has purchase order connection.","type":"string"},"ReasonCode":{"description":"Reason for transaction (user defined).","type":"string"},"TransactionDate":{"description":"Date of the transaction.","type":"string","format":"DateTime"},"Type":{"description":"Type of warehouse transaction.","type":"string"}},"type":"object","format":"WarehouseTransaction","required":["Items","TransactionNo","WarehouseCode"]},"WarehouseTransactionItem":{"description":"Items in a warehouse transaction.","properties":{"PartNo":{"description":"Item part number.","type":"string"},"Qty":{"description":"Quantity of item in transaction.","type":"number"},"Amount":{"description":"Value of item in transaction.","type":"number"},"LineNumber":{"description":"Item line number.","type":"number"},"RemainingAmount":{"description":"Remaining amount of the item.","type":"number"},"RemainingQty":{"description":"Remaining quantity of the item.","type":"number"}},"type":"object","format":"WarehouseTransactionItem","required":["PartNo","Qty"]}}}}