Norce Checkout - Order Management API

Version: 0.1

Build 2025-11-03 08:18:18

The Order Management API is used to create and handle orders

Related Documentation

For conceptual documentation and usage guides, see:

• NCO Order Overview - Understanding NCO orders and order lifecycle
• NCO Introduction - Getting started with Norce Checkout
• Working with Norce Checkout - Implementation guide

Base URLs

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

Authentication

Bearer

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

Endpoints

POST /api/v0/checkout/orders

Create a new Order

Creates an order in checkout state

Parameters

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

Request Body

Order

Content-Type: application/json

Responses

201

Created

Content-Type: application/json

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

409

Conflict

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

GET /api/v0/checkout/orders

Get orders

Get all orders

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• offset (query)
  • Type: integer
• limit (query)
  • Type: integer
• search (query)
  • Type: string
• payment_id (query)
  • Type: string
• reference (query)
  • Type: string
• cart_reference (query)
  • Type: string
• date_from (query)
  • Type: string
• date_to (query)
  • Type: string
• status (query)
  • Schema: OrderStatus (JSON format)
• order_by (query)
• order_by_direction (query)
• countries (query)
  • Type: array
• billing_countries (query)
  • Type: array
• shipping_countries (query)
  • Type: array
• billing_emails (query)
  • Type: array
• shipping_emails (query)
  • Type: array
• billing_phones (query)
  • Type: array
• shipping_phones (query)
  • Type: array
• billing_names (query)
  • Type: array
• shipping_names (query)
  • Type: array

Responses

200

OK

Content-Type: application/json

Schema: OrderPaginationSet

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

DELETE /api/v0/checkout/orders/{order_id}

Delete existing order

Delete order from a orders repository

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

Responses

204

No Content

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

GET /api/v0/checkout/orders/{order_id}

Get order by id

Get order for merchant and channel

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

Responses

200

OK

Content-Type: application/json

Schema: Order

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

PUT /api/v0/checkout/orders/{order_id}/state

Update Order State

Update order state

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

200

OK

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

PUT /api/v0/checkout/orders/{order_id}/cart

Update order cart

Update order cart

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

200

OK

202

The status code indicates that the request has been accepted for processing, but the processing has not yet been completed or may have been canceled due to a more recent request being processed instead.

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

PUT /api/v0/checkout/orders/{order_id}/customer/billing

Update Customer Billing Address

Update customer billing address

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

Billing address

Content-Type: application/json

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

PUT /api/v0/checkout/orders/{order_id}/customer/shipping

Update Customer Shipping Address

Update customer shipping address

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

Shipping address

Content-Type: application/json

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

POST /api/v0/checkout/orders/{order_id}/consents

Create consent

Create consent

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

Consent

Content-Type: application/json

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

PATCH /api/v0/checkout/orders/{order_id}/consents

Patch consents, will only change value of Checked.

Patch consents

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

Consents

Content-Type: application/json

Schema: Array of Consent

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

DELETE /api/v0/checkout/orders/{order_id}/consents/{consent_id}

Remove consent

Remove consent

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
• consent_id (path) required
  • Consent identifier
  • Type: string

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

PATCH /api/v0/checkout/orders/{order_id}/consents/{consent_id}

Patch consent, will only change value of Checked.

Patch consent

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
• consent_id (path) required
  • Consent identifier
  • Type: string

Request Body

Consent

Content-Type: application/json

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

PATCH /api/v0/checkout/orders/{order_id}/attributes

Patch attributes

Patch attributes

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

Attribute

Content-Type: application/json

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

POST /api/v0/checkout/orders/{order_id}/validations

Create validation

Create validation

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

Validation callback

Content-Type: application/json

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

PUT /api/v0/checkout/orders/{order_id}/validations/{validation_id}

Update validation

Update validation

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
• validation_id (path) required
  • Validation identifier
  • Type: string

Request Body

Validation callback

Content-Type: application/json

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

DELETE /api/v0/checkout/orders/{order_id}/validations/{validation_id}

Remove validation

Remove validation

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
• validation_id (path) required
  • Validation identifier
  • Type: string

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

POST /api/v0/checkout/orders/{order_id}/validate

Validate an order

Validate 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

Responses

200

OK

Content-Type: application/json

Schema: Array of ValidationError

400

Bad Request

Content-Type: application/json

Schema: Array of ValidationError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

PUT /api/v0/checkout/orders/{order_id}/reference

