Norce Checkout - Order Management API (1.0)

Build 2026-10-07 13:08:32

The Order Management API is used to create and handle orders

Download OpenAPI description
Languages
Servers
Playground

https://{slug}.api-se.playground.norce.tech/checkout/order/

Stage

https://{slug}.api-se.stage.norce.tech/checkout/order/

Production

https://{slug}.api-se.norce.tech/checkout/order/

Schemas

Checkout

Operations

Update Order State

Request

Update order state

Path
orderIdstringrequired

Order identifier

Headers
x-merchantstringnon-emptyrequired

Merchant identifier.

Example: norce
x-channelstringnon-emptyrequired

Channel identifier

Example: 1
x-adapteridstring

Optional adapter identifier. When provided, hooks belonging to this adapter will not be triggered for changes made by the adapter itself.

Example: qliro_checkout_adapter
Bodyapplication/jsonrequired
currentStatusstring

State of the order.

Enum"checkout""processing""accepted""completed""declined""removed"
curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v1/checkout/orders/{orderId}/state' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "currentStatus": "checkout"
  }'

Responses

OK

Response
No content

Update order cart

Request

Update order cart. Can only be used if order is in Checkout state

Path
orderIdstringrequired

Order identifier

Headers
x-merchantstringnon-emptyrequired

Merchant identifier.

Example: norce
x-channelstringnon-emptyrequired

Channel identifier

Example: 1
x-adapteridstring

Optional adapter identifier. When provided, hooks belonging to this adapter will not be triggered for changes made by the adapter itself.

Example: qliro_checkout_adapter
Bodyapplication/jsonrequired
referencestring

Cart Reference

itemsArray of objects(Item)

List of Items

discountsArray of objects(Discount)

List of Discounts

totalobject

Cart total excluding shipping fees

attributesobject

Allows you to store any custom attributes for cart.

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v1/checkout/orders/{orderId}/cart' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "reference": "string",
    "items": [
      {
        "reference": "string",
        "name": "T-Shirt XL",
        "sku": "A000123",
        "productType": "physical",
        "items": [
          {}
        ],
        "url": "https://example.com/products/A000123",
        "imageUrl": "https://example.com/products/A000123/images/1",
        "quantity": 2,
        "unit": "st",
        "price": {
          "includingVat": 1234,
          "excludingVat": 987.2
        },
        "total": {
          "includingVat": 1234,
          "excludingVat": 987.2
        },
        "originalTotal": {
          "includingVat": 1234,
          "excludingVat": 987.2
        },
        "vatRate": 0.25,
        "discounts": [
          {
            "type": "item",
            "name": "string",
            "reference": "string",
            "description": "string",
            "code": "string",
            "value": {
              "includingVat": 1234,
              "excludingVat": 987.2
            },
            "attributes": {
              "property1": null,
              "property2": null
            }
          }
        ],
        "logistics": {
          "weight": 2500,
          "height": 100,
          "width": 50,
          "length": 200,
          "tags": [
            "string"
          ],
          "shippingDate": "2026-10-05T00:00:00Z",
          "shippingDates": {
            "start": "2026-09-29T00:00:00Z",
            "end": "2026-10-05T00:00:00Z",
            "tags": [
              {
                "name": "instore_pickup",
                "start": "2026-09-24T00:00:00Z",
                "end": "2026-09-24T00:00:00Z"
              }
            ]
          },
          "delivery": {
            "group": 0
          }
        },
        "upsell": true,
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "discounts": [
      {
        "type": "item",
        "name": "string",
        "reference": "string",
        "description": "string",
        "code": "string",
        "value": {
          "includingVat": 1234,
          "excludingVat": 987.2
        },
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "total": {
      "includingVat": 1234,
      "excludingVat": 987.2
    },
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

OK

Response
No content

Update order cart with upsell items

Request

Update order cart (Upsell). Can only be used if order is in Accepted state

Path
orderIdstringrequired

Order identifier

Headers
x-merchantstringnon-emptyrequired

Merchant identifier.

Example: norce
x-channelstringnon-emptyrequired

Channel identifier

Example: 1
x-adapteridstring

Optional adapter identifier. When provided, hooks belonging to this adapter will not be triggered for changes made by the adapter itself.

Example: qliro_checkout_adapter
Bodyapplication/jsonrequired
referencestring

Cart Reference

itemsArray of objects(Item)

List of Items

discountsArray of objects(Discount)

List of Discounts

totalobject

Cart total excluding shipping fees

attributesobject

Allows you to store any custom attributes for cart.

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v1/checkout/orders/{orderId}/cart/upsell' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "reference": "string",
    "items": [
      {
        "reference": "string",
        "name": "T-Shirt XL",
        "sku": "A000123",
        "productType": "physical",
        "items": [
          {}
        ],
        "url": "https://example.com/products/A000123",
        "imageUrl": "https://example.com/products/A000123/images/1",
        "quantity": 2,
        "unit": "st",
        "price": {
          "includingVat": 1234,
          "excludingVat": 987.2
        },
        "total": {
          "includingVat": 1234,
          "excludingVat": 987.2
        },
        "originalTotal": {
          "includingVat": 1234,
          "excludingVat": 987.2
        },
        "vatRate": 0.25,
        "discounts": [
          {
            "type": "item",
            "name": "string",
            "reference": "string",
            "description": "string",
            "code": "string",
            "value": {
              "includingVat": 1234,
              "excludingVat": 987.2
            },
            "attributes": {
              "property1": null,
              "property2": null
            }
          }
        ],
        "logistics": {
          "weight": 2500,
          "height": 100,
          "width": 50,
          "length": 200,
          "tags": [
            "string"
          ],
          "shippingDate": "2026-10-05T00:00:00Z",
          "shippingDates": {
            "start": "2026-09-29T00:00:00Z",
            "end": "2026-10-05T00:00:00Z",
            "tags": [
              {
                "name": "instore_pickup",
                "start": "2026-09-24T00:00:00Z",
                "end": "2026-09-24T00:00:00Z"
              }
            ]
          },
          "delivery": {
            "group": 0
          }
        },
        "upsell": true,
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "discounts": [
      {
        "type": "item",
        "name": "string",
        "reference": "string",
        "description": "string",
        "code": "string",
        "value": {
          "includingVat": 1234,
          "excludingVat": 987.2
        },
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "total": {
      "includingVat": 1234,
      "excludingVat": 987.2
    },
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

OK

Response
No content

Checkout Payment

Operations

Checkout Shipping

Operations