COMMERCE SERVICES
/
Shopping Service
/
Schemas
/
ProductsOnHand

Documentation ShoppingService (1.1)

Entities and methods to handle baskets and payments.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/

Schemas

ProductsFlag

Idinteger(int32)

The internal Id of the Flag.

Namestring

The Name of the Flag. MaxLength: 50.

TypeIdinteger(int32)

The Type of the Flag. ProductFlags have TypeId = 1 and VariantFlags have TypeId = 2.

GroupIdinteger(int32)

The GroupId of the Flag. This value is client specific and can be used to group product flags.

Descriptionstring

The Description of the Flag. MaxLength: 500.

Codestring

The external Code for the flag. MaxLength: 500.

{
  "Id": 0,
  "Name": "string",
  "TypeId": 0,
  "GroupId": 0,
  "Description": "string",
  "Code": "string"
}

ProductsOnHand

Valuenumber(decimal)

The aggregated value from all warehouses and locations in the current context (Web, Supplier or Store).

IncomingValuenumber(decimal)

The incoming quantity on the next delivery.

NextDeliveryDatestring or null(date-time)

The next delivery data from supplier to client warehouse.

LeadtimeDayCountinteger or null(int32)

The number of days it takes to ship from the supplier.

LastCheckedstring or null(date-time)

When onHand info was last checked. Null if never.

IsActiveboolean

Indicate if the product is stocked in a store.

IsReturnableboolean

Indicate if the product is returnable in a store.

InfoArray of objects(IdValue)(IdValue)

List of IdValues for the OnHand data for this sku warehouse location combination. This will always be null unless fetched with any of the ProductOnHand methods.

{
  "Value": 0,
  "IncomingValue": 0,
  "NextDeliveryDate": "2019-08-24T14:15:22Z",
  "LeadtimeDayCount": 0,
  "LastChecked": "2019-08-24T14:15:22Z",
  "IsActive": true,
  "IsReturnable": true,
  "Info": [
    { … }
  ]
}

ProductsProductOnHand

ProductIdinteger(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(ProductsWarehouse)(ProductsWarehouse)

A list of warehouses with OnHand for the product.

VariantsArray of objects(ProductsProductOnHand)(ProductsProductOnHand)

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

{
  "ProductId": 0,
  "Warehouses": [
    { … }
  ],
  "Variants": [
    {}
  ]
}

Basket

Operations

Checkout

Operations

DeliveryMethods

Operations

InfoTypes

Operations

OnHand

Operations

OrderRequest

Operations

Payments

Operations

Promotions

Operations

Subscriptions

Operations