Update Order Reference

Update order reference

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

200

OK

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

POST /api/v0/checkout/orders/{order_id}/hooks

Create hook

Create hook

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

Hook

Content-Type: application/json

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

DELETE /api/v0/checkout/orders/{order_id}/hooks/{hook_id}

Delete hook

Delete hook

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
• hook_id (path) required
  • Hook identifier
  • Type: string

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

POST /api/v0/checkout/orders/{order_id}/notifications

Create notification

Create notification

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

Notification

Content-Type: application/json

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

DELETE /api/v0/checkout/orders/{order_id}/notifications/{notification_id}

Delete notification

Delete notification

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
• notification_id (path) required
  • Notification identifier
  • Type: string

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

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

Create Order Payment

Creates a order 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

Request Body

Payment

Content-Type: application/json

Responses

201

Created

Content-Type: application/json

Schema: CreateResponse

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

409

Conflict

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

GET /api/v0/checkout/orders/{order_id}/payments

Get Order Payments

Get order payments

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

Responses

200

OK

Content-Type: application/json

Schema: Array of Payment

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

GET /api/v0/checkout/orders/{order_id}/payments/{payment_id}

Get Order Payment

Get order 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

200

OK

Content-Type: application/json

Schema: Payment

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

PUT /api/v0/checkout/orders/{order_id}/payments/{payment_id}

Update Order Payment

Update order 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

Content-Type: application/json

Responses

200

OK

Content-Type: application/json

Schema: Payment

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

GET /api/v0/checkout/orders/{order_id}/payments/{payment_id}/transactions

Get transactions for an order payment

Get transactions for an order 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

200

OK

Content-Type: application/json

Schema: Array of PaymentTransaction

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

POST /api/v0/checkout/orders/{order_id}/payments/{payment_id}/transactions

Add transaction for an order payment

Add transaction for an order 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

Content-Type: application/json

Responses

200

OK

Content-Type: application/json

Schema: PaymentTransaction

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

POST /api/v0/checkout/orders/{order_id}/payments/{payment_id}/actions

Create a Payment PaymentAction

Add paymentAction for an order 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

Payment Actions

Content-Type: application/json

Schema: Array of PaymentAction

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

POST /api/v0/checkout/orders/{order_id}/payments/{payment_id}/actions/{action_id}/execute

Execute a Payment PaymentAction

Execute a paymentAction for an order 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
• action_id (path) required
  • PaymentAction identifier
  • Type: string

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

POST /api/v0/checkout/orders/{order_id}/shippings

Create Order Shipping

Creates a order shipping

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

Shipping

Content-Type: application/json

Responses

201

Created

Content-Type: application/json

Schema: CreateResponse

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

409

Conflict

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

GET /api/v0/checkout/orders/{order_id}/shippings

Get Order Shippings

Get order shippings

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

Responses

200

OK

Content-Type: application/json

Schema: Array of Shipping

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

GET /api/v0/checkout/orders/{order_id}/shippings/{shipping_id}

Get Order Shipping

Get order shipping

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
• shipping_id (path) required
  • Shipping identifier
  • Type: string

Responses

200

OK

Content-Type: application/json

Schema: Shipping

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

PUT /api/v0/checkout/orders/{order_id}/shippings/{shipping_id}

Update Order Shipping

Update order shipping

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
• shipping_id (path) required
  • Shipping identifier
  • Type: string

Request Body

Content-Type: application/json

Responses

200

OK

Content-Type: application/json

Schema: Shipping

400

Bad Request

Content-Type: application/json

Schema: BaseError

401

Unauthorized

Content-Type: application/json

Schema: BaseError

404

Not Found

Content-Type: application/json

Schema: BaseError

500

Internal Server Error

Content-Type: application/json

Schema: BaseError

Schemas

Addon

Properties

• reference (string)
  • Shipping addon reference.
• price (number)
  • Cost of addon. Amount in major unit currency.

Address

Properties

• type
  • The type of customer
  • Example: "Person"
• givenName (string)
  • Given name or first name.
  • Example: "Rosalinainho"
• familyName (string)
  • Family name or last name.
  • Example: "Undulatsson"
• careOf (string)
  • Care of.
  • Example: "Olleinho Jyckesson"
• reference (string)
  • Reference to the customer
• organizationName (string)
  • Name of the Organization
  • Example: "Storm"
• streetAddress (string)
  • Address or street name, first line.
  • Example: "Adaptivevägen 18"
