Last updated

Norce Checkout - Awardit Adapter API

Version: 1.0.0

Build 2025-10-28 13:32:08

The Awardit Adapter API is used to create and manage an Awardit Checkout Order.

For conceptual documentation and usage guides, see:

Base URLs

  • https://awardit-adapter.checkout.playground.norce.tech/checkout/awardit-adapter - Public
  • https://awardit-adapter.checkout.test.internal.norce.tech - Internal Test
  • https://awardit-adapter.checkout.playground.internal.norce.tech - Internal Playground
  • https://awardit-adapter.checkout.stage.internal.norce.tech - Internal Stage
  • https://awardit-adapter.checkout.prod.internal.norce.tech - Internal Production

Authentication

Bearer

  • Type: apiKey
  • Description: Authorization header using the bearer scheme. Example: 'Bearer a3bcdABCaB12abc3AbCDAB5AbcABCaBcABC5ab3c5A0='

Endpoints

POST /api/checkout/v1/orders/{order_id}/payments

Create a new Awardit giftcard

Requires an existing Norce order.

Parameters

  • x-merchant (header) required
    • Merchant identifier.
    • Type: string
    • Example: norce
  • x-channel (header) required
    • Channel identifier
    • Type: string
    • Example: 1
  • order_id (path) required
    • Order identifier
    • Type: string

Request Body

Content-Type: application/json

Responses

400

Bad Request

Content-Type: application/json

Schema: Error

404

Not Found

Content-Type: application/json

409

Conflict

Content-Type: application/json

Schema: Error

POST /api/checkout/v1/orders/{order_id}/payments/{payment_id}/remove

Remove an Awardit giftcard

Requires an existing Norce order. Will do soft delete on any payments or shippings by setting state to removed. Will delete any hooks added when creating an Awardit payment.

Parameters

  • x-merchant (header) required
    • Merchant identifier.
    • Type: string
    • Example: norce
  • x-channel (header) required
    • Channel identifier
    • Type: string
    • Example: 1
  • order_id (path) required
    • Order identifier
    • Type: string
  • payment_id (path) required
    • Payment identifier
    • Type: string

Responses

204

No Content

400

Bad Request

Content-Type: application/json

Schema: Error

401

Unauthorized

Content-Type: application/json

Schema: Error

404

Not Found

Content-Type: application/json

POST /api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/state-changed

Handle state changed

State changed.

Parameters

  • x-merchant (header) required
    • Merchant identifier.
    • Type: string
    • Example: norce
  • x-channel (header) required
    • Channel identifier
    • Type: string
    • Example: 1
  • order_id (path) required
    • Order identifier
    • Type: string
  • payment_id (path) required
    • Payment identifier
    • Type: string

Request Body

Updated order

Content-Type: application/json

Responses

200

OK

Content-Type: application/json

Schema: Array of PatchOperation

400

Bad Request

Content-Type: application/json

404

Not Found

Content-Type: application/json

POST /api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/update-payment

Update payment amount in response to changes

Hook on changes to update payment.

Parameters

  • x-merchant (header) required
    • Merchant identifier.
    • Type: string
    • Example: norce
  • x-channel (header) required
    • Channel identifier
    • Type: string
    • Example: 1
  • order_id (path) required
    • Order identifier
    • Type: string
  • payment_id (path) required
    • Payment identifier
    • Type: string

Request Body

Updated order

Content-Type: application/json

Responses

200

OK

Content-Type: application/json

Schema: Array of PatchOperation

400

Bad Request

Content-Type: application/json

404

Not Found

Content-Type: application/json

Schemas

Addon

Properties

  • reference (string)
  • price (number)

Address

Properties

  • type
  • givenName (string)
  • familyName (string)
  • careOf (string)
  • reference (string)
  • organizationName (string)
  • streetAddress (string)
  • streetAddress2 (string)
  • postalCode (string)
  • city (string)
  • region (string)
  • country (string)
  • phone (string)
  • email (string)
  • nationalIdentificationNumber (string)
  • organizationIdentificationNumber (string)
  • attributes (object)

AwarditError

Properties

  • errorCode (string)
  • errorMessages (array)
  • correlationId (string)

Cart

Properties

  • reference (string)
  • items (array) - Array of Item
  • discounts (array) - Array of Discount
  • total
  • attributes (object)

Properties

  • id (string)
  • checked (boolean)
  • text (string)
  • required (boolean)

Customer

Properties

  • billing
  • shipping
  • type
  • attributes (object)

CustomerType

DeliveryDetails

Properties

  • carrier (string)
  • class (string)
  • product
  • pickupLocation

Discount

Properties

  • type
  • name (string)
  • code (string)
  • value
  • attributes (object)

DiscountType

Error

Properties

  • code (string)
    • Error code
    • Example: "cart-not-found"
  • message (string)
    • Detailed error information
    • Example: "Cart with id:{id} now found."
  • awarditError
    • Error if originating from Awardit

GiftCard

Properties

  • cardId (string)
  • code (string)

Hook

Properties

  • id (string)
  • adapterId (string)
  • subscribeTo (string)
  • target (string)
  • invoke (string)

Item

Properties

  • id (string)
  • reference (string)
  • name (string)
  • sku (string)
  • url (string)
  • imageUrl (string)
  • quantity (integer)
  • unit (string)
  • price
  • total
  • originalTotal
  • vatRate (number)
  • discounts (array) - Array of Discount
  • attributes (object)

NorceOrder

Properties

  • id (string)
  • merchant (string)
  • channel (string)
  • reference (string)
  • created (string)
  • lastModified (string)
  • state
  • culture (string)
  • currency (string)
  • country (string)
  • cart
  • shippings (array) - Array of Shipping
  • payments (array) - Array of Payment
  • customer
  • consents (array) - Array of Consent
  • hooks (array) - Array of Hook
  • total
  • attributes (object)

OrderStatus

PatchOperation

Properties

  • op (string)
  • path (string)
  • value

Payment

Properties

  • id (string)
  • adapterId (string)
  • name (string)
  • merchant (string)
  • channel (string)
  • currency (string)
  • type
  • orderId (string)
  • amount (number)
  • upperLimitAmount (number)
  • state
  • reference (string)
  • attributes (object)

PaymentState

PaymentType

PickupLocation

Properties

  • reference (string)
  • name (string)
  • address

PickupLocationAddress

Properties

  • streetAddress (string)
  • city (string)
  • postalCode (string)
  • country (string)

Price

Properties

  • includingVat (number)
  • excludingVat (number)

ProblemDetails

Properties

  • type (string)
  • title (string)
  • status (integer)
  • detail (string)
  • instance (string)

Product

Properties

  • reference (string)
  • name (string)

Shipping

Properties

  • id (string)
  • merchant (string)
  • channel (string)
  • state
  • reference (string)
  • tmsReference (string)
  • orderId (string)
  • adapterId (string)
  • name (string)
  • total
  • vatRate (number)
  • deliveryDetails
  • addons (array) - Array of Addon
  • attributes (object)

ShippingState

State

Properties

  • currentStatus
  • transitions (array) - Array of Transition

Transition

Properties

  • status
  • timeStamp (string)