Skip to content
COMMERCE CONNECT
/
Order Service
/
/
OrderResponse

Documentation Norce Commerce Connect Order Service (4.0)

The Order Service has Entities and Operations concerned with orders created in Norce Commerce.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://customer-slug.api-se.norce.tech/commerce/connect/4.0/

Schemas

Schemas

OrderRequest

Represents a new order from Norce Commerce

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:
1 = Order
3 = Subscription/Recurring order
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.

{
  "AdditionalInfo": [
    { … }
  ],
  "BillTo": {
    "Company": { … },
    "Person": { … }
  },
  "ClientOrderRef": "string",
  "CurrencyCode": "string",
  "CustomerOrderComment": "string",
  "CustomerOrderRef": "string",
  "Discounts": [
    { … }
  ],
  "DoHold": true,
  "ErpOrderNo": "string",
  "Fees": [
    { … }
  ],
  "Header": {
    "ApplicationKey": "string"
  },
  "Items": [
    { … }
  ],
  "OrderType": 0,
  "Payments": [
    { … }
  ],
  "ReferId": 0,
  "SalesContactCode": "string",
  "SalesContactDivision": "string",
  "SellTo": {
    "Company": { … },
    "Person": { … }
  },
  "ShipTo": {
    "Company": { … },
    "Person": { … }
  },
  "ShippingAdvice": {
    "DeliveryMethodCode": "string",
    "DoSMSNotify": true,
    "IsComplete": true,
    "IsFeeChargedOnce": true,
    "PickupStore": { … },
    "ShipAdvisorOrderCode": "string",
    "TmsReference": "string"
  },
  "Source": "string",
  "SubmitDate": "string"
}

OrderResponse

Represents successful order registration in receiving system.

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

{
  "HasErpOrderNo": true,
  "StatusCode": "OK",
  "Description": "string",
  "ErpOrderNo": "string"
}

Payment

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

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

PaymentNamestring

Name of the payment selected at the provider, e.g. "Card", "BankAccount", "Swish". Names are PSP dependent.

{
  "PaymentCode": 0,
  "PaymentMethodCode": "string",
  "PaymentRef": "string",
  "AdditionalInfo": [
    { … }
  ],
  "Amount": 0,
  "CurrencyCode": "string",
  "PaymentName": "string"
}

Order Notification

Operations

Order

Operations

Invoice

Operations

POS Shipment

Operations