checkout-svea-adapter-env.ci.jetshopcloud.io Open in urlscan Pro
20.76.203.228 Public Scan

Back to summary
Submitted URL:
https://checkout-svea-adapter-env.ci.jetshopcloud.io/
Effective URL:
https://checkout-svea-adapter-env.ci.jetshopcloud.io/docs/v1/index.html
Submission: On March 24 via api (March 24th 2024, 2:58:22 pm UTC) from US — Scanned from US
Form analysis
0 forms found in the DOM

Text Content

 * Svea Administration
   * postSet nShift configuration
   * getGet nShift configuration
 * Payments
   * postCreate a new Svea Checkout order
   * getGet an existing Svea Checkout order
   * postRemove a Svea Checkout order
 * Svea Checkout Callbacks
   * getValidation
   * postPush
   * postWebhook
 * Svea Checkout 'Client-side events' Callbacks
   * postRefresh customer information on Norce order from svea order
   * postShipping option update. The Norce order will be updated with the latest
     selected delivery information from svea
 * Norce Callbacks
   * postHandle Cart changed
   * postHandle State changed
 * Order Management
   * getGet an existing Svea Payment Administration order
   * postRefresh the list of available PaymentActions for an order
   * postCapture order
   * postCancel order
   * postRefund order

API docs by Redocly





NORCE CHECKOUT - SVEA CHECKOUT ADAPTER API (1.0.0)

Download OpenAPI specification:Download




Build 2024-03-23 11:03:09

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


SVEA ADMINISTRATION


SET NSHIFT CONFIGURATION

The Svea Checkout Shipping Module requires a few values in order to establish a
proper integration with nShift. The onboarding endpoint is utilized for a
one-time setup or when changes occur in your nshift credentials.

HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier

REQUEST BODY SCHEMA: APPLICATION/JSON

nShift onboarding information

NshiftCombinedId
string

NshiftDeliveryCheckoutId
string



RESPONSES

200

Success

400

Bad Request

post/api/checkout/v1/admin/shipping/onboarding

Test server

https://checkout-svea-adapter.test.norce.tech/api/checkout/v1/admin/shipping/onboarding


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
{
 * "NshiftCombinedId": "string",
 * "NshiftDeliveryCheckoutId": "string"

}


GET NSHIFT CONFIGURATION

nShift configuration values used to establish a proper integration with nShift
within Svea checkout.

HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier


RESPONSES

200

Success

RESPONSE SCHEMA: APPLICATION/JSON

id
integer <int64>

accessToken
string

deliveryCheckoutId
string


400

Bad Request

get/api/checkout/v1/admin/shipping/onboarding

Test server

https://checkout-svea-adapter.test.norce.tech/api/checkout/v1/admin/shipping/onboarding


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
{
 * "id": 0,
 * "accessToken": "string",
 * "deliveryCheckoutId": "string"

}


PAYMENTS


CREATE A NEW SVEA CHECKOUT ORDER

Requires an existing Norce order.

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string


HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier


RESPONSES

200

Success

RESPONSE SCHEMA: APPLICATION/JSON

paymentId
string

Norce Payment Id

htmlSnippet
string

Svea checkout order html snippet.

400

Bad Request

RESPONSE SCHEMA: APPLICATION/JSON

code
string
Enum: "internal-server-error" "unauthorized" "configuration-error"
"configuration-not-found" "order-not-found" "order-error" "order-bad-request"
"order-conflict" "order-validation" "shipping-not-found" "shipping-error"
"payment-not-found" "payment-error" "payment-conflict" "svea-error"
"svea-bad-request" "svea-validation" "svea-order-not-found"
"translation-not-found"

Error code

message
string

Detailed error information

sveaError
object

Error if originating from Svea

404

Not Found

409

Conflict

RESPONSE SCHEMA: APPLICATION/JSON

