Back

Context

Order

Basket

UserValues

BasketLine

Context

HTTP method URL Description
GET /sessionservices/v1/context Gets current context information
POST /sessionservices/v1/context/changecontext Change the price calculation context. Use null value in properties to reset to default. Note: Changing pricing context may required the shop to be configured to allow this.

Order

HTTP method URL Description
GET /sessionservices/v2/order Gets list of orders for curently logged in customer. If there is no current customer or you do not have permissions, a 404 is returned.
GET /sessionservices/v2/order/{id} Gets order with the specified ID. If no current customer is logged in or you do not have permissions, a 404 is returned.

Basket

HTTP method URL Description
GET /sessionservices/v2/basket Gets visible basket or baskets, depending on shop allows multiple basket
POST /sessionservices/v2/basket Creates a new basket. Note: This will advertently create a session.
GET /sessionservices/v2/basket/{id} Gets the basket with the specified ID. If this basket does not exist, or you do not have permissions, a 404 is returned.
GET /sessionservices/v2/basket/current Gets current basket. If a shop allows multiple baskets, the method returns active basket.
GET /sessionservices/v2/basket/current/coupon List coupons in basket.
POST /sessionservices/v2/basket/current/coupon Adds the coupon to basket and returns a message wether or not it succeeded. A failure adding (if not found, duplicate, already exists etc) will result in a code 400.
DELETE /sessionservices/v2/basket/current/coupon Removes the coupon from basket and returns a message wether or not it succeeded. A failure removing if not found will result in a code 400.
DELETE /sessionservices/v2/basket/current/coupon/{couponId} Removes the coupon from basket and returns a message wether or not it succeeded. A failure removing if not found will result in a code 400.

UserValues

HTTP method URL Description
GET /sessionservices/v2/basket/{id}/uservalues Gets all user values from the basket with the specified ID
POST /sessionservices/v2/basket/{id}/uservalues
DELETE /sessionservices/v2/basket/{id}/uservalues Deletes all user values from a basket with specific ID
GET /sessionservices/v2/basket/{id}/uservalues/{key} Gets a user value by specified key from basket with specified ID
DELETE /sessionservices/v2/basket/{id}/uservalues/{key} Deletes a user value by specified key from current basket
PUT /sessionservices/v2/basket/{id}/uservalues/{key} Updates a user value by specified key from basket with specified ID
GET /sessionservices/v2/basket/current/uservalues Gets all user values from current basket
POST /sessionservices/v2/basket/current/uservalues
DELETE /sessionservices/v2/basket/current/uservalues Deletes all user values from current basket
GET /sessionservices/v2/basket/current/uservalues/{key} Gets a user value by specified key from current basket
DELETE /sessionservices/v2/basket/current/uservalues/{key} Deletes a user value by specified key from current basket

BasketLine

HTTP method URL Description
GET /sessionservices/v2/basket/current/line Gets lines from current basket.
POST /sessionservices/v2/basket/current/line Adds lines to basket and returns all newly created lines from current basket. Accepts an array of BasketLineBody's to allow for modifying multiple lines at once.
PUT /sessionservices/v2/basket/current/line Updates one or more lines in current basket and returns all updated lines.
DELETE /sessionservices/v2/basket/current/line Deletes all lines from current basket, aka empty basket.
DELETE /sessionservices/v2/basket/current/line/{basketLineId} Deletes a line with given ID from current basket.

Context

GET/sessionservices/v1/context

Gets current context information

RESPONSE

ContextResponseBody (complexType)

Name Type
PriceCalculationDate DateTime
PriceListId String
SuspendInventoryCheck Boolean

ContextResponseBody (complexType)

Name Type
PriceCalculationDate DateTime
PriceListId String
SuspendInventoryCheck Boolean

Context

POST/sessionservices/v1/context/changecontext

Change the price calculation context. Use null value in properties to reset to default. Note: Changing pricing context may required the shop to be configured to allow this.

REQUEST PARAMETERS

Parameters FromBody

Name Description Type
complexType ContextChangeRequestBodyShow details

ContextChangeRequestBody (complexType)

Name Type
PriceCalculationDate DateTime
PriceListId String
SuspendInventoryCheck Boolean
Auth String

RESPONSE

ContextChangeRequestBody (complexType)

Name Type
PriceCalculationDate DateTime
PriceListId String
SuspendInventoryCheck Boolean
Auth String

ContextChangeRequestBody (complexType)

Name Type
PriceCalculationDate DateTime
PriceListId String
SuspendInventoryCheck Boolean
Auth String

Order

