COMMERCE CONNECT
/
Order Service
/
Order
/
Update the status on an order.

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/

Order Notification

Operations

Order

Operations

Cancel an order

Request

Cancel an order, and, if applicable, payment. Changes the order status to cancelled.

Body
required

Order cancellation request.

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.

curl -i -X POST \
  https://customer-slug.api-se.norce.tech/commerce/connect/4.0/Order/CancelOrder \
  -H 'Content-Type: application/json' \
  -d '{
    "ClientOrderRef": 0,
    "ErpOrderNo": "string",
    "Payments": [
      {
        "PaymentCode": 0,
        "PaymentMethodCode": "string",
        "PaymentRef": "string",
        "AdditionalInfo": [
          {
            "Code": "string",
            "Code2": "string",
            "Id": 0,
            "Value": "string"
          }
        ],
        "Amount": 0,
        "CurrencyCode": "string"
      }
    ]
  }'

Responses

Success

Body

Import a delivery note.

Request

Created a delivery note from another system in Norce.
Read more about the method here.

Body
required

Delivery note to import.

DeliveryDatestring(DateTime)required

Date when order was shipped/delivered.

NoteNostringrequired

Delivery note identification number.

OrderNostringrequired

Order number that was shipped.

BuyerCompanyCodestring

Customer code (if company).

BuyerCustomerCodestring

Customer code

DeliveryAddressobject(Address)(Address)

Represents person or company address.

DeliveryAttentionstring

Attention name for receiver.

DeliveryModestring

Delivery mode/method.

DeliveryNamestring

Name of person to receive package.

DeliverynoteItemsArray of objects(DeliveryNoteItem)(DeliveryNoteItem)

List of delivered items.

DeliveryNotePackagesArray of objects(DeliveryNotePackage)(DeliveryNotePackage)

List of packages for delivery tracking.

DivisionCodestring

Division code

IsPrintedboolean

Always null, deprecated

NoteTextstring

Additional comments for delivery.

StatusIdinteger(int32)

Related order status.
4 = Delivered
8 = Partly Delivered
19 = Ready for reservation.

curl -i -X POST \
  https://customer-slug.api-se.norce.tech/commerce/connect/4.0/Order/CreateDeliveryNote \
  -H 'Content-Type: application/json' \
  -d '{
    "DeliveryDate": "string",
    "NoteNo": "string",
    "OrderNo": "string",
    "BuyerCompanyCode": "string",
    "BuyerCustomerCode": "string",
    "DeliveryAddress": {
      "Box": "string",
      "CareOf": "string",
      "City": "string",
      "Country": "string",
      "Line1": "string",
      "Line2": "string",
      "Region": "string",
      "Type": "string",
      "ZipCode": "string"
    },
    "DeliveryAttention": "string",
    "DeliveryMode": "string",
    "DeliveryName": "string",
    "DeliverynoteItems": [
      {
        "ItemNo": "string",
        "Qty": 0,
        "RowNumber": 0,
        "Comment": "string",
        "Description": "string",
        "Id": 0
      }
    ],
    "DeliveryNotePackages": [
      {
        "Id": 0,
        "ParcelNumber": "string",
        "StatusId": 0
      }
    ],
    "DivisionCode": "string",
    "IsPrinted": true,
    "NoteText": "string",
    "StatusId": 0
  }'

Responses

Success

Body

Update the status on an order.

Request

Updates the status on an order.
Read more about the method here.

Body
required

Order status request.

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.

curl -i -X POST \
  https://customer-slug.api-se.norce.tech/commerce/connect/4.0/Order/SendOrderStatus \
  -H 'Content-Type: application/json' \
  -d '{
    "ClientOrderRef": 0,
    "ErpOrderNo": "string",
    "OrderStatus": "Allocation",
    "AccountId": 0,
    "Infos": [
      {
        "Code": "string",
        "Value": "string"
      }
    ]
  }'

Responses

Success

Body

Invoice

Operations

POS Shipment

Operations