code
string
Enum: "internal-server-error" "unauthorized" "configuration-error"
"configuration-not-found" "order-not-found" "order-error" "order-bad-request"
"order-conflict" "order-validation" "shipping-not-found" "shipping-error"
"payment-not-found" "payment-error" "payment-conflict" "svea-error"
"svea-bad-request" "svea-validation" "svea-order-not-found"
"translation-not-found"

Error code

message
string

Detailed error information

sveaError
object

Error if originating from Svea

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

Test server

https://checkout-svea-adapter.test.norce.tech/api/checkout/v1/orders/{order_id}/payments


RESPONSE SAMPLES

 * 200
 * 400
 * 409

Content type
application/json
Copy
{
 * "paymentId": "string",
 * "htmlSnippet": "string"

}




GET AN EXISTING SVEA CHECKOUT ORDER

Used to get the html snippet, for example after the Svea Checkout Order has been
confirmed.

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier


RESPONSES

200

Success

RESPONSE SCHEMA: APPLICATION/JSON

paymentId
string

Norce Payment Id

htmlSnippet
string

Svea checkout order html snippet.

404

Not Found

get/api/checkout/v1/orders/{order_id}/payments/{payment_id}

Test server

https://checkout-svea-adapter.test.norce.tech/api/checkout/v1/orders/{order_id}/payments/{payment_id}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
{
 * "paymentId": "string",
 * "htmlSnippet": "string"

}


REMOVE A SVEA CHECKOUT ORDER

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
a Svea Checkout order.

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier


RESPONSES

200

Success

400

Bad Request

RESPONSE SCHEMA: APPLICATION/JSON

code
string
Enum: "internal-server-error" "unauthorized" "configuration-error"
"configuration-not-found" "order-not-found" "order-error" "order-bad-request"
"order-conflict" "order-validation" "shipping-not-found" "shipping-error"
"payment-not-found" "payment-error" "payment-conflict" "svea-error"
"svea-bad-request" "svea-validation" "svea-order-not-found"
"translation-not-found"

Error code

message
string

Detailed error information

sveaError
object

Error if originating from Svea

401

Unauthorized

RESPONSE SCHEMA: APPLICATION/JSON

code
string
Enum: "internal-server-error" "unauthorized" "configuration-error"
"configuration-not-found" "order-not-found" "order-error" "order-bad-request"
"order-conflict" "order-validation" "shipping-not-found" "shipping-error"
"payment-not-found" "payment-error" "payment-conflict" "svea-error"
"svea-bad-request" "svea-validation" "svea-order-not-found"
"translation-not-found"

Error code

message
string

Detailed error information

sveaError
object

Error if originating from Svea

404

Not Found

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

Test server

https://checkout-svea-adapter.test.norce.tech/api/checkout/v1/orders/{order_id}/payments/{payment_id}/remove


RESPONSE SAMPLES

 * 400
 * 401

Content type
application/json
Copy
Expand all Collapse all
{
 * "code": "cart-not-found",
 * "message": "Cart with id:{id} now found.",
 * "sveaError": {
    * "errorCode": "string",
    * "errorMessages": [
       * "string"
      
      ],
    * "correlationId": "string"
   
   }

}



SVEA CHECKOUT CALLBACKS


VALIDATION

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

QUERY PARAMETERS

merchant
required
string

Merchant identifier

channel
required
string

Merchant channel


RESPONSES

200

Success

RESPONSE SCHEMA: APPLICATION/JSON

valid
boolean

clientOrderNumber
string

message
string


400

Bad Request

RESPONSE SCHEMA: APPLICATION/JSON

valid
boolean

clientOrderNumber
string

message
string


get/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/validation

Test server

https://checkout-svea-adapter.test.norce.tech/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/validation


RESPONSE SAMPLES

 * 200
 * 400

Content type
application/json
Copy
{
 * "valid": true,
 * "clientOrderNumber": "string",
 * "message": "string"

}