GET/sessionservices/v2/order

Gets list of orders for curently logged in customer. If there is no current customer or you do not have permissions, a 404 is returned.

REQUEST PARAMETERS

Parameters FromQuery

Name Description Type
include Defines elemets that will be included in response OrderIncludeOptionShow details

OrderIncludeOption (enum)

Name Type
orderlines in specified, the response will contain order lines
sellto in specified, the response will contain sellto information
deliveryaddress in specified, the response will contain delivery address
payments in specified, the response will contain payment information
shipments in specified, the response will contain shipment
parcelcollect in specified, the response will contain cost of parcells
uservalues in specified, the response will contain user values

RESPONSE

DataResponse{List{Order}} (complexType)

Name Type
Data List of Order (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

Order (complexType)

Name Type
Options OrderRequestOptions
OrderId String
PosId String
Barcode String
AccountId Int32
ExtShopId String
ExtShopGroupId String
OrderDate DateTime
OrderDateFormatted String
ExtSalesPersonId String
SalesPersonName String
ExtCustomerId String
CurrencyISO4217a String
CurrencyExchangeRate Decimal
ISO639a3 String
TotalOrderAmount Price
OrderLinesTotalAmount Price
OrderRemarks String
SellTo ExtendedAddress (complexType)
DeliveryAddress BasicAddress (complexType)
Payments List of Payment (complexType)
Shipments List of Shipment (complexType)
ParcelCollect ParcellCollect (complexType)
OrderLines List of OrderLine (complexType)
PriceListID String
PriceCalculationDate DateTime
UserValues List of OrderUserValue (complexType)

ExtendedAddress (complexType)

Name Type
PhoneNumber String
MobilePhoneNo String
Email String
YourReference String
FaxNumber String
EanNumber String
EanAccountNumber String
EanReference String
Name String
Name2 String
Address String
Address2 String
City String
Contact String
PostCode String
County String
CountryId String
CountryName String

BasicAddress (complexType)

Name Type
Name String
Name2 String
Address String
Address2 String
City String
Contact String
PostCode String
County String
CountryId String
CountryName String

ParcellCollect (complexType)

Name Type
ParcelService ParcelService (complexType)
ParcelDestination ParcelDestination (complexType)
ParcelNotification ParcelNotification (complexType)
ParcelInstructions ParcelInstructions (complexType)

ParcelService (complexType)

Name Type
CarrierId String
Barcode String
LocationId String
Service Service (complexType)

Service (complexType)

Name Type
ParcelType String
ShipmentType String

ParcelDestination (complexType)

Name Type
Id String
Name String
Name2 String
Address String
Address2 String
City String
PostCode String
County String
CountryId String
CountryName String

ParcelNotification (complexType)

Name Type
SmsNumber String
EmailAddress String

ParcelInstructions (complexType)

Name Type
LeaveUnattended Boolean
Remarks String
DeliveryDateFormatted String

DataResponse{List{Order}} (complexType)

Name Type
Data List of Order (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

Order (complexType)

Name Type
Options OrderRequestOptions
OrderId String
PosId String
Barcode String
AccountId Int32
ExtShopId String
ExtShopGroupId String
OrderDate DateTime
OrderDateFormatted String
ExtSalesPersonId String
SalesPersonName String
ExtCustomerId String
CurrencyISO4217a String
CurrencyExchangeRate Decimal
ISO639a3 String
TotalOrderAmount Price
OrderLinesTotalAmount Price
OrderRemarks String
SellTo ExtendedAddress (complexType)
DeliveryAddress BasicAddress (complexType)
Payments List of Payment (complexType)
Shipments List of Shipment (complexType)
ParcelCollect ParcellCollect (complexType)
OrderLines List of OrderLine (complexType)
PriceListID String
PriceCalculationDate DateTime
UserValues List of OrderUserValue (complexType)

ExtendedAddress (complexType)

Name Type
PhoneNumber String
MobilePhoneNo String
Email String
YourReference String
FaxNumber String
EanNumber String
EanAccountNumber String
EanReference String
Name String
Name2 String
Address String
Address2 String
City String
Contact String
PostCode String
County String
CountryId String
CountryName String

BasicAddress (complexType)

Name Type
Name String
Name2 String
Address String
Address2 String
City String
Contact String
PostCode String
County String
CountryId String
CountryName String

ParcellCollect (complexType)

Name Type
ParcelService ParcelService (complexType)
ParcelDestination ParcelDestination (complexType)
ParcelNotification ParcelNotification (complexType)
ParcelInstructions ParcelInstructions (complexType)

ParcelService (complexType)

Name Type
CarrierId String
Barcode String
LocationId String
Service Service (complexType)

Service (complexType)

Name Type
ParcelType String
ShipmentType String

ParcelDestination (complexType)

Name Type
Id String
Name String
Name2 String
Address String
Address2 String
City String
PostCode String
County String
CountryId String
CountryName String

ParcelNotification (complexType)

Name Type
SmsNumber String
EmailAddress String

ParcelInstructions (complexType)

Name Type
LeaveUnattended Boolean
Remarks String
DeliveryDateFormatted String

Order

GET/sessionservices/v2/order/{id}

Gets order with the specified ID. If no current customer is logged in or you do not have permissions, a 404 is returned.

REQUEST PARAMETERS

Parameters FromUri

Name Description Type
id String

Parameters FromQuery

Name Description Type
include Defines elemets that will be included in response OrderIncludeOptionShow details

OrderIncludeOption (enum)

Name Type
orderlines in specified, the response will contain order lines
sellto in specified, the response will contain sellto information
deliveryaddress in specified, the response will contain delivery address
payments in specified, the response will contain payment information
shipments in specified, the response will contain shipment
parcelcollect in specified, the response will contain cost of parcells
uservalues in specified, the response will contain user values

RESPONSE

DataResponse{Order} (complexType)

Name Type
Data Order (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

Order (complexType)

Name Type
Options OrderRequestOptions
OrderId String
PosId String
Barcode String
AccountId Int32
ExtShopId String
ExtShopGroupId String
OrderDate DateTime
OrderDateFormatted String
ExtSalesPersonId String
SalesPersonName String
ExtCustomerId String
CurrencyISO4217a String
CurrencyExchangeRate Decimal
ISO639a3 String
TotalOrderAmount Price
OrderLinesTotalAmount Price
OrderRemarks String
SellTo ExtendedAddress (complexType)
DeliveryAddress BasicAddress (complexType)
Payments List of Payment (complexType)
Shipments List of Shipment (complexType)
ParcelCollect ParcellCollect (complexType)
OrderLines List of OrderLine (complexType)
PriceListID String
PriceCalculationDate DateTime
UserValues List of OrderUserValue (complexType)

ExtendedAddress (complexType)

Name Type
PhoneNumber String
MobilePhoneNo String
Email String
YourReference String
FaxNumber String
EanNumber String
EanAccountNumber String
EanReference String
Name String
Name2 String
Address String
Address2 String
City String
Contact String
PostCode String
County String
CountryId String
CountryName String

BasicAddress (complexType)

Name Type
Name String
Name2 String
Address String
Address2 String
City String
Contact String
PostCode String
County String
CountryId String
CountryName String

ParcellCollect (complexType)

Name Type
ParcelService ParcelService (complexType)
ParcelDestination ParcelDestination (complexType)
ParcelNotification ParcelNotification (complexType)
ParcelInstructions ParcelInstructions (complexType)

ParcelService (complexType)

Name Type
CarrierId String
Barcode String
LocationId String
Service Service (complexType)

Service (complexType)

Name Type
ParcelType String
ShipmentType String

ParcelDestination (complexType)

Name Type
Id String
Name String
Name2 String
Address String
Address2 String
City String
PostCode String
County String
CountryId String
CountryName String

ParcelNotification (complexType)

Name Type
SmsNumber String
EmailAddress String

ParcelInstructions (complexType)

Name Type
LeaveUnattended Boolean
Remarks String
DeliveryDateFormatted String

DataResponse{Order} (complexType)

Name Type
Data Order (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

Order (complexType)

Name Type
Options OrderRequestOptions
OrderId String
PosId String
Barcode String
AccountId Int32
ExtShopId String
ExtShopGroupId String
OrderDate DateTime
OrderDateFormatted String
ExtSalesPersonId String
SalesPersonName String
ExtCustomerId String
CurrencyISO4217a String
CurrencyExchangeRate Decimal
ISO639a3 String
TotalOrderAmount Price
OrderLinesTotalAmount Price
OrderRemarks String
SellTo ExtendedAddress (complexType)
DeliveryAddress BasicAddress (complexType)
Payments List of Payment (complexType)
Shipments List of Shipment (complexType)
ParcelCollect ParcellCollect (complexType)
OrderLines List of OrderLine (complexType)
PriceListID String
PriceCalculationDate DateTime
UserValues List of OrderUserValue (complexType)

ExtendedAddress (complexType)

Name Type
PhoneNumber String
MobilePhoneNo String
Email String
YourReference String
FaxNumber String
EanNumber String
EanAccountNumber String
EanReference String
Name String
Name2 String
Address String
Address2 String
City String
Contact String
PostCode String
County String
CountryId String
CountryName String

BasicAddress (complexType)

Name Type
Name String
Name2 String
Address String
Address2 String
City String
Contact String
PostCode String
County String
CountryId String
CountryName String

ParcellCollect (complexType)

Name Type
ParcelService ParcelService (complexType)
ParcelDestination ParcelDestination (complexType)
ParcelNotification ParcelNotification (complexType)
ParcelInstructions ParcelInstructions (complexType)

ParcelService (complexType)

Name Type
CarrierId String
Barcode String
LocationId String
Service Service (complexType)

Service (complexType)

Name Type
ParcelType String
ShipmentType String

ParcelDestination (complexType)

Name Type
Id String
Name String
Name2 String
Address String
Address2 String
City String
PostCode String
County String
CountryId String
CountryName String

ParcelNotification (complexType)

Name Type
SmsNumber String
EmailAddress String

ParcelInstructions (complexType)

Name Type
LeaveUnattended Boolean
Remarks String
DeliveryDateFormatted String

Basket

GET/sessionservices/v2/basket

Gets visible basket or baskets, depending on shop allows multiple basket

RESPONSE

DataResponse{List{BasketResponseBody}} (complexType)

Name Type
Data List of BasketResponseBody (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketResponseBody (complexType)

Name Type
Id Int32
BasketGuid Guid
DateModified DateTime
IsCollectAtStore Boolean
Name String
BasketTotal Price
LineTotal Price
Fees List of BasketFeeResponseBody (complexType)

DataResponse{List{BasketResponseBody}} (complexType)

Name Type
Data List of BasketResponseBody (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketResponseBody (complexType)

Name Type
Id Int32
BasketGuid Guid
DateModified DateTime
IsCollectAtStore Boolean
Name String
BasketTotal Price
LineTotal Price
Fees List of BasketFeeResponseBody (complexType)

Basket

POST/sessionservices/v2/basket

Creates a new basket. Note: This will advertently create a session.

REQUEST PARAMETERS

Parameters FromBody

Name Description Type
complexType BasketRequestBodyShow details

BasketRequestBody (complexType)

Name Type
Id Int32
DateModified DateTime
IsCollectAtStore Boolean
Name String

RESPONSE

DataResponse{BasketResponseBody} (complexType)

Name Type
Data BasketResponseBody (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketResponseBody (complexType)

Name Type
Id Int32
BasketGuid Guid
DateModified DateTime
IsCollectAtStore Boolean
Name String
BasketTotal Price
LineTotal Price
Fees List of BasketFeeResponseBody (complexType)

DataResponse{BasketResponseBody} (complexType)

Name Type
Data BasketResponseBody (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketResponseBody (complexType)

Name Type
Id Int32
BasketGuid Guid
DateModified DateTime
IsCollectAtStore Boolean
Name String
BasketTotal Price
LineTotal Price
Fees List of BasketFeeResponseBody (complexType)

Basket

GET/sessionservices/v2/basket/{id}

Gets the basket with the specified ID. If this basket does not exist, or you do not have permissions, a 404 is returned.

REQUEST PARAMETERS

Parameters FromUri

Name Description Type
id Int32

RESPONSE

DataResponse{BasketResponseBody} (complexType)

Name Type
Data BasketResponseBody (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketResponseBody (complexType)

Name Type
Id Int32
BasketGuid Guid
DateModified DateTime
IsCollectAtStore Boolean
Name String
BasketTotal Price
LineTotal Price
Fees List of BasketFeeResponseBody (complexType)

DataResponse{BasketResponseBody} (complexType)

Name Type
Data BasketResponseBody (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketResponseBody (complexType)

Name Type
Id Int32
BasketGuid Guid
DateModified DateTime
IsCollectAtStore Boolean
Name String
BasketTotal Price
LineTotal Price
Fees List of BasketFeeResponseBody (complexType)

Basket

GET/sessionservices/v2/basket/current

Gets current basket. If a shop allows multiple baskets, the method returns active basket.

RESPONSE

DataResponse{BasketResponseBody} (complexType)

Name Type
Data BasketResponseBody (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketResponseBody (complexType)

Name Type
Id Int32
BasketGuid Guid
DateModified DateTime
IsCollectAtStore Boolean
Name String
BasketTotal Price
LineTotal Price
Fees List of BasketFeeResponseBody (complexType)

DataResponse{BasketResponseBody} (complexType)

Name Type
Data BasketResponseBody (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketResponseBody (complexType)

Name Type
Id Int32
BasketGuid Guid
DateModified DateTime
IsCollectAtStore Boolean
Name String
BasketTotal Price
LineTotal Price
Fees List of BasketFeeResponseBody (complexType)

Basket

GET/sessionservices/v2/basket/current/coupon

List coupons in basket.

RESPONSE

Basket

POST/sessionservices/v2/basket/current/coupon

Adds the coupon to basket and returns a message wether or not it succeeded. A failure adding (if not found, duplicate, already exists etc) will result in a code 400.

REQUEST PARAMETERS

Parameters FromBody

Name Description Type
complexType BasketCouponPostBodyShow details

BasketCouponPostBody (complexType)

Name Type
CouponId String

RESPONSE

Basket

DELETE/sessionservices/v2/basket/current/coupon

Removes the coupon from basket and returns a message wether or not it succeeded. A failure removing if not found will result in a code 400.

Basket

DELETE/sessionservices/v2/basket/current/coupon/{couponId}

Removes the coupon from basket and returns a message wether or not it succeeded. A failure removing if not found will result in a code 400.

REQUEST PARAMETERS

Parameters FromUri

Name Description Type
couponId String

RESPONSE

UserValues

GET/sessionservices/v2/basket/{id}/uservalues

Gets all user values from the basket with the specified ID

REQUEST PARAMETERS

Parameters FromUri

Name Description Type
id Int32

RESPONSE

DataResponse{List{BasketUservalue}} (complexType)

Name Type
Data List of BasketUservalue (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketUservalue (complexType)

Name Type
Key String
Value String
IsVisibleOnOrder Boolean
ContentType String
ValueType String

DataResponse{List{BasketUservalue}} (complexType)

Name Type
Data List of BasketUservalue (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketUservalue (complexType)

Name Type
Key String
Value String
IsVisibleOnOrder Boolean
ContentType String
ValueType String

UserValues

POST/sessionservices/v2/basket/{id}/uservalues

REQUEST PARAMETERS

Parameters FromUri

Name Description Type
id Int32

Parameters FromBody

Name Description Type
String

RESPONSE

BasketUservalue (complexType)

Name Type
Key String
Value String
IsVisibleOnOrder Boolean
ContentType String
ValueType String

BasketUservalue (complexType)

Name Type
Key String
Value String
IsVisibleOnOrder Boolean
ContentType String
ValueType String

UserValues

DELETE/sessionservices/v2/basket/{id}/uservalues

Deletes all user values from a basket with specific ID

REQUEST PARAMETERS

Parameters FromUri

Name Description Type
id Int32

UserValues

GET/sessionservices/v2/basket/{id}/uservalues/{key}

Gets a user value by specified key from basket with specified ID

REQUEST PARAMETERS

Parameters FromUri

Name Description Type
id Int32
key String

RESPONSE

DataResponse{BasketUservalue} (complexType)

Name Type
Data BasketUservalue (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketUservalue (complexType)

Name Type
Key String
Value String
IsVisibleOnOrder Boolean
ContentType String
ValueType String

DataResponse{BasketUservalue} (complexType)

Name Type
Data BasketUservalue (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketUservalue (complexType)

Name Type
Key String
Value String
IsVisibleOnOrder Boolean
ContentType String
ValueType String

UserValues

DELETE/sessionservices/v2/basket/{id}/uservalues/{key}

Deletes a user value by specified key from current basket

REQUEST PARAMETERS

Parameters FromUri

Name Description Type
id Int32
key String

UserValues

PUT/sessionservices/v2/basket/{id}/uservalues/{key}

Updates a user value by specified key from basket with specified ID

REQUEST PARAMETERS

Parameters FromUri

Name Description Type
id Int32
key String

Parameters FromBody

Name Description Type
complexType BasketUservalueShow details

BasketUservalue (complexType)

Name Type
Key String
Value String
IsVisibleOnOrder Boolean
ContentType String
ValueType String

RESPONSE

DataResponse{BasketUservalue} (complexType)

Name Type
Data BasketUservalue (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketUservalue (complexType)

Name Type
Key String
Value String
IsVisibleOnOrder Boolean
ContentType String
ValueType String

DataResponse{BasketUservalue} (complexType)

Name Type
Data BasketUservalue (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketUservalue (complexType)

Name Type
Key String
Value String
IsVisibleOnOrder Boolean
ContentType String
ValueType String

UserValues

GET/sessionservices/v2/basket/current/uservalues

Gets all user values from current basket

RESPONSE

DataResponse{List{BasketUservalue}} (complexType)

Name Type
Data List of BasketUservalue (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketUservalue (complexType)

Name Type
Key String
Value String
IsVisibleOnOrder Boolean
ContentType String
ValueType String

DataResponse{List{BasketUservalue}} (complexType)

Name Type
Data List of BasketUservalue (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketUservalue (complexType)

Name Type
Key String
Value String
IsVisibleOnOrder Boolean
ContentType String
ValueType String

UserValues

POST/sessionservices/v2/basket/current/uservalues

REQUEST PARAMETERS

Parameters FromBody

Name Description Type
String

RESPONSE

DataResponse{BasketUservalue} (complexType)

Name Type
Data BasketUservalue (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketUservalue (complexType)

Name Type
Key String
Value String
IsVisibleOnOrder Boolean
ContentType String
ValueType String

DataResponse{BasketUservalue} (complexType)

Name Type
Data BasketUservalue (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketUservalue (complexType)

Name Type
Key String
Value String
IsVisibleOnOrder Boolean
ContentType String
ValueType String

UserValues

DELETE/sessionservices/v2/basket/current/uservalues

Deletes all user values from current basket

UserValues

GET/sessionservices/v2/basket/current/uservalues/{key}

Gets a user value by specified key from current basket

REQUEST PARAMETERS

Parameters FromUri

Name Description Type
key String

RESPONSE

DataResponse{BasketUservalue} (complexType)

Name Type
Data BasketUservalue (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketUservalue (complexType)

Name Type
Key String
Value String
IsVisibleOnOrder Boolean
ContentType String
ValueType String

DataResponse{BasketUservalue} (complexType)

Name Type
Data BasketUservalue (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketUservalue (complexType)

Name Type
Key String
Value String
IsVisibleOnOrder Boolean
ContentType String
ValueType String

UserValues

DELETE/sessionservices/v2/basket/current/uservalues/{key}

Deletes a user value by specified key from current basket

REQUEST PARAMETERS

Parameters FromUri

Name Description Type
key String

BasketLine

GET/sessionservices/v2/basket/current/line

Gets lines from current basket.

REQUEST PARAMETERS

Parameters FromQuery

Name Description Type
include Specifies if the response will include additional content: "include=desc" means that response will contain line descriptions and images BasketIncludeOptionShow details
imgSizeId Allows to specify image size ID. It will determine image urls that will be used in response

BasketIncludeOption (enum)

Name Type
desc in specified, the response will contain line descriptions and images

RESPONSE

DataResponse{BasketDisplayLine} (complexType)

Name Type
Data BasketDisplayLine (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketDisplayLine (complexType)

Name Type
Id Int32
Tag String
ParentId Int32
ItemContent TypeOfItem (enum)
ItemSubType LineSubType (enum)
IsLineEditable Boolean
IsLineDeleteable Boolean
IsLineCollapse Boolean
IsAmountVisible Boolean
IsQuantityVisible Boolean
IsAmountInTotals Boolean
InternalItemId1 Int32
InternalItemId2 Int32
ExternalItemId1 String
ExternalItemId2 String
SecondaryId String
EAN String
PosID String
Quantity Decimal
LineAmount Price
UnitPrice Price
ItemUrl String
ItemImageUrl String
Description1 String
Description2 String
Description3 String
DeliveryDate DateTime
PriceCalculationDate DateTime
UserCode1 String
UserCode2 String
UserCode3 String

TypeOfItem (enum)

Name Type
Product
Text
AuctionProduct
ProductVariant
LogicaProductAssortment
LogicaProductAssortmentVariant
Shipment
Payment
Rebate
LogicaProductAssortmentProductVariant
ConfiguredProduct
BomProduct
Coupon
Deal
DealLine
GiftCard

LineSubType (enum)

Name Type
Standard
Discount
Deposit

DataResponse{BasketDisplayLine} (complexType)

Name Type
Data BasketDisplayLine (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketDisplayLine (complexType)

Name Type
Id Int32
Tag String
ParentId Int32
ItemContent TypeOfItem (enum)
ItemSubType LineSubType (enum)
IsLineEditable Boolean
IsLineDeleteable Boolean
IsLineCollapse Boolean
IsAmountVisible Boolean
IsQuantityVisible Boolean
IsAmountInTotals Boolean
InternalItemId1 Int32
InternalItemId2 Int32
ExternalItemId1 String
ExternalItemId2 String
SecondaryId String
EAN String
PosID String
Quantity Decimal
LineAmount Price
UnitPrice Price
ItemUrl String
ItemImageUrl String
Description1 String
Description2 String
Description3 String
DeliveryDate DateTime
PriceCalculationDate DateTime
UserCode1 String
UserCode2 String
UserCode3 String

TypeOfItem (enum)

Name Type
Product
Text
AuctionProduct
ProductVariant
LogicaProductAssortment
LogicaProductAssortmentVariant
Shipment
Payment
Rebate
LogicaProductAssortmentProductVariant
ConfiguredProduct
BomProduct
Coupon
Deal
DealLine
GiftCard

LineSubType (enum)

Name Type
Standard
Discount
Deposit

BasketLine

POST/sessionservices/v2/basket/current/line

Adds lines to basket and returns all newly created lines from current basket. Accepts an array of BasketLineBody's to allow for modifying multiple lines at once.

REQUEST PARAMETERS

Parameters FromBody

Name Description Type
List of BasketLineRequestBodyShow details

BasketLineRequestBody (complexType)

Name Type
ReferencingId Int32
ProductType BasketLineRequestItemType (enum)
CreateOption BasketLineCreationOption (enum)
BasketLineId Int32
ParentId Int32
Quantity Decimal
DeliveryDate DateTime
PriceCalculationDateFollowsDeliveryDate Boolean
Tag String
UserCode1 String
UserCode2 String
UserCode3 String
Description1 String
Description2 String
Description3 String

BasketLineRequestItemType (enum)

Name Type
Product Submitted item is a non-variant product.
Variant Submitted item is a product variant.
Offer Submitted item is a deal / offer.
Text Submited item is a descitpion line only.

BasketLineCreationOption (enum)

Name Type
Default
CreateNewLine

Parameters FromQuery

Name Description Type
include Specifies if the response will include additional content: "include=desc" means that response will contain line descriptions and images BasketIncludeOptionShow details
imgSizeId Allows to specify image size ID. It will determine image urls that will be used in response

BasketIncludeOption (enum)

Name Type
desc in specified, the response will contain line descriptions and images

RESPONSE

DataResponse{BasketDisplayLine} (complexType)

Name Type
Data BasketDisplayLine (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketDisplayLine (complexType)

Name Type
Id Int32
Tag String
ParentId Int32
ItemContent TypeOfItem (enum)
ItemSubType LineSubType (enum)
IsLineEditable Boolean
IsLineDeleteable Boolean
IsLineCollapse Boolean
IsAmountVisible Boolean
IsQuantityVisible Boolean
IsAmountInTotals Boolean
InternalItemId1 Int32
InternalItemId2 Int32
ExternalItemId1 String
ExternalItemId2 String
SecondaryId String
EAN String
PosID String
Quantity Decimal
LineAmount Price
UnitPrice Price
ItemUrl String
ItemImageUrl String
Description1 String
Description2 String
Description3 String
DeliveryDate DateTime
PriceCalculationDate DateTime
UserCode1 String
UserCode2 String
UserCode3 String

TypeOfItem (enum)

Name Type
Product
Text
AuctionProduct
ProductVariant
LogicaProductAssortment
LogicaProductAssortmentVariant
Shipment
Payment
Rebate
LogicaProductAssortmentProductVariant
ConfiguredProduct
BomProduct
Coupon
Deal
DealLine
GiftCard

LineSubType (enum)

Name Type
Standard
Discount
Deposit

DataResponse{BasketDisplayLine} (complexType)

Name Type
Data BasketDisplayLine (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketDisplayLine (complexType)

Name Type
Id Int32
Tag String
ParentId Int32
ItemContent TypeOfItem (enum)
ItemSubType LineSubType (enum)
IsLineEditable Boolean
IsLineDeleteable Boolean
IsLineCollapse Boolean
IsAmountVisible Boolean
IsQuantityVisible Boolean
IsAmountInTotals Boolean
InternalItemId1 Int32
InternalItemId2 Int32
ExternalItemId1 String
ExternalItemId2 String
SecondaryId String
EAN String
PosID String
Quantity Decimal
LineAmount Price
UnitPrice Price
ItemUrl String
ItemImageUrl String
Description1 String
Description2 String
Description3 String
DeliveryDate DateTime
PriceCalculationDate DateTime
UserCode1 String
UserCode2 String
UserCode3 String

TypeOfItem (enum)

Name Type
Product
Text
AuctionProduct
ProductVariant
LogicaProductAssortment
LogicaProductAssortmentVariant
Shipment
Payment
Rebate
LogicaProductAssortmentProductVariant
ConfiguredProduct
BomProduct
Coupon
Deal
DealLine
GiftCard

LineSubType (enum)

Name Type
Standard
Discount
Deposit

BasketLine

PUT/sessionservices/v2/basket/current/line

Updates one or more lines in current basket and returns all updated lines.

REQUEST PARAMETERS

Parameters FromBody

Name Description Type
List of BasketLineRequestBodyShow details

BasketLineRequestBody (complexType)

Name Type
ReferencingId Int32
ProductType BasketLineRequestItemType (enum)
CreateOption BasketLineCreationOption (enum)
BasketLineId Int32
ParentId Int32
Quantity Decimal
DeliveryDate DateTime
PriceCalculationDateFollowsDeliveryDate Boolean
Tag String
UserCode1 String
UserCode2 String
UserCode3 String
Description1 String
Description2 String
Description3 String

BasketLineRequestItemType (enum)

Name Type
Product Submitted item is a non-variant product.
Variant Submitted item is a product variant.
Offer Submitted item is a deal / offer.
Text Submited item is a descitpion line only.

BasketLineCreationOption (enum)

Name Type
Default
CreateNewLine

Parameters FromQuery

Name Description Type
include Specifies if the response will include additional content: "include=desc" means that response will contain line descriptions and images BasketIncludeOptionShow details
imgSizeId Allows to specify image size ID. It will determine image urls that will be used in response

BasketIncludeOption (enum)

Name Type
desc in specified, the response will contain line descriptions and images

RESPONSE

DataResponse{BasketDisplayLine} (complexType)

Name Type
Data BasketDisplayLine (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketDisplayLine (complexType)

Name Type
Id Int32
Tag String
ParentId Int32
ItemContent TypeOfItem (enum)
ItemSubType LineSubType (enum)
IsLineEditable Boolean
IsLineDeleteable Boolean
IsLineCollapse Boolean
IsAmountVisible Boolean
IsQuantityVisible Boolean
IsAmountInTotals Boolean
InternalItemId1 Int32
InternalItemId2 Int32
ExternalItemId1 String
ExternalItemId2 String
SecondaryId String
EAN String
PosID String
Quantity Decimal
LineAmount Price
UnitPrice Price
ItemUrl String
ItemImageUrl String
Description1 String
Description2 String
Description3 String
DeliveryDate DateTime
PriceCalculationDate DateTime
UserCode1 String
UserCode2 String
UserCode3 String

TypeOfItem (enum)

Name Type
Product
Text
AuctionProduct
ProductVariant
LogicaProductAssortment
LogicaProductAssortmentVariant
Shipment
Payment
Rebate
LogicaProductAssortmentProductVariant
ConfiguredProduct
BomProduct
Coupon
Deal
DealLine
GiftCard

LineSubType (enum)

Name Type
Standard
Discount
Deposit

DataResponse{BasketDisplayLine} (complexType)

Name Type
Data BasketDisplayLine (complexType)
ApiVersion String
Id String
Context String
ServedBy String
TimeServed String
AppVersion String

BasketDisplayLine (complexType)

Name Type
Id Int32
Tag String
ParentId Int32
ItemContent TypeOfItem (enum)
ItemSubType LineSubType (enum)
IsLineEditable Boolean
IsLineDeleteable Boolean
IsLineCollapse Boolean
IsAmountVisible Boolean
IsQuantityVisible Boolean
IsAmountInTotals Boolean
InternalItemId1 Int32
InternalItemId2 Int32
ExternalItemId1 String
ExternalItemId2 String
SecondaryId String
EAN String
PosID String
Quantity Decimal
LineAmount Price
UnitPrice Price
ItemUrl String
ItemImageUrl String
Description1 String
Description2 String
Description3 String
DeliveryDate DateTime
PriceCalculationDate DateTime
UserCode1 String
UserCode2 String
UserCode3 String

TypeOfItem (enum)

Name Type
Product
Text
AuctionProduct
ProductVariant
LogicaProductAssortment
LogicaProductAssortmentVariant
Shipment
Payment
Rebate
LogicaProductAssortmentProductVariant
ConfiguredProduct
BomProduct
Coupon
Deal
DealLine
GiftCard

LineSubType (enum)

Name Type
Standard
Discount
Deposit

BasketLine

DELETE/sessionservices/v2/basket/current/line

Deletes all lines from current basket, aka empty basket.

BasketLine

DELETE/sessionservices/v2/basket/current/line/{basketLineId}

Deletes a line with given ID from current basket.

REQUEST PARAMETERS

Parameters FromUri

Name Description Type
basketLineId Int32