NORCE CHECKOUT

VOUCHER ADAPTERS

Handle order state changed (order scoped, independent of any Awardit payment)

Norce Checkout - Awardit Adapter API (1.0.0)

Build 2026-10-05 05:49:56

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

Download OpenAPI description

awardit-adapter.json

awardit-adapter.yaml

Servers

Public

https://awardit-adapter.checkout.playground.norce.tech/checkout/awardit-adapter/

Internal Test

https://awardit-adapter.checkout.test.internal.norce.tech/

Internal Playground

https://awardit-adapter.checkout.playground.internal.norce.tech/

Internal Stage

https://awardit-adapter.checkout.stage.internal.norce.tech/

Internal Production

https://awardit-adapter.checkout.prod.internal.norce.tech/

Schemas

Payments

Operations

Gift Cards

Operations

Norce Callbacks

Operations

Handle order state changed (order scoped, independent of any Awardit payment)

Request

Order state changed. Validates gift card items on Processing and issues gift cards on Completed.

Path

order_idstringrequired

Order identifier

Headers

x-merchantstringrequired

Merchant identifier.

Example: norce

x-channelstringrequired

Channel identifier

Example: 1

Bodyapplication/json

Updated order

idstring

merchantstring

channelstring

referencestring

createdstring(date-time)

lastModifiedstring(date-time)

stateobject

culturestring

currencystring

countrystring

cartobject

shippingsArray of objects(Shipping)

paymentsArray of objects(Payment)

customerobject

consentsArray of objects(Consent)

hooksArray of objects(Hook)

validationsArray of objects(Validation)

notificationsArray of objects(Notification)

totalobject

attributesobject