PUSH

Called whenever a Svea order’s CheckoutOrderStatus is changed

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

QUERY PARAMETERS

merchant
required
string

Merchant identifier

channel
required
string

Merchant channel


RESPONSES

200

Success

post/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/push

Test server

https://checkout-svea-adapter.test.norce.tech/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/push


WEBHOOK

When an Svea Checkout order has been finalized, the callback will be fired by
Svea to notify the merchant about example any booked shipments

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

QUERY PARAMETERS

merchant
required
string

Merchant identifier

channel
required
string

Merchant channel

REQUEST BODY SCHEMA: APPLICATION/JSON

Webhook information

type
string

description
string

orderId
integer <int64>



RESPONSES

200

Success

post/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/webhook

Test server

https://checkout-svea-adapter.test.norce.tech/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/webhook


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
{
 * "type": "string",
 * "description": "string",
 * "orderId": 0

}


SVEA CHECKOUT 'CLIENT-SIDE EVENTS' CALLBACKS


REFRESH CUSTOMER INFORMATION ON NORCE ORDER FROM SVEA ORDER

Updates customer information on Norce order with latest customer information
from Svea Checkout

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

QUERY PARAMETERS

merchant
required
string

Merchant identifier

channel
required
string

Merchant channel


RESPONSES

200

Success

post/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/customer-update

Test server

https://checkout-svea-adapter.test.norce.tech/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/customer-update


SHIPPING OPTION UPDATE. THE NORCE ORDER WILL BE UPDATED WITH THE LATEST SELECTED
DELIVERY INFORMATION FROM SVEA

Shipping option updated notifications. Will update the Norce order with latest
shipping selection from svea

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

QUERY PARAMETERS

merchant
required
string

Merchant identifier

channel
required
string

Merchant channel

REQUEST BODY SCHEMA: APPLICATION/JSON

Payload from client-side iframe event

id
string

location
object

orderId
string

name
string

carrier
string

totalShippingFee
integer <int64>



RESPONSES

200

Success

post/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/shipping-option-update

Test server

https://checkout-svea-adapter.test.norce.tech/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/shipping-option-update


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
Expand all Collapse all
{
 * "id": "string",
 * "location": {
    * "id": "string",
    * "name": "string",
    * "address": {
       * "city": "string",
       * "countryCode": "string",
       * "postalCode": "string",
       * "streetAddress": "string",
       * "streetAddress2": "string"
      
      }
   
   },
 * "orderId": "string",
 * "name": "string",
 * "carrier": "string",
 * "totalShippingFee": 0

}


NORCE CALLBACKS


HANDLE CART CHANGED

Cart changed.

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier

REQUEST BODY SCHEMA: APPLICATION/JSON

Updated order

id
string

merchant
string

channel
string

reference
string

created
string <date-time>

lastModified
string <date-time>

state
object

culture
string

currency
string

country
string

cart
object

shippings
Array of objects (Shipping)

payments
Array of objects (Payment)

customer
object

consents
Array of objects (Consent)

hooks
Array of objects (Hook)

total
object

attributes
object



RESPONSES

200

Success

RESPONSE SCHEMA: APPLICATION/JSON

Array

op
string

path
string

value
any



404

Not Found

post/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/cart-changed

Test server