• streetAddress2 (string)
  • Address or street name, second line.
  • Example: "Lgh 1203"
• postalCode (string)
  • Postal code, zip or post code.
  • Example: "955 60"
• city (string)
  • City.
  • Example: "Boden"
• region (string)
  • State or region.
  • Example: "Norrbotten"
• country (string)
  • Country. ISO 3166 alpha-2.
  • Example: "SE"
• phone (string)
  • Phone number.
  • Example: "0753892233"
• email (string)
  • E-mail address.
  • Example: "rosalinainho.undulatsson@example.com"
• nationalIdentificationNumber (string)
  • Number used to identify individuals. E.g. could be used for Personal identity number (personnummer) in Sweden.
  • Example: "890201-3286"
• organizationIdentificationNumber (string)
  • Number used to identify organizations or legal persons. E.g. could be used for Corporate identity number. (organisationsnummer in Sweden)
  • Example: "212000-1355"
• attributes (object)
  • Allows you to store any custom attributes for the address.

BaseError

Properties

• code (string)
  • Error code
  • Example: "order-not-found"
• message (string)
  • Detailed error information
  • Example: "Order with id:{id} not found."

Callback

Properties

• id (string)
  • Unique ID for the callback.
  • Example: "oc_BaDIudFOjBEuFmLlmDExePUFTh"
• adapterId (string)
  • Callback Adapter ID.
  • Example: "jetshop_adapter"
• url (string)
  • Full valid url to be called by POST. If the url contains the substring '{order_id}' it will be replaced with the orders id before call is performed.
  • Example: "http://specific-feature-adapter.norce.io/api/v1/callbacks/orders/{order_id}/specific-callback"

Cart

Properties

• reference (string)
  • Cart Reference
• items (array) - Array of Item
  • List of Items
• discounts (array) - Array of Discount
  • List of Discounts
• total
  • Cart total excluding shipping fees
• attributes (object)
  • Allows you to store any custom attributes for cart.

Consent

Properties

• id (string)
  • Unique ID for the consent item.
  • Example: "ci_newsleter"
• checked (boolean)
  • Consent checked status.
• text (string)
  • Consent description.
• required (boolean)
  • Required for transitioning order state to 'Processing'

CreateResponse

Properties

• id (string)

Customer

Properties

• billing
  • Billing address to the customer
• shipping
  • Shipping address to the customer
• type required
  • The type of customer
  • Example: "Person"
• attributes (object)
  • Allows you to store any custom attributes for the customer.

CustomerType

DeliveryDetails

Properties

• carrier (string)
  • Carrier name.
• carrierProductId (string)
  • Carrier product identifier.
• class (string)
  • Shipping class.
• product
  • Shipping product.
• pickupLocation
  • Pickup location.

Discount

Properties

• type
  • Indicates if the discount applies to items or shipping.
• name (string)
  • Name of the discount.
• reference (string)
  • Discount reference.
• description (string)
  • Description of the discount.
• code (string)
  • Discount code.
• value
  • Total sum of discount.
• attributes (object)
  • Allows you to store any custom attributes for the discount.

DiscountType

Hook

Properties

• id (string)
  • Unique ID for the callback.
  • Example: "oc_BaDIudFOjBEuFmLlmDExePUFTh"
• adapterId (string)
  • Example: "jetshop_adapter"
• subscribeTo (string)
• target (string)
• invoke (string)
  • Full valid url to be called by POST. If the url contains the substring '{order_id}' it will be replaced with the orders id before call is performed.
  • Example: "http://specific-feature-adapter.norce.io/api/v1/callbacks/orders/{order_id}/specific-callback"
• version
  • The version of the order body you expect to receive in the callback.

Item

Properties

• id (string)
  • Unique identifier for the order
  • Example: "ci_FpEzyBvBBUyKxkeNriFUxZOCje"
• reference (string)
  • Optional. Platform cart item reference.
• name (string)
  • Descriptive name of the item.
  • Example: "T-Shirt XL"
• sku (string)
  • SKU or article number.
  • Example: "A000123"
• productType
  • Product type, physical is the default. Other options include Digital, GiftCard and Bundle.
• items (array) - Array of Item
  • A List of items, useful for when this item is a bundle containing other items.
• url (string)
  • URL to the product page.
  • Example: "https://example.com/products/A000123"
• imageUrl (string)
  • URL to an image showing the item.
  • Example: "https://example.com/products/A000123/images/1"
