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
Languages
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

List baskets by status

Request

Returns a paged basket list for specified customer, company or sales contact.

Query
companyIdstring

(Optional) The internal company id for which baskets are fetched. Either this a customerId or salesContactId must be specified.

customerIdstring

(Optional) The internal customer id for which baskets are fetched. Either this a companyId or salesContactId must be specified.

salesContactIdstring

(Optional) The internal salesContact id for which baskets are fetched. Either this a companyId or customerId must be specified.

statusIdinteger(int32)

The internal id for the status to fetch.

pageNostring

(Optional) Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

(Optional) Number of items to display per page. Mandatory if using pageNo.

pricelistSeedstring

(Optional) A comma separated list of internal pricelist ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

currencyIdstring

(Optional) Internal id that specifies in which currency to display prices. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/ListBasketsByStatus \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
ItemCountinteger or null(int32)

Total number of baskets.

ItemsArray of objects or null(Basket)

List of baskets.

Response
application/json
{ "ItemCount": 0, "Items": [ {} ] }

List saved baskets for a customer

Request

List saved baskets for a specific customer

Query
customerIdinteger(int32)

The internal customer id of the customer. The id is used to fetch saved baskets.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/ListSavedBaskets \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/jsonArray [
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.

]
Response
application/json
[ { "Id": 0, "Name": "string", "Created": "2019-08-24T14:15:22Z", "CustomerId": 0, "ValidTo": "2019-08-24T14:15:22Z" } ]

Save a basket

Request

Save a initiated basket

Query
customerIdinteger(int32)

The internal customer id of the customer. The id is used to fetch saved baskets.

basketIdinteger(int32)

The internal id of the basket to save.

namestring

The name of the saved basket.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/SaveBasket \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
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.

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

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