https://checkout-svea-adapter.test.norce.tech/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/cart-changed


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
Expand all Collapse all
{
 * "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",
          * "url": "string",
          * "imageUrl": "string",
          * "quantity": 0,
          * "unit": "string",
          * "price": {
             * "includingVat": 0,
             * "excludingVat": 0
            
            },
          * "total": {
             * "includingVat": 0,
             * "excludingVat": 0
            
            },
          * "originalTotal": {
             * "includingVat": 0,
             * "excludingVat": 0
            
            },
          * "vatRate": 0,
          * "discounts": [
             * {
                * "type": "item",
                * "name": "string",
                * "code": "string",
                * "value": {
                   * "includingVat": 0,
                   * "excludingVat": 0
                  
                  },
                * "attributes": {
                   * "property1": null,
                   * "property2": null
                  
                  }
               
               }
            
            ],
          * "attributes": {
             * "property1": null,
             * "property2": null
            
            }
         
         }
      
      ],
    * "discounts": [
       * {
          * "type": "item",
          * "name": "string",
          * "code": "string",
          * "value": {
             * "includingVat": 0,
             * "excludingVat": 0
            
            },
          * "attributes": {
             * "property1": null,
             * "property2": null
            
            }
         
         }
      
      ],
    * "total": {
       * "includingVat": 0,
       * "excludingVat": 0
      
      },
    * "attributes": {
       * "property1": null,
       * "property2": null
      
      }
   
   },
 * "shippings": [
    * {
       * "id": "string",
       * "merchant": "string",
       * "channel": "string",
       * "state": "intent",
       * "reference": "string",
       * "tmsReference": "string",
       * "orderId": "string",
       * "adapterId": "string",
       * "name": "string",
       * "total": {
          * "includingVat": 0,
          * "excludingVat": 0
         
         },
       * "vatRate": 0,
       * "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
            
            }
         
         ],
       * "attributes": {
          * "property1": null,
          * "property2": null
         
         }
      
      }
   
   ],
 * "payments": [
    * {
       * "id": "string",
       * "adapterId": "string",
       * "name": "string",
       * "merchant": "string",
       * "channel": "string",
       * "currency": "string",
       * "type": "default",
       * "orderId": "string",
       * "amount": 0,
       * "upperLimitAmount": 0,
       * "state": "intent",
       * "reference": "string",
       * "attributes": {
          * "property1": null,
          * "property2": null
         
         },
       * "actions": [
          * {
             * "id": "string",
             * "adapterId": "string",
             * "type": "string",
             * "url": "string"
            
            }
         
         ]
      
      }
   
   ],
 * "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",
       * "subscribeTo": "string",
       * "target": "string",
       * "invoke": "string"
      
      }
   
   ],
 * "total": {
    * "includingVat": 0,
    * "excludingVat": 0
   
   },
 * "attributes": {
    * "property1": null,
    * "property2": null
   
   }

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
[
 * {
    * "op": "string",
    * "path": "string",
    * "value": null
   
   }

]


HANDLE STATE CHANGED

State changed.

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier

REQUEST BODY SCHEMA: APPLICATION/JSON

Updated order

id
string

merchant
string

channel
string

reference
string

created
string <date-time>

lastModified
string <date-time>

state
object

culture
string

currency
string

country
string

cart
object

shippings
Array of objects (Shipping)

payments
Array of objects (Payment)

customer
object

consents
Array of objects (Consent)

hooks
Array of objects (Hook)

total
object

attributes
object



RESPONSES

200

Success

RESPONSE SCHEMA: APPLICATION/JSON

Array

op
string

path
string

value
any



404

Not Found

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

Test server

