COMMERCE SERVICES

Shopping Service

PurchaseEx2Data

Norce Commerce Shopping v1.1 service (1.1)

Entities and methods to handle baskets and payments. The Shopping service is used to create and manage baskets, and prepare them for the checkout process. Commonly the checkout process is handled by the Norce Checkout API, only the legacy checkout process is handled here. For product or pricing data, use the Product service. For order history, use the Order service. To change or manage promotions use the Management API.

Download OpenAPI description

openapi-v1.json

openapi-v1.yaml

Servers

Playground

https://{slug}.api-se.playground.norce.tech/commerce/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/

Production

https://{slug}.api-se.norce.tech/commerce/

Basket

Contains endpoints for manage baskets and their lifecycle, see more information here.

Operations

Checkout

Contains endpoints for initialized the checkout process, read more about it here. There is also the old legacy purchase endpoints, still used by older solutions and Non-PSP purchases.

Operations

DeliveryMethods

Contains endpoints for viewing metadata about configured delivery methods, when using Norces internal shipping logic.

Operations

InfoTypes

Contains endpoints for viewing metadata for extended fields on the basket and basketitems.

Operations

OnHand

Contains endpoints for looking up availability on baskets.

Operations

OrderRequest

Contains endpoints for viewing orders snapshots.

Operations

Payments

Contains endpoints for legacy purchases, still used by older solutions and Non-PSP purchases.

Operations

Promotions

Contains endpoints for viewing more promotion information.

Operations

Schemas

PromotionProductFilter

PromotionProductFilter shows what any product in the requirement or effect is filtered by. Values should be AND:ed if used to filter products.

ManufacturerIdinteger or null(int32)

An optional Manufacturer internal id for filtered products.

CategorySeedstring or null

An optional CategorySeed for filtered products.

TypeIdinteger or null(int32)

An optional SKU Type internal id for filtered products.

ProductIdinteger or null(int32)

An optional Product internal id for filtered products.

VariantProductIdinteger or null(int32)

An optional VariantProduct internal id for filtered products. Equal to use PartNo.

PartNostring or null

An optional PartNo for filtered products. Equal to use VariantProductId.

PricelistIdinteger or null(int32)

An optional pricelist internal id for filtered products.

FlagIdinteger or null(int32)

An optional Flag internal id for filtered products. Only set if flagId is inclusive.

{
  "ManufacturerId": 0,
  "CategorySeed": "string",
  "TypeId": 0,
  "ProductId": 0,
  "VariantProductId": 0,
  "PartNo": "string",
  "PricelistId": 0,
  "FlagId": 0
}

PurchaseEx2Data

Used as input to PurchaseEx2 since WCF cannot take more than one complex type at once as parameter.

Checkoutobject or null

Used to connect a specific basket with customer information, payment and delivery options.

PaymentParametersArray of objects or null(NameValue)

General: 'test'=true to enable tests. When 'test' is used no payments will be processed for real. Payments may interpret supplied values such as cardNumber or ssn to simulate failures. Not implemented. Klarna: 'sessionId'=id. Used to provide a sessionId to Klarna payments. Not implemented. Payex and Dibs. Supported values are 'returnUrl' and 'cancelUrl'. Values should point to where the payment service should go in case of success/failure.

{
  "Checkout": {
    "Basket": { … },
    "Buyer": { … },
    "Payer": { … },
    "ShipTo": { … },
    "PaymentMethods": [ … ],
    "DeliveryMethods": [ … ],
    "Payments": [ … ]
  },
  "PaymentParameters": [
    { … }
  ]
}

SavedBasket

Idinteger or null(int32)

Internal id of the saved basket.

Namestring or null

Name given to this specific saved basket.

Createdstring or null(date-time)

Creation date.

CustomerIdinteger or null(int32)

Internal customer id of associated customer, if any.

ValidTostring or null(date-time)

Valid date, if any.

{
  "Id": 0,
  "Name": "string",
  "Created": "2019-08-24T14:15:22Z",
  "CustomerId": 0,
  "ValidTo": "2019-08-24T14:15:22Z"
}