NORCE CHECKOUT

CORE

Order

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

order.json

order.yaml

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

Create a new Order

Request

Creates an order in checkout state

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/json

Order

referencestring

External order reference

stateobject

Order state

culturestring^[A-Za-z]{2,3}(?:-[A-Za-z]{2,2})*$

Order Culture, RFC-1766

currencystring^[A-Za-z]{3,3}$

Order Currency, ISO 4217 alpha-3.

countrystring^[A-Za-z]{2,2}$

Order Country. ISO 3166 alpha-2.

cartobject

Order cart

customerobject

Customer information

consentsArray of objects(Consent)

Order consents

validationsArray of objects(Callback)

Order actions are called in order to complete an action, such as 'Validate'. If provided the action is not completed if the response is not successful (e.g. http status code 400), note however that in case of a time constraint the action might be completed without a successful response.

hooksArray of objects(Hook)

Hooks, added by a separate endpoint.

notificationsArray of objects(Notification)

Order notifications are called after an event has occurred, such as order reaching 'Completed' state.

totalobject

Order total including shipping fees

attributesobject

Allows you to store any custom attributes for the order.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "reference": "string",
    "state": {
      "currentStatus": "checkout"
    },
    "culture": "string",
    "currency": "string",
    "country": "string",
    "cart": {
      "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
      }
    },
    "customer": {
      "billing": {
        "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
        }
      },
      "shipping": {
        "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
        }
      },
      "type": "Person",
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "consents": [
      {
        "id": "ci_newsleter",
        "checked": true,
        "text": "string",
        "required": true
      }
    ],
    "validations": [
      {
        "adapterId": "jetshop_adapter",
        "url": "http://specific-feature-adapter.norce.io/api/v1/callbacks/orders/{order_id}/specific-callback"
      }
    ],
    "hooks": [
      {
        "adapterId": "jetshop_adapter",
        "subscribeTo": "string",
        "target": "string",
        "invoke": "http://specific-feature-adapter.norce.io/api/v1/callbacks/orders/{order_id}/specific-callback",
        "version": "v0"
      }
    ],
    "notifications": [
      {
        "id": "ocGooDddTOjKOuFmNnkEozEpfuTh",
        "adapterId": "jetshop_adapter",
        "reference": "PuXCudQEiWTOHvquGGolFUVOuy",
        "description": "Export payment information to Jetshop when order has been completed.",
        "scope": "/state/currentStatus",
        "schema": {
          "const": "completed"
        },
        "invoke": "{configuration.adapter.internalUrl}/api/v1/callbacks/orders/{order.id}/specific-callback",
        "version": "v0",
        "delay": 0
      }
    ],
    "total": {
      "includingVat": 1234,
      "excludingVat": 987.2
    },
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

Created

Bodyapplication/json

string

Response

application/json

"string"

Get orders

Request

Get all orders

Query

offsetinteger(int32)

limitinteger(int32)

searchstring

payment_idstring

referencestring

cart_referencestring

date_fromstring(date-time)

date_tostring(date-time)

statusArray of strings(OrderStatus)

Items Enum"checkout""processing""accepted""completed""declined""removed"

order_bystring

Enum"created""billingEmail""billingName""cartTotal"

order_by_directionstring

Enum"asc""desc"

countriesArray of strings

billing_countriesArray of strings

shipping_countriesArray of strings

billing_emailsArray of strings

shipping_emailsArray of strings

billing_phonesArray of strings

shipping_phonesArray of strings

billing_namesArray of strings

shipping_namesArray of strings

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

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce'

Responses

Bodyapplication/json

dataArray of objects(Order)read-only

Data set of requested orders

paginationobjectread-only

Pagination meta data

Response

application/json

{
  "data": [
    { … }
  ],
  "pagination": {
    "offset": 0,
    "limit": 0,
    "size": 0,
    "valueSum": 0.1,
    "totalSize": 0
  }
}

Delete existing order

Request

Delete order from a orders repository

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

curl -i -X DELETE \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders/{order_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce'

Responses

No Content

Response

No content

Checkout Payment

Operations

Checkout Shipping

Operations

Norce Checkout - Order Management API (0.1)

Schemas

Checkout

Create a new Order

Request

Responses

Did the information on the page help you?

Get orders

Request

Responses

Did the information on the page help you?

Delete existing order

Request

Responses

Did the information on the page help you?

Checkout Payment

Checkout Shipping

Norce Checkout - Order Management API (0.1)

Schemas

Checkout

Create a new Order

RequestExpand all

Responses

Did the information on the page help you?

Get orders

Request

Responses

Did the information on the page help you?

Delete existing order

Request

Responses

Did the information on the page help you?

Checkout Payment

Checkout Shipping

Request