https://checkout-svea-adapter.test.norce.tech/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/state-changed


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
Expand all Collapse all
{
 * "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",
          * "url": "string",
          * "imageUrl": "string",
          * "quantity": 0,
          * "unit": "string",
          * "price": {
             * "includingVat": 0,
             * "excludingVat": 0
            
            },
          * "total": {
             * "includingVat": 0,
             * "excludingVat": 0
            
            },
          * "originalTotal": {
             * "includingVat": 0,
             * "excludingVat": 0
            
            },
          * "vatRate": 0,
          * "discounts": [
             * {
                * "type": "item",
                * "name": "string",
                * "code": "string",
                * "value": {
                   * "includingVat": 0,
                   * "excludingVat": 0
                  
                  },
                * "attributes": {
                   * "property1": null,
                   * "property2": null
                  
                  }
               
               }
            
            ],
          * "attributes": {
             * "property1": null,
             * "property2": null
            
            }
         
         }
      
      ],
    * "discounts": [
       * {
          * "type": "item",
          * "name": "string",
          * "code": "string",
          * "value": {
             * "includingVat": 0,
             * "excludingVat": 0
            
            },
          * "attributes": {
             * "property1": null,
             * "property2": null
            
            }
         
         }
      
      ],
    * "total": {
       * "includingVat": 0,
       * "excludingVat": 0
      
      },
    * "attributes": {
       * "property1": null,
       * "property2": null
      
      }
   
   },
 * "shippings": [
    * {
       * "id": "string",
       * "merchant": "string",
       * "channel": "string",
       * "state": "intent",
       * "reference": "string",
       * "tmsReference": "string",
       * "orderId": "string",
       * "adapterId": "string",
       * "name": "string",
       * "total": {
          * "includingVat": 0,
          * "excludingVat": 0
         
         },
       * "vatRate": 0,
       * "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
            
            }
         
         ],
       * "attributes": {
          * "property1": null,
          * "property2": null
         
         }
      
      }
   
   ],
 * "payments": [
    * {
       * "id": "string",
       * "adapterId": "string",
       * "name": "string",
       * "merchant": "string",
       * "channel": "string",
       * "currency": "string",
       * "type": "default",
       * "orderId": "string",
       * "amount": 0,
       * "upperLimitAmount": 0,
       * "state": "intent",
       * "reference": "string",
       * "attributes": {
          * "property1": null,
          * "property2": null
         
         },
       * "actions": [
          * {
             * "id": "string",
             * "adapterId": "string",
             * "type": "string",
             * "url": "string"
            
            }
         
         ]
      
      }
   
   ],
 * "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",
       * "subscribeTo": "string",
       * "target": "string",
       * "invoke": "string"
      
      }
   
   ],
 * "total": {
    * "includingVat": 0,
    * "excludingVat": 0
   
   },
 * "attributes": {
    * "property1": null,
    * "property2": null
   
   }

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
[
 * {
    * "op": "string",
    * "path": "string",
    * "value": null
   
   }

]


ORDER MANAGEMENT


GET AN EXISTING SVEA PAYMENT ADMINISTRATION ORDER

Used to get the order management (payment admin) order.

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier


RESPONSES

200

Success

RESPONSE SCHEMA: APPLICATION/JSON

actions
Array of strings

billingAddress
object

cancelledAmount
integer <int64>

creationDate
string <date-time>

currency
string

customerReference
string

deliveries
Array of objects (Delivery)

emailAddress
string

id
integer <int64>

isCompany
boolean

merchantOrderId
string

nationalId
string

orderAmount
integer <int64>

orderRows
Array of objects (OrderRow)

orderStatus
string

paymentType
string

peppolId
string

phoneNumber
string

shippingAddress
object

sveaWillBuy
boolean

expirationDate
string <date-time>

billingEmailAddress
string

billingReferences
Array of strings (BillingReference)
Items Enum: "undefined" "purchase" "contactPerson" "invoiceReference"
"costCenter" "invoiceRecipient" "letterNumber" "accountingNumber"

systemStatus
string


404

Not Found

get/api/order/v1/orders/{order_id}/payments/{payment_id}

Test server