curl -i -X POST \
  'https://awardit-adapter.checkout.playground.norce.tech/checkout/awardit-adapter/api/checkout/v1/callback/orders/{order_id}/state-changed' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "id": "string",
    "merchant": "string",
    "channel": "string",
    "reference": "string",
    "created": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "state": {
      "currentStatus": "checkout",
      "transitions": [
        {
          "status": "checkout",
          "timeStamp": "2019-08-24T14:15:22Z"
        }
      ]
    },
    "culture": "string",
    "currency": "string",
    "country": "string",
    "cart": {
      "reference": "string",
      "items": [
        {
          "id": "string",
          "reference": "string",
          "name": "string",
          "sku": "string",
          "productType": "physical",
          "url": "string",
          "imageUrl": "string",
          "quantity": 0,
          "unit": "string",
          "price": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "total": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "originalTotal": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "vatRate": 0.1,
          "discounts": [
            {
              "type": "item",
              "name": "string",
              "code": "string",
              "value": {
                "includingVat": 0.1,
                "excludingVat": 0.1
              },
              "attributes": {
                "property1": null,
                "property2": null
              }
            }
          ],
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "discounts": [
        {
          "type": "item",
          "name": "string",
          "code": "string",
          "value": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "total": {
        "includingVat": 0.1,
        "excludingVat": 0.1
      },
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "shippings": [
      {
        "id": "string",
        "state": "intent",
        "reference": "string",
        "tmsReference": "string",
        "orderId": "string",
        "adapterId": "string",
        "name": "string",
        "total": {
          "includingVat": 0.1,
          "excludingVat": 0.1
        },
        "vatRate": 0.1,
        "deliveryDetails": {
          "carrier": "string",
          "class": "string",
          "product": {
            "reference": "string",
            "name": "string"
          },
          "pickupLocation": {
            "reference": "string",
            "name": "string",
            "address": {
              "streetAddress": "string",
              "city": "string",
              "postalCode": "string",
              "country": "string"
            }
          }
        },
        "addons": [
          {
            "reference": "string",
            "price": 0.1
          }
        ],
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "payments": [
      {
        "id": "string",
        "adapterId": "string",
        "name": "string",
        "currency": "string",
        "type": "default",
        "orderId": "string",
        "amount": 0.1,
        "upperLimitAmount": 0.1,
        "state": "intent",
        "reference": "string",
        "voucher": {
          "cardId": "string"
        },
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "customer": {
      "billing": {
        "type": "person",
        "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": {
          "property1": null,
          "property2": null
        }
      },
      "shipping": {
        "type": "person",
        "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": {
          "property1": null,
          "property2": null
        }
      },
      "type": "person",
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "consents": [
      {
        "id": "string",
        "checked": true,
        "text": "string",
        "required": true
      }
    ],
    "hooks": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "scope": "string",
        "version": "v0",
        "target": "string",
        "invoke": "string"
      }
    ],
    "validations": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "invoke": "string"
      }
    ],
    "notifications": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "scope": "string",
        "schema": {
          "property1": null,
          "property2": null
        },
        "invoke": "string",
        "delay": 0
      }
    ],
    "total": {
      "includingVat": 0.1,
      "excludingVat": 0.1
    },
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

Bodyapplication/jsonArray [

opstring

pathstring

valueany

]

Response

application/json

[
  {
    "op": "string",
    "path": "string",
    "value": null
  }
]

Handle state changed

Request

State changed.

Path

order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers

x-merchantstringrequired

Merchant identifier.

Example: norce

x-channelstringrequired

Channel identifier

Example: 1

Bodyapplication/json

Updated order

idstring

merchantstring

channelstring

referencestring

createdstring(date-time)

lastModifiedstring(date-time)

stateobject

culturestring

currencystring

countrystring

cartobject

shippingsArray of objects(Shipping)

paymentsArray of objects(Payment)

customerobject

consentsArray of objects(Consent)

hooksArray of objects(Hook)

validationsArray of objects(Validation)

notificationsArray of objects(Notification)

totalobject

attributesobject

curl -i -X POST \
  'https://awardit-adapter.checkout.playground.norce.tech/checkout/awardit-adapter/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/state-changed' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "id": "string",
    "merchant": "string",
    "channel": "string",
    "reference": "string",
    "created": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "state": {
      "currentStatus": "checkout",
      "transitions": [
        {
          "status": "checkout",
          "timeStamp": "2019-08-24T14:15:22Z"
        }
      ]
    },
    "culture": "string",
    "currency": "string",
    "country": "string",
    "cart": {
      "reference": "string",
      "items": [
        {
          "id": "string",
          "reference": "string",
          "name": "string",
          "sku": "string",
          "productType": "physical",
          "url": "string",
          "imageUrl": "string",
          "quantity": 0,
          "unit": "string",
          "price": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "total": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "originalTotal": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "vatRate": 0.1,
          "discounts": [
            {
              "type": "item",
              "name": "string",
              "code": "string",
              "value": {
                "includingVat": 0.1,
                "excludingVat": 0.1
              },
              "attributes": {
                "property1": null,
                "property2": null
              }
            }
          ],
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "discounts": [
        {
          "type": "item",
          "name": "string",
          "code": "string",
          "value": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "total": {
        "includingVat": 0.1,
        "excludingVat": 0.1
      },
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "shippings": [
      {
        "id": "string",
        "state": "intent",
        "reference": "string",
        "tmsReference": "string",
        "orderId": "string",
        "adapterId": "string",
        "name": "string",
        "total": {
          "includingVat": 0.1,
          "excludingVat": 0.1
        },
        "vatRate": 0.1,
        "deliveryDetails": {
          "carrier": "string",
          "class": "string",
          "product": {
            "reference": "string",
            "name": "string"
          },
          "pickupLocation": {
            "reference": "string",
            "name": "string",
            "address": {
              "streetAddress": "string",
              "city": "string",
              "postalCode": "string",
              "country": "string"
            }
          }
        },
        "addons": [
          {
            "reference": "string",
            "price": 0.1
          }
        ],
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "payments": [
      {
        "id": "string",
        "adapterId": "string",
        "name": "string",
        "currency": "string",
        "type": "default",
        "orderId": "string",
        "amount": 0.1,
        "upperLimitAmount": 0.1,
        "state": "intent",
        "reference": "string",
        "voucher": {
          "cardId": "string"
        },
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "customer": {
      "billing": {
        "type": "person",
        "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": {
          "property1": null,
          "property2": null
        }
      },
      "shipping": {
        "type": "person",
        "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": {
          "property1": null,
          "property2": null
        }
      },
      "type": "person",
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "consents": [
      {
        "id": "string",
        "checked": true,
        "text": "string",
        "required": true
      }
    ],
    "hooks": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "scope": "string",
        "version": "v0",
        "target": "string",
        "invoke": "string"
      }
    ],
    "validations": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "invoke": "string"
      }
    ],
    "notifications": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "scope": "string",
        "schema": {
          "property1": null,
          "property2": null
        },
        "invoke": "string",
        "delay": 0
      }
    ],
    "total": {
      "includingVat": 0.1,
      "excludingVat": 0.1
    },
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

Bodyapplication/jsonArray [

opstring

pathstring

valueany

]

Response

application/json

[
  {
    "op": "string",
    "path": "string",
    "value": null
  }
]

Update payment amount in response to changes

Request

Hook on changes to update payment.

Path

order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers

x-merchantstringrequired

Merchant identifier.

Example: norce

x-channelstringrequired

Channel identifier

Example: 1

Bodyapplication/json

Updated order

idstring

merchantstring

channelstring

referencestring

createdstring(date-time)

lastModifiedstring(date-time)

stateobject

culturestring

currencystring

countrystring

cartobject

shippingsArray of objects(Shipping)

paymentsArray of objects(Payment)

customerobject

consentsArray of objects(Consent)

hooksArray of objects(Hook)

validationsArray of objects(Validation)

notificationsArray of objects(Notification)

totalobject

attributesobject

curl -i -X POST \
  'https://awardit-adapter.checkout.playground.norce.tech/checkout/awardit-adapter/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/update-payment' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "id": "string",
    "merchant": "string",
    "channel": "string",
    "reference": "string",
    "created": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "state": {
      "currentStatus": "checkout",
      "transitions": [
        {
          "status": "checkout",
          "timeStamp": "2019-08-24T14:15:22Z"
        }
      ]
    },
    "culture": "string",
    "currency": "string",
    "country": "string",
    "cart": {
      "reference": "string",
      "items": [
        {
          "id": "string",
          "reference": "string",
          "name": "string",
          "sku": "string",
          "productType": "physical",
          "url": "string",
          "imageUrl": "string",
          "quantity": 0,
          "unit": "string",
          "price": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "total": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "originalTotal": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "vatRate": 0.1,
          "discounts": [
            {
              "type": "item",
              "name": "string",
              "code": "string",
              "value": {
                "includingVat": 0.1,
                "excludingVat": 0.1
              },
              "attributes": {
                "property1": null,
                "property2": null
              }
            }
          ],
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "discounts": [
        {
          "type": "item",
          "name": "string",
          "code": "string",
          "value": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "total": {
        "includingVat": 0.1,
        "excludingVat": 0.1
      },
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "shippings": [
      {
        "id": "string",
        "state": "intent",
        "reference": "string",
        "tmsReference": "string",
        "orderId": "string",
        "adapterId": "string",
        "name": "string",
        "total": {
          "includingVat": 0.1,
          "excludingVat": 0.1
        },
        "vatRate": 0.1,
        "deliveryDetails": {
          "carrier": "string",
          "class": "string",
          "product": {
            "reference": "string",
            "name": "string"
          },
          "pickupLocation": {
            "reference": "string",
            "name": "string",
            "address": {
              "streetAddress": "string",
              "city": "string",
              "postalCode": "string",
              "country": "string"
            }
          }
        },
        "addons": [
          {
            "reference": "string",
            "price": 0.1
          }
        ],
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "payments": [
      {
        "id": "string",
        "adapterId": "string",
        "name": "string",
        "currency": "string",
        "type": "default",
        "orderId": "string",
        "amount": 0.1,
        "upperLimitAmount": 0.1,
        "state": "intent",
        "reference": "string",
        "voucher": {
          "cardId": "string"
        },
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "customer": {
      "billing": {
        "type": "person",
        "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": {
          "property1": null,
          "property2": null
        }
      },
      "shipping": {
        "type": "person",
        "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": {
          "property1": null,
          "property2": null
        }
      },
      "type": "person",
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "consents": [
      {
        "id": "string",
        "checked": true,
        "text": "string",
        "required": true
      }
    ],
    "hooks": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "scope": "string",
        "version": "v0",
        "target": "string",
        "invoke": "string"
      }
    ],
    "validations": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "invoke": "string"
      }
    ],
    "notifications": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "scope": "string",
        "schema": {
          "property1": null,
          "property2": null
        },
        "invoke": "string",
        "delay": 0
      }
    ],
    "total": {
      "includingVat": 0.1,
      "excludingVat": 0.1
    },
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

Bodyapplication/jsonArray [

opstring

pathstring

valueany

]

Response

application/json

[
  {
    "op": "string",
    "path": "string",
    "value": null
  }
]

Norce Notifications

Operations

Norce Checkout - Awardit Adapter API (1.0.0)

Schemas

Payments

Gift Cards

Norce Callbacks

Handle order state changed (order scoped, independent of any Awardit payment)

Request

Responses

Did the information on the page help you?

Handle state changed

Request

Responses

Did the information on the page help you?

Update payment amount in response to changes

Request

Responses

Did the information on the page help you?

Norce Notifications

Norce Checkout - Awardit Adapter API (1.0.0)

Schemas

Payments

Gift Cards

Norce Callbacks

Handle order state changed (order scoped, independent of any Awardit payment)

RequestExpand all

Responses

Did the information on the page help you?

Handle state changed

RequestExpand all

Responses

Did the information on the page help you?

Update payment amount in response to changes

RequestExpand all

Responses

Did the information on the page help you?

Norce Notifications

Request

Request

Request