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. |
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. |
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. |
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 |
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. |
Gets current context information
Name | Type |
---|---|
PriceCalculationDate | DateTime |
PriceListId | String |
SuspendInventoryCheck | Boolean |
Name | Type |
---|---|
PriceCalculationDate | DateTime |
PriceListId | String |
SuspendInventoryCheck | Boolean |
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.
Name | Description | Type |
---|---|---|
complexType | ContextChangeRequestBodyShow details |
Name | Type |
---|---|
PriceCalculationDate | DateTime |
PriceListId | String |
SuspendInventoryCheck | Boolean |
Auth | String |
Name | Type |
---|---|
PriceCalculationDate | DateTime |
PriceListId | String |
SuspendInventoryCheck | Boolean |
Auth | String |
Name | Type |
---|---|
PriceCalculationDate | DateTime |
PriceListId | String |
SuspendInventoryCheck | Boolean |
Auth | String |
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.
Name | Description | Type |
---|---|---|
include | Defines elemets that will be included in response | OrderIncludeOptionShow details |
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 |
Name | Type |
---|---|
Data | List of Order (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
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) |
Name | Type |
---|---|
PhoneNumber | String |
MobilePhoneNo | String |
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 |
Name | Type |
---|---|
Name | String |
Name2 | String |
Address | String |
Address2 | String |
City | String |
Contact | String |
PostCode | String |
County | String |
CountryId | String |
CountryName | String |
Name | Type |
---|---|
ParcelService | ParcelService (complexType) |
ParcelDestination | ParcelDestination (complexType) |
ParcelNotification | ParcelNotification (complexType) |
ParcelInstructions | ParcelInstructions (complexType) |
Name | Type |
---|---|
CarrierId | String |
Barcode | String |
LocationId | String |
Service | Service (complexType) |
Name | Type |
---|---|
ParcelType | String |
ShipmentType | String |
Name | Type |
---|---|
Id | String |
Name | String |
Name2 | String |
Address | String |
Address2 | String |
City | String |
PostCode | String |
County | String |
CountryId | String |
CountryName | String |
Name | Type |
---|---|
SmsNumber | String |
EmailAddress | String |
Name | Type |
---|---|
LeaveUnattended | Boolean |
Remarks | String |
DeliveryDateFormatted | String |
Name | Type |
---|---|
Data | List of Order (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
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) |
Name | Type |
---|---|
PhoneNumber | String |
MobilePhoneNo | String |
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 |
Name | Type |
---|---|
Name | String |
Name2 | String |
Address | String |
Address2 | String |
City | String |
Contact | String |
PostCode | String |
County | String |
CountryId | String |
CountryName | String |
Name | Type |
---|---|
ParcelService | ParcelService (complexType) |
ParcelDestination | ParcelDestination (complexType) |
ParcelNotification | ParcelNotification (complexType) |
ParcelInstructions | ParcelInstructions (complexType) |
Name | Type |
---|---|
CarrierId | String |
Barcode | String |
LocationId | String |
Service | Service (complexType) |
Name | Type |
---|---|
ParcelType | String |
ShipmentType | String |
Name | Type |
---|---|
Id | String |
Name | String |
Name2 | String |
Address | String |
Address2 | String |
City | String |
PostCode | String |
County | String |
CountryId | String |
CountryName | String |
Name | Type |
---|---|
SmsNumber | String |
EmailAddress | String |
Name | Type |
---|---|
LeaveUnattended | Boolean |
Remarks | String |
DeliveryDateFormatted | String |
Gets order with the specified ID. If no current customer is logged in or you do not have permissions, a 404 is returned.
Name | Description | Type |
---|---|---|
id | String |
Name | Description | Type |
---|---|---|
include | Defines elemets that will be included in response | OrderIncludeOptionShow details |
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 |
Name | Type |
---|---|
Data | Order (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
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) |
Name | Type |
---|---|
PhoneNumber | String |
MobilePhoneNo | String |
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 |
Name | Type |
---|---|
Name | String |
Name2 | String |
Address | String |
Address2 | String |
City | String |
Contact | String |
PostCode | String |
County | String |
CountryId | String |
CountryName | String |
Name | Type |
---|---|
ParcelService | ParcelService (complexType) |
ParcelDestination | ParcelDestination (complexType) |
ParcelNotification | ParcelNotification (complexType) |
ParcelInstructions | ParcelInstructions (complexType) |
Name | Type |
---|---|
CarrierId | String |
Barcode | String |
LocationId | String |
Service | Service (complexType) |
Name | Type |
---|---|
ParcelType | String |
ShipmentType | String |
Name | Type |
---|---|
Id | String |
Name | String |
Name2 | String |
Address | String |
Address2 | String |
City | String |
PostCode | String |
County | String |
CountryId | String |
CountryName | String |
Name | Type |
---|---|
SmsNumber | String |
EmailAddress | String |
Name | Type |
---|---|
LeaveUnattended | Boolean |
Remarks | String |
DeliveryDateFormatted | String |
Name | Type |
---|---|
Data | Order (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
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) |
Name | Type |
---|---|
PhoneNumber | String |
MobilePhoneNo | String |
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 |
Name | Type |
---|---|
Name | String |
Name2 | String |
Address | String |
Address2 | String |
City | String |
Contact | String |
PostCode | String |
County | String |
CountryId | String |
CountryName | String |
Name | Type |
---|---|
ParcelService | ParcelService (complexType) |
ParcelDestination | ParcelDestination (complexType) |
ParcelNotification | ParcelNotification (complexType) |
ParcelInstructions | ParcelInstructions (complexType) |
Name | Type |
---|---|
CarrierId | String |
Barcode | String |
LocationId | String |
Service | Service (complexType) |
Name | Type |
---|---|
ParcelType | String |
ShipmentType | String |
Name | Type |
---|---|
Id | String |
Name | String |
Name2 | String |
Address | String |
Address2 | String |
City | String |
PostCode | String |
County | String |
CountryId | String |
CountryName | String |
Name | Type |
---|---|
SmsNumber | String |
EmailAddress | String |
Name | Type |
---|---|
LeaveUnattended | Boolean |
Remarks | String |
DeliveryDateFormatted | String |
Gets visible basket or baskets, depending on shop allows multiple basket
Name | Type |
---|---|
Data | List of BasketResponseBody (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Id | Int32 |
BasketGuid | Guid |
DateModified | DateTime |
IsCollectAtStore | Boolean |
Name | String |
BasketTotal | Price |
LineTotal | Price |
Fees | List of BasketFeeResponseBody (complexType) |
Name | Type |
---|---|
Data | List of BasketResponseBody (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Id | Int32 |
BasketGuid | Guid |
DateModified | DateTime |
IsCollectAtStore | Boolean |
Name | String |
BasketTotal | Price |
LineTotal | Price |
Fees | List of BasketFeeResponseBody (complexType) |
Creates a new basket. Note: This will advertently create a session.
Name | Description | Type |
---|---|---|
complexType | BasketRequestBodyShow details |
Name | Type |
---|---|
Id | Int32 |
DateModified | DateTime |
IsCollectAtStore | Boolean |
Name | String |
Name | Type |
---|---|
Data | BasketResponseBody (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Id | Int32 |
BasketGuid | Guid |
DateModified | DateTime |
IsCollectAtStore | Boolean |
Name | String |
BasketTotal | Price |
LineTotal | Price |
Fees | List of BasketFeeResponseBody (complexType) |
Name | Type |
---|---|
Data | BasketResponseBody (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Id | Int32 |
BasketGuid | Guid |
DateModified | DateTime |
IsCollectAtStore | Boolean |
Name | String |
BasketTotal | Price |
LineTotal | Price |
Fees | List of BasketFeeResponseBody (complexType) |
Gets the basket with the specified ID. If this basket does not exist, or you do not have permissions, a 404 is returned.
Name | Description | Type |
---|---|---|
id | Int32 |
Name | Type |
---|---|
Data | BasketResponseBody (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Id | Int32 |
BasketGuid | Guid |
DateModified | DateTime |
IsCollectAtStore | Boolean |
Name | String |
BasketTotal | Price |
LineTotal | Price |
Fees | List of BasketFeeResponseBody (complexType) |
Name | Type |
---|---|
Data | BasketResponseBody (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Id | Int32 |
BasketGuid | Guid |
DateModified | DateTime |
IsCollectAtStore | Boolean |
Name | String |
BasketTotal | Price |
LineTotal | Price |
Fees | List of BasketFeeResponseBody (complexType) |
Gets current basket. If a shop allows multiple baskets, the method returns active basket.
Name | Type |
---|---|
Data | BasketResponseBody (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Id | Int32 |
BasketGuid | Guid |
DateModified | DateTime |
IsCollectAtStore | Boolean |
Name | String |
BasketTotal | Price |
LineTotal | Price |
Fees | List of BasketFeeResponseBody (complexType) |
Name | Type |
---|---|
Data | BasketResponseBody (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Id | Int32 |
BasketGuid | Guid |
DateModified | DateTime |
IsCollectAtStore | Boolean |
Name | String |
BasketTotal | Price |
LineTotal | Price |
Fees | List of BasketFeeResponseBody (complexType) |
List coupons in basket.
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.
Name | Description | Type |
---|---|---|
complexType | BasketCouponPostBodyShow details |
Name | Type |
---|---|
CouponId | String |
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.
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.
Name | Description | Type |
---|---|---|
couponId | String |
Gets all user values from the basket with the specified ID
Name | Description | Type |
---|---|---|
id | Int32 |
Name | Type |
---|---|
Data | List of BasketUservalue (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Key | String |
Value | String |
IsVisibleOnOrder | Boolean |
ContentType | String |
ValueType | String |
Name | Type |
---|---|
Data | List of BasketUservalue (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Key | String |
Value | String |
IsVisibleOnOrder | Boolean |
ContentType | String |
ValueType | String |
Name | Description | Type |
---|---|---|
id | Int32 |
Name | Description | Type |
---|---|---|
String |
Name | Type |
---|---|
Key | String |
Value | String |
IsVisibleOnOrder | Boolean |
ContentType | String |
ValueType | String |
Name | Type |
---|---|
Key | String |
Value | String |
IsVisibleOnOrder | Boolean |
ContentType | String |
ValueType | String |
Deletes all user values from a basket with specific ID
Name | Description | Type |
---|---|---|
id | Int32 |
Gets a user value by specified key from basket with specified ID
Name | Description | Type |
---|---|---|
id | Int32 | |
key | String |
Name | Type |
---|---|
Data | BasketUservalue (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Key | String |
Value | String |
IsVisibleOnOrder | Boolean |
ContentType | String |
ValueType | String |
Name | Type |
---|---|
Data | BasketUservalue (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Key | String |
Value | String |
IsVisibleOnOrder | Boolean |
ContentType | String |
ValueType | String |
Deletes a user value by specified key from current basket
Name | Description | Type |
---|---|---|
id | Int32 | |
key | String |
Updates a user value by specified key from basket with specified ID
Name | Description | Type |
---|---|---|
id | Int32 | |
key | String |
Name | Description | Type |
---|---|---|
complexType | BasketUservalueShow details |
Name | Type |
---|---|
Key | String |
Value | String |
IsVisibleOnOrder | Boolean |
ContentType | String |
ValueType | String |
Name | Type |
---|---|
Data | BasketUservalue (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Key | String |
Value | String |
IsVisibleOnOrder | Boolean |
ContentType | String |
ValueType | String |
Name | Type |
---|---|
Data | BasketUservalue (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Key | String |
Value | String |
IsVisibleOnOrder | Boolean |
ContentType | String |
ValueType | String |
Gets all user values from current basket
Name | Type |
---|---|
Data | List of BasketUservalue (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Key | String |
Value | String |
IsVisibleOnOrder | Boolean |
ContentType | String |
ValueType | String |
Name | Type |
---|---|
Data | List of BasketUservalue (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Key | String |
Value | String |
IsVisibleOnOrder | Boolean |
ContentType | String |
ValueType | String |
Name | Description | Type |
---|---|---|
String |
Name | Type |
---|---|
Data | BasketUservalue (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Key | String |
Value | String |
IsVisibleOnOrder | Boolean |
ContentType | String |
ValueType | String |
Name | Type |
---|---|
Data | BasketUservalue (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Key | String |
Value | String |
IsVisibleOnOrder | Boolean |
ContentType | String |
ValueType | String |
Deletes all user values from current basket
Gets a user value by specified key from current basket
Name | Description | Type |
---|---|---|
key | String |
Name | Type |
---|---|
Data | BasketUservalue (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Key | String |
Value | String |
IsVisibleOnOrder | Boolean |
ContentType | String |
ValueType | String |
Name | Type |
---|---|
Data | BasketUservalue (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
Name | Type |
---|---|
Key | String |
Value | String |
IsVisibleOnOrder | Boolean |
ContentType | String |
ValueType | String |
Deletes a user value by specified key from current basket
Name | Description | Type |
---|---|---|
key | String |
Gets lines from current basket.
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 |
Name | Type |
---|---|
desc | in specified, the response will contain line descriptions and images |
Name | Type |
---|---|
Data | BasketDisplayLine (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
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 |
Name | Type |
---|---|
Product | |
Text | |
AuctionProduct | |
ProductVariant | |
LogicaProductAssortment | |
LogicaProductAssortmentVariant | |
Shipment | |
Payment | |
Rebate | |
LogicaProductAssortmentProductVariant | |
ConfiguredProduct | |
BomProduct | |
Coupon | |
Deal | |
DealLine | |
GiftCard |
Name | Type |
---|---|
Standard | |
Discount | |
Deposit |
Name | Type |
---|---|
Data | BasketDisplayLine (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
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 |
Name | Type |
---|---|
Product | |
Text | |
AuctionProduct | |
ProductVariant | |
LogicaProductAssortment | |
LogicaProductAssortmentVariant | |
Shipment | |
Payment | |
Rebate | |
LogicaProductAssortmentProductVariant | |
ConfiguredProduct | |
BomProduct | |
Coupon | |
Deal | |
DealLine | |
GiftCard |
Name | Type |
---|---|
Standard | |
Discount | |
Deposit |
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.
Name | Description | Type |
---|---|---|
List of BasketLineRequestBodyShow details |
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 |
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. |
Name | Type |
---|---|
Default | |
CreateNewLine |
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 |
Name | Type |
---|---|
desc | in specified, the response will contain line descriptions and images |
Name | Type |
---|---|
Data | BasketDisplayLine (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
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 |
Name | Type |
---|---|
Product | |
Text | |
AuctionProduct | |
ProductVariant | |
LogicaProductAssortment | |
LogicaProductAssortmentVariant | |
Shipment | |
Payment | |
Rebate | |
LogicaProductAssortmentProductVariant | |
ConfiguredProduct | |
BomProduct | |
Coupon | |
Deal | |
DealLine | |
GiftCard |
Name | Type |
---|---|
Standard | |
Discount | |
Deposit |
Name | Type |
---|---|
Data | BasketDisplayLine (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
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 |
Name | Type |
---|---|
Product | |
Text | |
AuctionProduct | |
ProductVariant | |
LogicaProductAssortment | |
LogicaProductAssortmentVariant | |
Shipment | |
Payment | |
Rebate | |
LogicaProductAssortmentProductVariant | |
ConfiguredProduct | |
BomProduct | |
Coupon | |
Deal | |
DealLine | |
GiftCard |
Name | Type |
---|---|
Standard | |
Discount | |
Deposit |
Updates one or more lines in current basket and returns all updated lines.
Name | Description | Type |
---|---|---|
List of BasketLineRequestBodyShow details |
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 |
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. |
Name | Type |
---|---|
Default | |
CreateNewLine |
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 |
Name | Type |
---|---|
desc | in specified, the response will contain line descriptions and images |
Name | Type |
---|---|
Data | BasketDisplayLine (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
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 |
Name | Type |
---|---|
Product | |
Text | |
AuctionProduct | |
ProductVariant | |
LogicaProductAssortment | |
LogicaProductAssortmentVariant | |
Shipment | |
Payment | |
Rebate | |
LogicaProductAssortmentProductVariant | |
ConfiguredProduct | |
BomProduct | |
Coupon | |
Deal | |
DealLine | |
GiftCard |
Name | Type |
---|---|
Standard | |
Discount | |
Deposit |
Name | Type |
---|---|
Data | BasketDisplayLine (complexType) |
ApiVersion | String |
Id | String |
Context | String |
ServedBy | String |
TimeServed | String |
AppVersion | String |
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 |
Name | Type |
---|---|
Product | |
Text | |
AuctionProduct | |
ProductVariant | |
LogicaProductAssortment | |
LogicaProductAssortmentVariant | |
Shipment | |
Payment | |
Rebate | |
LogicaProductAssortmentProductVariant | |
ConfiguredProduct | |
BomProduct | |
Coupon | |
Deal | |
DealLine | |
GiftCard |
Name | Type |
---|---|
Standard | |
Discount | |
Deposit |
Deletes all lines from current basket, aka empty basket.
Deletes a line with given ID from current basket.
Name | Description | Type |
---|---|---|
basketLineId | Int32 |