COMMERCE SERVICES

Shopping Service

List baskets by status

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

Get a basket

Request

Gets a Basket by id. Returns null if not found.

Query

idinteger(int32)

The basket id of the Basket to fetch.

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/GetBasket \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

Idinteger or null(int32)

The internal id of the basket. Used to get a specific basket. Ignored in CreateBasket.

CustomerIdinteger or null(int32)

The customer internal id for a specific customer associated with this basket. This can be set in CreateBasket if the user is logged in. Otherwise use UpdateBuyer to set customer.

CompanyIdinteger or null(int32)

The company internal id for a specific company associated with this basket. This can be set in CreateBasket if the user is logged in with a company. Otherwise use UpdateBuyer to set customer and company.

SalesContactIdinteger or null(int32)

StatusIdinteger or null(int32)

Internal id for the current status of the basket. See ListBasketStatuses.

CurrencyIdinteger or null(int32)

The currency internal id of the basket. This defines the currency used when processing payments. Can be set when creating a Basket or change later with UpdateBasket. Use either CurrencyId or CurrencyCode. If not specified, the default for the Application will be used.

CurrencyCodestring or null[ 0 .. 3 ] characters

The CurrencyCode of the basket. This defines the currency used when processing payments. Can be set when creating a Basket or change later with UpdateBasket. Use either CurrencyId or CurrencyCode. If not specified, the default for the Application will be used. MaxLength: 3

Commentstring or null[ 0 .. 250 ] characters

Free text comment that will be propagated to the order. MaxLength: 250

OrderReferencestring or null[ 0 .. 50 ] characters

An OrderReference which will be tagged on the order. Can be set in CreateBasket or updated in UpdateBasket. MaxLength: 50

DiscountCodestring or null

A comma separated list of used discount codes. To clear the value set it to null or String.Empty an call UpdateBasket.

ReferIdinteger or null(int32)

ReferUrlstring or null[ 0 .. 255 ] characters

MaxLength: 255

ValidTostring or null(date-time)

IsEditableboolean or null

Specifies if the basket is editable. If not, any method that changes the basket will throw Exceptions (Bad Request). It will be false when the basket is no longer a basket. That is when it's paid for or cancelled.

ItemsArray of objects or null(BasketItem)

List of the items in the basket.

InfoArray of objects or null(ExtraInfo)

List of information types with values that may be propagated on the order.

Summaryobject or null

The Summary is a grouping of BasketItem totals. This can be used to display summaries for a Basket.

AppliedPromotionsArray of objects or null(Promotion)

Contains all Promotions valid for a Basket, whether or not they are applied. If any promotions are applied more info about them are added to the corresponding Basket.Items.

IpAddressstring or null[ 0 .. 50 ] characters

The user's IpAddress when the basket was created. The value should be fetched from the user request to the application. MaxLength: 50

AttestedByinteger or null(int32)

TypeIdinteger or null(int32)

The internal type id of the Basket. Can be 1 = Basket, 2 = Saved Basket, 3 = Template Basket for Subscriptions.

DoHoldboolean or null

DoHold specifies if the resulting order should be on hold until all items on the order can be shipped or not. Default is false. This can be set in the Checkout with UpdateBasket if the Customer does not want part deliveries.

IsBuyableboolean or null

IsBuyable is a rule based property indicating if the Basket's status allows the basket to be purchased. It should be regarded as readonly.

InvoiceReferencestring or null[ 0 .. 50 ] characters

An InvoiceReference which will be tagged on the order. Can be set in CreateBasket or updated in UpdateBasket. MaxLength: 50

PaymentMethodIdinteger or null(int32)

The PaymentMethodId from Norce. Can be set in CreateBasket or updated in UpdatePaymentMethod.

DeliveryMethodIdinteger or null(int32)

The DeliveryMethodId from Norce. Can be set in CreateBasket or updated in UpdateDeliveryMethod.

SalesAreaIdinteger or null(int32)

The SalesArea internal id of the basket. This defines the default VAT-rate used. Can be set when creating a Basket or change later with UpdateBasket. If not specified, the default for the Application will be used.

ExternalDiscountCodestring or null

A comma separated list of used external discount codes. To clear the value set it to null or String.Empty and call UpdateBasket.

Response

application/json

{
  "Id": 0,
  "CustomerId": 0,
  "CompanyId": 0,
  "SalesContactId": 0,
  "StatusId": 0,
  "CurrencyId": 0,
  "CurrencyCode": "str",
  "Comment": "string",
  "OrderReference": "string",
  "DiscountCode": "string",
  "ReferId": 0,
  "ReferUrl": "string",
  "ValidTo": "2019-08-24T14:15:22Z",
  "IsEditable": true,
  "Items": [
    { … }
  ],
  "Info": [
    { … }
  ],
  "Summary": {
    "Items": { … },
    "Freigt": { … },
    "Fees": { … },
    "Total": { … }
  },
  "AppliedPromotions": [
    { … }
  ],
  "IpAddress": "string",
  "AttestedBy": 0,
  "TypeId": 0,
  "DoHold": true,
  "IsBuyable": true,
  "InvoiceReference": "string",
  "PaymentMethodId": 0,
  "DeliveryMethodId": 0,
  "SalesAreaId": 0,
  "ExternalDiscountCode": "string"
}

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

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"
  }
]

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

Norce Commerce Shopping v1.1 service (1.1)

Basket

Get a basket

Request

Responses

Did the information on the page help you?

List baskets by status

Request

Responses

Did the information on the page help you?

List saved baskets for a customer

Request

Responses

Did the information on the page help you?

Checkout

DeliveryMethods

InfoTypes

OnHand

OrderRequest

Payments

Promotions

Schemas