• quantity (integer)
  • Quantity of the item.
  • Example: 2
• unit (string)
  • Unit used to describe the quantity. Ex. st, kg
  • Example: "st"
• price
  • Unit price, excluding discount
• total
  • Total sum for all quantities including discount.
• originalTotal
  • Total sum for all quantities excluding discount.
• vatRate (number)
  • Value-added tax. 25% would be input as 0.25.
  • Example: 0.25
• discounts (array) - Array of Discount
  • Discounts applied to item.
• logistics
  • Logistics-related information for shipping and handling of the item.
• attributes (object)
  • Allows you to store any custom attributes for the item.

Logistics

Properties

• weight (integer)
  • Weight of the item in grams.
  • Example: 2500
• height (integer)
  • Height of the item in millimeters.
  • Example: 100
• width (integer)
  • Width of the item in millimeters.
  • Example: 50
• length (integer)
  • Length of the item in millimeters.
  • Example: 200
• tags (array)
  • Tags that can be used to setup custom delivery rules in delivery modules.
• shippingDate (string)

Notification

Properties

• id (string)
  • Unique ID for the Notification
  • Example: "ocGooDddTOjKOuFmNnkEozEpfuTh"
• adapterId (string)
  • Identifier for the system responsible for this notification. If any reference to configuration is made inside curly braces in Invoke the configuration is found using this identifier.
  • Example: "jetshop_adapter"
• reference (string)
  • Reference for the Notification. Should (but not required to) be unique for the order. Used to track notifications across different orders.
  • Example: "PuXCudQEiWTOHvquGGolFUVOuy"
• description (string)
  • Purpose or effect of the notification.
  • Example: "Export payment information to Jetshop when order has been completed."
• scope (string)
  • Valid json path inside the order. Does not support scope inside arrays.
  • Example: "/state/currentStatus"
