NORCE CHECKOUT
/
CORE
/
Order
/
Checkout
/
Create consent

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
order-v1.json
order-v1.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 Loyalty

Request

Update customer loyalty

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

Loyalty information

idstring

Unique identifier for the loyalty membership.

Example: "loyalty-123"
providerstring

Loyalty program provider.

Example: "remember-me"
promotionsArray of objects(LoyaltyPromotion)

List of promotions associated with the loyalty membership.

rewardVouchersArray of objects(LoyaltyRewardVoucher)

List of reward vouchers associated with the loyalty membership.

attributesobject

Allows you to store any custom attributes for the loyalty membership.

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v1/checkout/orders/{orderId}/customer/loyalty' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "id": "loyalty-123",
    "provider": "remember-me",
    "promotions": [
      {
        "id": "promo-456",
        "externalCode": "ext-promo-789",
        "name": "Summer Sale 2026"
      }
    ],
    "rewardVouchers": [
      {
        "id": "voucher-101",
        "name": "10% Off Next Purchase",
        "voucherNumber": "VCH-2026-ABC123",
        "externalCode": "ext-voucher-202"
      }
    ],
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

OK

Response
No content

Create consent

Request

Create consent

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

Consent

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/v1/checkout/orders/{orderId}/consents' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "checked": true,
    "text": "string",
    "required": true
  }'

Responses

OK

Response
No content

Patch consents, will only change value of Checked.

Request

Patch consents

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

Consents

Array [
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/v1/checkout/orders/{orderId}/consents' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '[
    {
      "checked": true,
      "text": "string",
      "required": true
    }
  ]'

Responses

OK

Response
No content

Checkout Payment

Operations

Checkout Shipping

Operations