NORCE CHECKOUT
/
CORE
/
Order
/
Checkout
/
Get order by id

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

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

Get order by id

Request

Get order for merchant and channel

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 GET \
  '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

OK

Bodyapplication/json
idstringread-only

Unique identifier for the order

Example: "o_yClTSySjyAuuBjmiBlHCjuEcTf"
merchantstringnon-emptyread-onlyrequired

Merchant identifier

channelstringnon-emptyread-onlyrequired

Merchant channel

referencestring

External order reference

createdstring(date-time)read-only

Order creation date time

lastModifiedstring(date-time)read-only

Order last modified date time

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

shippingsArray of objects(Shipping)read-only

Shippings related to the order

paymentsArray of objects(Payment)read-only

Payments related to the order

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.

Response
application/json
{
  "id": "o_yClTSySjyAuuBjmiBlHCjuEcTf",
  "merchant": "string",
  "channel": "string",
  "reference": "string",
  "created": "2019-08-24T14:15:22Z",
  "lastModified": "2019-08-24T14:15:22Z",
  "state": {
    "currentStatus": "checkout",
    "transitions": [ … ]
  },
  "culture": "string",
  "currency": "string",
  "country": "string",
  "cart": {
    "reference": "string",
    "items": [ … ],
    "discounts": [ … ],
    "total": { … },
    "attributes": { … }
  },
  "shippings": [
    { … }
  ],
  "payments": [
    { … }
  ],
  "customer": {
    "billing": { … },
    "shipping": { … },
    "type": "Person",
    "attributes": { … }
  },
  "consents": [
    { … }
  ],
  "validations": [
    { … }
  ],
  "hooks": [
    { … }
  ],
  "notifications": [
    { … }
  ],
  "total": {
    "includingVat": 1234,
    "excludingVat": 987.2
  },
  "attributes": {
    "property1": null,
    "property2": null
  }
}

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

Checkout Payment

Operations

Checkout Shipping

Operations