NORCE CHECKOUT
/
SHIPPING ADAPTERS
/
Ingrid Adapter
/
Ingrid Delivery Experience Orders
/
Get Ingrid session

Norce Checkout - Ingrid Adapter API (1.0.0)

Build 2026-01-14 12:35:46

The Ingrid Adapter API is used to create and manage Ingrid shippings.

Download OpenAPI description
ingrid-adapter.json
ingrid-adapter.yaml
Languages
Servers

https://docs.norce.io/

Schemas

Norce Callbacks

Operations

Ingrid client side callbacks

Operations

Ingrid Delivery Experience Orders

Operations

Create a new Ingrid session

Request

Requires an existing order.

Path
order_idstringrequired

Order identifier

Headers
x-merchantstringrequired

Merchant identifier.

Example: norce
x-channelstringrequired

Channel identifier

Example: 1
curl -i -X POST \
  'https://docs.norce.io/api/checkout/v1/orders/{order_id}/shippings' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce'

Responses

OK

Bodyapplication/json
shippingIdstring

Shipping identifier

htmlSnippetstring

Ingrid html snippet

sessionIdstring

Session id

useAddressFormboolean

Use address form

Response
application/json
{
  "shippingId": "string",
  "htmlSnippet": "string",
  "sessionId": "string",
  "useAddressForm": true
}

Get Ingrid session

Request

Used to get the html snippet

Path
order_idstringrequired

Order identifier

shipping_idstringrequired

Shipping identifier

Headers
x-merchantstringrequired

Merchant identifier.

Example: norce
x-channelstringrequired

Channel identifier

Example: 1
curl -i -X GET \
  'https://docs.norce.io/api/checkout/v1/orders/{order_id}/shippings/{shipping_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce'

Responses

OK

Bodyapplication/json
shippingIdstring

Shipping identifier

htmlSnippetstring

Ingrid html snippet

sessionIdstring

Session id

useAddressFormboolean

Use address form

Response
application/json
{
  "shippingId": "string",
  "htmlSnippet": "string",
  "sessionId": "string",
  "useAddressForm": true
}

Remove an ingrid payment

Request

Requires an existing order.

Path
order_idstringrequired

Order identifier

shipping_idstringrequired

Shipping identifier

Headers
x-merchantstringrequired

Merchant identifier.

Example: norce
x-channelstringrequired

Channel identifier

Example: 1
curl -i -X POST \
  'https://docs.norce.io/api/checkout/v1/orders/{order_id}/shippings/{shipping_id}/remove' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce'

Responses

OK

Bodyapplication/json
shippingIdstring

Shipping identifier

htmlSnippetstring

Ingrid html snippet

sessionIdstring

Session id

useAddressFormboolean

Use address form

Response
application/json
{
  "shippingId": "string",
  "htmlSnippet": "string",
  "sessionId": "string",
  "useAddressForm": true
}