COMMERCE SERVICES
/
Shopping Service
/
OnHand

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

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

List availability on products in basket

Request

Lists OnHand data based on basket items. Only deliverable items will be regarded. The result is a list of ProductOnHand where each product has a list of warehoues matching the warehouse specification passed in. ProductOnHand.Variants will always be null when getting this data for a basket. OnHand for each warehouse will always be returned whether or not the warehouse has the item or not. OnHand.IsActive = false indicates the item does not exist at the warehouse so only active OnHands should be used when checking availability.

Query
basketIdinteger(int32)

The internal basket id.

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) Ignored.

Bodyapplication/json

(Optional) An Warehouse if OnHand for a specific store is wanted. If standard warehouse (web) is wanted just pass null.

StoreIdinteger or null(int32)

The store internal id for the current store. Can be null if WarehouseId and LocationId are supplied.

WarehouseIdinteger or null(int32)

The internal id for the warehouse. Can be null if StoreId is supplied.

LocationIdinteger or null(int32)

The internal id for the warehouse location. Can be null if StoreId is supplied.

OnHandobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/ListProductOnHandByBasket \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "StoreId": 0,
    "WarehouseId": 0,
    "LocationId": 0,
    "OnHand": {
      "Value": 0,
      "IncomingValue": 0,
      "NextDeliveryDate": "2019-08-24T14:15:22Z",
      "LeadtimeDayCount": 0,
      "LastChecked": "2019-08-24T14:15:22Z",
      "IsActive": true,
      "IsReturnable": true,
      "Info": [
        {
          "Id": 0,
          "Value": "string",
          "Code": "string"
        }
      ]
    }
  }'

Responses

Success

Bodyapplication/jsonArray [
ProductIdinteger or null(int32)

The product internal id for the current product/variant. If the entity is fetched by productId it will be that productId. If the product is fetched by partNo it will be the productId for that variant.

WarehousesArray of objects or null(Warehouse)

A list of warehouses with OnHand for the product.

VariantsArray of objects or null(ProductOnHand)

An optional list of ProductOnHand for all variants if fetched by productId. Null when fetched for a variant or a basket.

]
Response
application/json
[
  {
    "ProductId": 0,
    "Warehouses": [ … ],
    "Variants": [ … ]
  }
]

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