All Verbs | /service/AddCartItems |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Items | query | List<CartItem> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CartId | form | string | No | |
ProductId | form | string | No | |
Product | form | Product | No | |
ManufacturerNumber | form | string | No | |
ProductLineId | form | string | No | |
QtyPurchased | form | int | No | |
QtyShipped | form | int | No | |
QtyOpen | form | int | No | |
QtyAdjusted | form | bool | No | |
QtyCustom1 | form | int | No | |
QtyCustom2 | form | int | No | |
OpenTotal | form | decimal | No | |
ShippedTotal | form | decimal | No | |
Position | form | int | No | |
OrderNotes | form | string | No | |
Note | form | string | No | |
Description | form | string | No | |
Comments | form | string | No | |
Notes | form | string | No | |
BrandId | form | string | No | |
SuperCategory | form | string | No | |
SalesRepId | form | string | No | |
PromoCode | form | string | No | |
PromoCode2 | form | string | No | |
Status | form | string | No | |
Price | form | decimal | No | |
PriceOverride | form | decimal | No | |
PriceListId | form | string | No | |
Options | form | List<CartItemOption> | No | |
Meta | form | Dictionary<string, string> | No | |
OptionsString | form | string | No | |
PromoDiscount | form | decimal | No | |
DiscountPercentage | form | decimal | No | |
Discount | form | decimal | No | |
LineOrderDiscount | form | decimal | No | |
LineDiscount | form | decimal | No | |
PromoNote | form | string | No | |
SubTotal | form | decimal | No | |
OpenSubTotal | form | decimal | No | |
ShippedSubTotal | form | decimal | No | |
PricePaid | form | decimal | No | |
ExtendedQtyPurchased | form | double | No | |
CaseQtyPurchased | form | double | No | |
TotalWeight | form | double | No | |
AvailableWeight | form | double | No | |
TotalCubicVolume | form | double | No | |
AvailableCubicVolume | form | double | No | |
AvailableTotal | form | double | No | |
ExtendedTotal | form | decimal | No | |
OpenExtendedTotal | form | decimal | No | |
ShippedExtendedTotal | form | decimal | No | |
ParentPosition | form | int | No | |
ListPrice | form | decimal | No | |
Cost | form | string | No | |
UPC | form | string | No | |
UOM | form | string | No | |
PaymentTermsId | form | string | No | |
ShippingMethodId | form | string | No | |
Category | form | string | No | |
SubCategory | form | string | No | |
ShipOn | form | DateTime? | No | |
CancelOn | form | DateTime? | No | |
esaDate | form | DateTime? | No | |
Custom1 | form | string | No | |
Custom2 | form | string | No | |
Custom3 | form | string | No | |
Custom4 | form | string | No | |
Custom5 | form | string | No | |
Custom6 | form | string | No | |
Custom7 | form | string | No | |
Custom8 | form | string | No | |
Custom9 | form | string | No | |
Custom10 | form | string | No | |
Custom11 | form | string | No | |
TrackingNumbers | form | string | No | |
Custom13 | form | string | No | |
OptionGroupList | form | string | No | |
TagFor | form | string | No | |
ReasonCode | form | string | No | |
PurchaseOrder | form | string | No | |
NextFulfillment | form | string | No | |
AddItemPath | form | string | No | |
IsKitComponent | form | bool | No | |
IsContractPrice | form | bool | No | |
Points | form | decimal | No | |
CustomerLineLevelQty | form | int | No | |
FromSplit | form | bool | No | |
CanModify | form | bool | No | |
OrigQty | form | int | No | |
CampaignId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
ProductLineId | form | string | No | |
ManufacturerNumber | form | string | No | |
ShortDescription | form | string | No | |
LongDescription | form | string | No | |
AltDescription | form | string | No | |
UpcCode | form | string | No | |
Status | form | string | No | |
Pricing | form | IDictionary<int, double> | No | |
ListPrice | form | decimal | No | |
WholesalePrice | form | decimal | No | |
RetailPrice | form | decimal? | No | |
RetailListPrice | form | decimal | No | |
UnitsInStock | form | int | No | |
UnitsAllocated | form | int | No | |
Price | form | decimal? | No | |
Unlisted | form | bool | No | |
CategoryId | form | string | No | |
Category | form | ProductCategory | No | |
MinimumOrderQty | form | double | No | |
AvailableQty | form | double | No | |
CaseQty | form | double | No | |
CasePrice | form | decimal | No | |
AvailableOn | form | DateTime? | No | |
IncomingQty | form | double | No | |
PurchaseIncrement | form | double | No | |
OptionGroup | form | string | No | |
OptionGroupList | form | string | No | |
VendorId | form | string | No | |
Vendor | form | Vendor | No | |
IsB2B | form | bool | No | |
IsB2C | form | bool | No | |
IsSellable | form | bool | No | |
IsNonDiscountable | form | bool | No | |
ItemType | form | string | No | |
ImageUrl | form | string | No | |
OnDemandProductEuid | form | string | No | |
Keywords | form | string | No | |
SuperCategory | form | string | No | |
Tags | form | Dictionary<string, HashSet<String>> | No | |
AsShownValues | form | FieldValue[] | No | |
GenericTags | form | List<Tag> | No | |
IsNew | form | bool | No | |
IsRestricted | form | bool | No | |
IsAsShown | form | bool | No | |
IsKit | form | bool | No | |
IsKitExplode | form | bool | No | |
IsKitEditable | form | bool | No | |
Meta | form | Dictionary<string, string> | No | |
IsOnDemand | form | bool | No | |
CreatedOn | form | DateTime | No | |
Weight | form | double | No | |
Height | form | decimal | No | |
Width | form | double | No | |
Length | form | decimal | No | |
CubicVolume | form | double | No | |
MaxNumLines | form | int | No | |
Cost | form | decimal | No | |
UOM | form | string | No | |
SubCategory | form | string | No | |
ShipOn | form | DateTime? | No | |
MainFeatured | form | int | No | |
Featured | form | int | No | |
Likes | form | long | No | |
HasLiked | form | bool | No | |
EnforceMinimum | form | bool | No | |
Points | form | decimal | No | |
Custom9 | form | string | No | |
Warehouse | form | string | No | |
ProductImages | form | List<ProductImage> | No | |
IsDealerVisible | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | K | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Label | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Label | form | string | No | |
VendorName | form | string | No | |
Abbreviation | form | string | No | |
OrderMinimum | form | decimal | No | |
ReOrderMinimum | form | decimal | No | |
MinimumBalance | form | decimal | No | |
Active | form | bool | No | |
IsInvoiceOnly | form | bool | No | |
AllowPriceOverride | form | bool | No | |
DefaultShipDatePrevious | form | bool | No | |
EnforceMinimums | form | bool | No | |
EnforcePurchaseIncrement | form | bool | No | |
AllowDiscounts | form | bool | No | |
EmailOrders | form | bool | No | |
AllowBackorders | form | bool | No | |
UseVendorCustId | form | bool | No | |
UseVendorShipId | form | bool | No | |
UseVendorTerms | form | bool | No | |
ExportReviewOrders | form | bool | No | |
EmailUrlToExport | form | bool | No | |
IncludeInBatch | form | bool | No | |
DecryptCCOnExport | form | bool | No | |
CustomerNumber | form | string | No | |
ExportOrders | form | bool | No | |
SplitByProductLine | form | bool | No | |
IsShowroomVendor | form | bool | No | |
AllowManualItemEntry | form | bool | No | |
RequireCreditSheet | form | bool | No | |
Address | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Zip | form | string | No | |
Phone | form | string | No | |
Fax | form | string | No | |
form | string | No | ||
Website | form | string | No | |
Note | form | string | No | |
CommissionPercent | form | decimal | No | |
OrderTagLine | form | string | No | |
ProductTags | form | List<VendorProductTag> | No | |
Settings | form | List<VendorSetting> | No | |
LastLoginAttempt | form | DateTime | No | |
LastOrderedOn | form | DateTime | No | |
Meta | form | Dictionary<string, string> | No | |
Tags | form | Dictionary<string, HashSet<String>> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Tag | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
VendorId | form | string | No | |
Key | form | string | No | |
Value | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FieldId | form | string | No | |
ValueId | form | string | No | |
CustomText | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | double | No | |
Shard | form | string | No | |
PrincipalId | form | string | No | |
TagKind | form | string | No | |
TagLabel | form | string | No | |
ParentTagKind | form | string | No | |
ParentTagLabel | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CreatedBy | form | string | No | |
CreatedOn | form | DateTime | No | |
LastModifiedOn | form | DateTime | No | |
LastModifiedBy | form | string | No | |
Generated | form | bool | No | |
Exported | form | bool | No | |
Position | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ProductId | form | string | No | |
Position | form | int | No | |
CreatedOn | form | DateTime | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Position | form | int | No | |
FieldId | form | string | No | |
FieldLabel | form | string | No | |
FieldText | form | string | No | |
CustomText | form | string | No | |
ValueId | form | string | No | |
ValueLabel | form | string | No | |
Upcharge | form | double | No | |
UpchargeType | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/AddCartItems HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
items:
[
{
cartId: String,
productId: String,
product:
{
id: String,
productLineId: String,
manufacturerNumber: String,
shortDescription: String,
longDescription: String,
altDescription: String,
upcCode: String,
status: String,
listPrice: 0,
wholesalePrice: 0,
retailPrice: 0,
retailListPrice: 0,
unitsInStock: 0,
unitsAllocated: 0,
unlisted: False,
categoryId: String,
category:
{
id: String,
label: String
},
minimumOrderQty: 0,
availableQty: 0,
caseQty: 0,
casePrice: 0,
availableOn: 0001-01-01,
incomingQty: 0,
purchaseIncrement: 0,
optionGroup: String,
optionGroupList: String,
vendorId: String,
vendor:
{
id: String,
label: String,
vendorName: String,
abbreviation: String,
orderMinimum: 0,
reOrderMinimum: 0,
minimumBalance: 0,
active: False,
isInvoiceOnly: False,
allowPriceOverride: False,
defaultShipDatePrevious: False,
enforceMinimums: False,
enforcePurchaseIncrement: False,
allowDiscounts: False,
emailOrders: False,
allowBackorders: False,
useVendorCustId: False,
useVendorShipId: False,
useVendorTerms: False,
exportReviewOrders: False,
emailUrlToExport: False,
includeInBatch: False,
decryptCCOnExport: False,
customerNumber: String,
exportOrders: False,
splitByProductLine: False,
isShowroomVendor: False,
allowManualItemEntry: False,
requireCreditSheet: False,
address: String,
city: String,
state: String,
zip: String,
phone: String,
fax: String,
email: String,
website: String,
note: String,
commissionPercent: 0,
orderTagLine: String,
productTags:
[
{
id: String,
tag: String
}
],
settings:
[
{
vendorId: String,
key: String,
value: String
}
],
lastLoginAttempt: 0001-01-01,
lastOrderedOn: 0001-01-01,
meta:
{
String: String
},
tags:
{
String:
[
String
]
}
},
isB2B: False,
isB2C: False,
isSellable: False,
isNonDiscountable: False,
itemType: String,
imageUrl: String,
onDemandProductEuid: String,
keywords: String,
superCategory: String,
tags:
{
String:
[
String
]
},
asShownValues:
[
{
fieldId: String,
valueId: String,
customText: String
}
],
genericTags:
[
{
id: 1312561414.13126,
shard: String,
principalId: String,
tagKind: String,
tagLabel: String,
parentTagKind: String,
parentTagLabel: String,
createdBy: String,
createdOn: 0001-01-01,
lastModifiedOn: 0001-01-01,
lastModifiedBy: String,
generated: False,
exported: False,
position: 0
}
],
isNew: False,
isRestricted: False,
isAsShown: False,
isKit: False,
isKitExplode: False,
isKitEditable: False,
meta:
{
String: String
},
isOnDemand: False,
createdOn: 0001-01-01,
weight: 0,
height: 0,
width: 0,
length: 0,
cubicVolume: 0,
maxNumLines: 0,
cost: 0,
uom: String,
subCategory: String,
shipOn: 0001-01-01,
mainFeatured: 0,
featured: 0,
likes: 1,
hasLiked: False,
enforceMinimum: False,
points: 0,
custom9: String,
warehouse: String,
productImages:
[
{
productId: String,
position: 0,
createdOn: 0001-01-01
}
],
isDealerVisible: False
},
manufacturerNumber: String,
productLineId: String,
qtyPurchased: 0,
qtyShipped: 0,
qtyOpen: 0,
qtyAdjusted: False,
qtyCustom1: 0,
qtyCustom2: 0,
openTotal: 0,
shippedTotal: 0,
position: 0,
orderNotes: String,
description: String,
comments: String,
notes: String,
brandId: String,
superCategory: String,
salesRepId: String,
promoCode: String,
promoCode2: String,
status: String,
price: 0,
priceOverride: 0,
priceListId: String,
options: [],
meta:
{
String: String
},
optionsString: "",
promoDiscount: 0,
discountPercentage: 0,
discount: 0,
lineOrderDiscount: 0,
lineDiscount: 0,
promoNote: String,
subTotal: 0,
openSubTotal: 0,
shippedSubTotal: 0,
pricePaid: 0,
extendedQtyPurchased: 0,
caseQtyPurchased: 0,
totalWeight: 0,
availableWeight: 0,
totalCubicVolume: 0,
availableCubicVolume: 0,
availableTotal: 0,
extendedTotal: 0,
openExtendedTotal: 0,
shippedExtendedTotal: 0,
parentPosition: 0,
listPrice: 0,
cost: String,
upc: String,
uom: String,
paymentTermsId: String,
shippingMethodId: String,
category: String,
subCategory: String,
cancelOn: 0001-01-01,
esaDate: 0001-01-01,
custom1: String,
custom2: String,
custom3: String,
custom4: String,
custom5: String,
custom6: String,
custom7: String,
custom8: String,
custom9: String,
custom10: String,
custom11: String,
trackingNumbers: String,
custom13: String,
optionGroupList: String,
tagFor: String,
reasonCode: String,
purchaseOrder: String,
nextFulfillment: String,
addItemPath: String,
isKitComponent: False,
isContractPrice: False,
points: 0,
customerLineLevelQty: 0,
fromSplit: False,
canModify: False,
origQty: 0,
campaignId: String
}
]
}