• schema (object)
  • Json schema (https://json-schema.org/draft/2020-12/schema) on the scope. Notification triggers when a change occurs on the scope and the schema is valid for the scope.
  • Example: {"const":"completed"}
• invoke (string)
  • Url to invoke on notification trigger. Can include references to adapter configuration and order inside curly braces.
  • Example: "{configuration.adapter.internalUrl}/api/v1/callbacks/orders/{order.id}/specific-callback"
• version
  • The version of the order body you expect to receive in the callback.
• delay (integer)
  • The delay in ms before the notification is sent.

Order

Properties

• id (string)
  • Unique identifier for the order
  • Example: "o_yClTSySjyAuuBjmiBlHCjuEcTf"
• merchant (string) required
  • Merchant identifier
• channel (string) required
  • Merchant channel
• reference (string)
  • External order reference
• created (string)
  • Order creation date time
• lastModified (string)
  • Order last modified date time
• state
  • Order state
• culture (string)
  • Order Culture, RFC-1766
• currency (string)
  • Order Currency, ISO 4217 alpha-3.
• country (string)
  • Order Country. ISO 3166 alpha-2.
• cart
  • Order cart
• shippings (array) - Array of Shipping
  • Shippings related to the order
• payments (array) - Array of Payment
  • Payments related to the order
• customer
  • Customer information
• consents (array) - Array of Consent
  • Order consents
• validations (array) - Array of Callback
  • Order actions are called in order to complete an action, such as 'Validate'. If provided the action is not completed if the response is not successful (e.g. http status code 400), note however that in case of a time constraint the action might be completed without a successful response.
• hooks (array) - Array of Hook
  • Hooks, added by a separate endpoint.
• notifications (array) - Array of Notification
  • Order notifications are called after an event has occurred, such as order reaching 'Completed' state.
• total
  • Order total including shipping fees
• attributes (object)
  • Allows you to store any custom attributes for the order.

OrderListOrderBy

OrderListOrderByDirection

OrderPaginationSet

Properties

• data (array) - Array of Order
  • Data set of requested orders
• pagination
  • Pagination meta data

OrderStatus

OrderVersion

Pagination

Properties

• offset (integer)
  • Query offset
• limit (integer)
  • Query limit
• size (integer)
  • Results count, after filtering
• valueSum (number)
  • Sum of values, after filtering, Amount in major unit currency.
• totalSize (integer)
  • Total size of available set

Payment

Properties

• id (string)
  • Unique ID of the payment.
  • Example: "p_KBiXuYjvYxsezKCQAMuuSKGDaT"
• adapterId (string)
  • Adapter ID
  • Example: "klarna-checkout"
• name (string)
  • Payment service provider name
• merchant (string)
  • Merchant identifier.
  • Example: "norce"
• channel (string)
  • Merchant channel.
• currency (string)
  • Currency of the purchase. ISO 4217 alpha-3.
  • Example: "SEK"
• type
  • Type of payment.
  • Example: "default"
• orderId (string)
  • ID of the order.
  • Example: "o_DhZSbDfVzNzuxOzHyCFskzGzaJ"
• amount (number)
  • The amount to be covered by the payment. Amount in major unit currency.
  • Example: 10
• upperLimitAmount (number)
  • The upper limit to be used by this payment. For example the amount available on a voucher. Amount in major unit currency.
  • Example: 100
• state
  • The state of the payment.
  • Example: "Intent"
• reference (string)
  • External reference to payment service provider.
  • Example: "7d31e2cf-2d46-4db0-b87d-d65dfaae298f"
• attributes (object)
  • Allows you to store any custom attributes for the payment.
• actions (array) - Array of PaymentAction
  • After payment actions
• recurring
  • Information about a recurring payment used for processing repeated purchases.

PaymentAction

Properties

• id (string)
• adapterId (string) required
• type (string) required
• url (string) required

PaymentEvent

PaymentState

PaymentTransaction

Properties

• event
  • Event that triggered the transaction.
• pspEvent (string)
  • Payment service provider event.
• amount (number)
  • Amount after transaction. Amount in major unit currency.
• isSuccess (boolean)
  • Indicated whether the transaction was successful.
• errorDetail (string)
  • Message detailing the error.
• pspStatus (string)
  • Payment service provider status.
• requestJson (string)
  • Transaction request. Must be a valid json.
• responseJson (string)
  • Transaction response. Must be a valid json.
• created (string)
  • DateTime when transaction was posted.
• paymentAction
  • Payment Action

PaymentType

PickupLocation

Properties

• reference (string)
  • Pickup location reference.
• name (string)
  • Name of pickup location.
• address
  • Pickup location address.

PickupLocationAddress

Properties

• streetAddress (string)
  • Address or street name, first line.
  • Example: "Adaptivevägen 18"
• city (string)
  • City.
  • Example: "Boden"
• postalCode (string)
  • Postal code, zip or post code.
  • Example: "955 60"
• country (string)
  • Country. ISO 3166 alpha-2.
  • Example: "SE"

Price

Properties

• includingVat (number)
  • Total price including vat in the checkout specified currency. Amount in major unit currency.
  • Example: 1234
• excludingVat (number)
  • Total price excluding vat in the checkout specified currency. Amount in major unit currency.
  • Example: 987.2

Product

Properties

• reference (string)
  • Product reference.
• name (string)
  • Carrier product name.

ProductType

Recurring

Properties

• token (string) required
• description (string)
• attributes (object)

Shipping

Properties

• id (string)
  • Unique identifier for the shipping.
  • Example: "s_pmHreuEBboeezpixrHMDPQlazU"
• merchant (string)
  • Merchant identifier.
  • Example: "norce"
• channel (string)
  • Channel identifier
  • Example: "1"
• state
  • Current state of the shipping.
• reference (string)
  • External reference to shipping.
  • Example: "e8ed2091-c34c-4837-a3a8-bc827b0dc183"
• tmsReference (string)
  • TMS Reference.
  • Example: "a935a628-f70c-47a4-a9f6-98c6d08c2ba3"
• orderId (string)
  • ID of the order.
  • Example: "o_DhZSbDfVzNzuxOzHyCFskzGzaJ"
• adapterId (string)
  • Adapter ID
  • Example: "ingrid-shipping-adapter"
• name (string)
  • Descriptive name of the shipping.
  • Example: "PostNord MyPack Home"
• total required
  • Total price of the shipping.
• vatRate (number) required
  • Value-added tax. 25% would be input as 0.25.
  • Example: 0.25
• deliveryDetails
  • Delivery details.
• addons (array) - Array of Addon
  • Shipping addons.
• attributes (object)
  • Allows you to store any custom attributes for the shipping.

ShippingState

State

Properties

• currentStatus
  • State of the order.
• transitions (array) - Array of Transition
  • State transitions.

Transition

Properties

• status
  • State of the order.
• timeStamp (string)
  • UTC Time when state was set.

ValidationError

Properties

• code (string)
• adapterId (string)