https://checkout-svea-adapter.test.norce.tech/api/order/v1/orders/{order_id}/payments/{payment_id}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "actions": [
    * "string"
   
   ],
 * "billingAddress": {
    * "city": "string",
    * "coAddress": "string",
    * "countryCode": "string",
    * "fullName": "string",
    * "postalCode": "string",
    * "streetAddress": "string"
   
   },
 * "cancelledAmount": 0,
 * "creationDate": "2019-08-24T14:15:22Z",
 * "currency": "string",
 * "customerReference": "string",
 * "deliveries": [
    * {
       * "actions": [
          * "canCreditAmount"
         
         ],
       * "creationDate": "2019-08-24T14:15:22Z",
       * "creditedAmount": 0,
       * "credits": [
          * {
             * "actions": [
                * "string"
               
               ],
             * "amount": 0
            
            }
         
         ],
       * "deliveryAmount": 0,
       * "dueDate": "2019-08-24T14:15:22Z",
       * "id": 0,
       * "invoiceId": 0,
       * "orderRows": [
          * {
             * "actions": [
                * "canDeliverRow"
               
               ],
             * "articleNumber": "string",
             * "discountPercent": 0,
             * "discountAmount": 0,
             * "isCancelled": true,
             * "orderRowId": 0,
             * "quantity": 0,
             * "unit": "string",
             * "unitPrice": 0,
             * "vatPercent": 0
            
            }
         
         ],
       * "status": "string"
      
      }
   
   ],
 * "emailAddress": "string",
 * "id": 0,
 * "isCompany": true,
 * "merchantOrderId": "string",
 * "nationalId": "string",
 * "orderAmount": 0,
 * "orderRows": [
    * {
       * "actions": [
          * "canDeliverRow"
         
         ],
       * "articleNumber": "string",
       * "discountPercent": 0,
       * "discountAmount": 0,
       * "isCancelled": true,
       * "orderRowId": 0,
       * "quantity": 0,
       * "unit": "string",
       * "unitPrice": 0,
       * "vatPercent": 0
      
      }
   
   ],
 * "orderStatus": "string",
 * "paymentType": "string",
 * "peppolId": "string",
 * "phoneNumber": "string",
 * "shippingAddress": {
    * "city": "string",
    * "coAddress": "string",
    * "countryCode": "string",
    * "fullName": "string",
    * "postalCode": "string",
    * "streetAddress": "string"
   
   },
 * "sveaWillBuy": true,
 * "expirationDate": "2019-08-24T14:15:22Z",
 * "billingEmailAddress": "string",
 * "billingReferences": [
    * "undefined"
   
   ],
 * "systemStatus": "string"

}


REFRESH THE LIST OF AVAILABLE PAYMENTACTIONS FOR AN ORDER

Refreshes the list of available payment actions on the payment to reflect the
current payment state

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier


RESPONSES

200

Success

400

Bad Request

404

Not Found

post/api/order/v1/orders/{order_id}/payments/{payment_id}/refresh

Test server

https://checkout-svea-adapter.test.norce.tech/api/order/v1/orders/{order_id}/payments/{payment_id}/refresh


CAPTURE ORDER

Used to capture order

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier


RESPONSES

200

Success

400

Bad Request

404

Not Found

post/api/order/v1/orders/{order_id}/payments/{payment_id}/capture

Test server

https://checkout-svea-adapter.test.norce.tech/api/order/v1/orders/{order_id}/payments/{payment_id}/capture


CANCEL ORDER

Used to cancel order

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier


RESPONSES

200

Success

400

Bad Request

404

Not Found

post/api/order/v1/orders/{order_id}/payments/{payment_id}/cancel

Test server

https://checkout-svea-adapter.test.norce.tech/api/order/v1/orders/{order_id}/payments/{payment_id}/cancel


REFUND ORDER

Used to refund a fully captured order

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier


RESPONSES

200

Success

400

Bad Request

404

Not Found

post/api/order/v1/orders/{order_id}/payments/{payment_id}/refund

Test server

https://checkout-svea-adapter.test.norce.tech/api/order/v1/orders/{order_id}/payments/{payment_id}/refund
checkout-svea-adapter-env.ci.jetshopcloud.io Open in urlscan Pro 20.76.203.228 Public Scan

Form analysis 0 forms found in the DOM

Text Content

checkout-svea-adapter-env.ci.jetshopcloud.io Open in urlscan Pro
20.76.203.228 Public Scan

Form analysis
0 forms found in the DOM
