Norce Checkout - Order Management API (0.1)

Build 2026-01-12 08:21:29

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
order_idstringrequired

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/v0/checkout/orders/{order_id}/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

Path
order_idstringrequired

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/v0/checkout/orders/{order_id}/cart' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "reference": "string",
    "items": [
      {
        "id": "ci_FpEzyBvBBUyKxkeNriFUxZOCje",
        "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": "2019-08-24T14:15:22Z"
        },
        "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 Customer Billing Address

Request

Update customer billing address

Path
order_idstringrequired

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

Billing address

typestring

The type of customer

Enum"person""organization"
Example: "Person"
givenNamestring

Given name or first name.

Example: "Rosalinainho"
familyNamestring

Family name or last name.

Example: "Undulatsson"
careOfstring

Care of.

Example: "Olleinho Jyckesson"
referencestring

Reference to the customer

organizationNamestring

Name of the Organization

Example: "Storm"
streetAddressstring

Address or street name, first line.

Example: "Adaptivevägen 18"
streetAddress2string

Address or street name, second line.

Example: "Lgh 1203"
postalCodestring

Postal code, zip or post code.

Example: "955 60"
citystring

City.

Example: "Boden"
regionstring

State or region.

Example: "Norrbotten"
countrystring^[A-Za-z]{2,2}$

Country. ISO 3166 alpha-2.

Example: "SE"
phonestring

Phone number.

Example: "0753892233"
emailstring

E-mail address.

Example: "rosalinainho.undulatsson@example.com"
nationalIdentificationNumberstring

Number used to identify individuals. E.g. could be used for Personal identity number (personnummer) in Sweden.

Example: "890201-3286"
organizationIdentificationNumberstring

Number used to identify organizations or legal persons. E.g. could be used for Corporate identity number. (organisationsnummer in Sweden)

Example: "212000-1355"
attributesobject

Allows you to store any custom attributes for the address.

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders/{order_id}/customer/billing' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "type": "Person",
    "givenName": "Rosalinainho",
    "familyName": "Undulatsson",
    "careOf": "Olleinho Jyckesson",
    "reference": "string",
    "organizationName": "Storm",
    "streetAddress": "Adaptivevägen 18",
    "streetAddress2": "Lgh 1203",
    "postalCode": "955 60",
    "city": "Boden",
    "region": "Norrbotten",
    "country": "SE",
    "phone": "0753892233",
    "email": "rosalinainho.undulatsson@example.com",
    "nationalIdentificationNumber": "890201-3286",
    "organizationIdentificationNumber": "212000-1355",
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

OK

Response
No content

Checkout Payment

Operations

Checkout Shipping

Operations