NORCE CHECKOUT
/
CORE
/
Order
/
Checkout
/
Create consent

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

Update Customer Shipping Address

Request

Update customer shipping 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

Shipping 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/shipping' \
  -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

Create consent

Request

Create consent

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

Consent

idstring

Unique ID for the consent item.

Example: "ci_newsleter"
checkedboolean

Consent checked status.

textstring

Consent description.

requiredboolean

Required for transitioning order state to 'Processing'

curl -i -X POST \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders/{order_id}/consents' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "id": "ci_newsleter",
    "checked": true,
    "text": "string",
    "required": true
  }'

Responses

OK

Response
No content

Patch consents, will only change value of Checked.

Request

Patch consents

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

Consents

Array [
idstring

Unique ID for the consent item.

Example: "ci_newsleter"
checkedboolean

Consent checked status.

textstring

Consent description.

requiredboolean

Required for transitioning order state to 'Processing'

]
curl -i -X PATCH \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders/{order_id}/consents' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '[
    {
      "id": "ci_newsleter",
      "checked": true,
      "text": "string",
      "required": true
    }
  ]'

Responses

OK

Response
No content

Checkout Payment

Operations

Checkout Shipping

Operations