PUT | /avbsales | Insert Sale(s). Max of 1000 Sales. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Sales | body | List<SaleCreateModel> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ExternalOrderNumber | form | string | Yes | |
SaleDate | form | DateTime | Yes | |
CustomerName | form | string | No | |
CustomerPhone | form | string | No | |
CustomerEmail | form | string | No | |
CustomerZipcode | form | string | No | |
SalesRep | form | string | No | |
StoreLocation | form | string | No | |
GrandTotal | form | decimal | No | |
Subtotal | form | decimal | No | |
Discount | form | decimal | No | |
Misc | form | decimal | No | |
Tax | form | decimal | No | |
Shipping | form | decimal | No | |
Source | form | SaleSource | No | Source is: 'LINQ','POS', or 'Website' |
ShippingAddressLine1 | form | string | No | |
ShippingAddressLine2 | form | string | No | |
ShippingAddressCity | form | string | No | |
ShippingAddressState | form | string | No | |
ShippingAddressZip | form | string | No | |
ShippingMethod | form | string | No | |
PaymentType | form | string | No | |
CustomerID | form | string | No | |
DeliveredDate | form | DateTime? | No | |
SaleItems | form | List<SaleItemModel> | No |
Undefined | |
LINQ | |
POS | |
Website |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
MfgSku | form | string | Yes | |
Brand | form | string | Yes | |
SellerSku | form | string | No | |
Name | form | string | No | |
ItemQty | form | decimal | Yes | |
ItemCost | form | decimal | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | 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.
PUT /avbsales HTTP/1.1
Host: avb-pos.avbportal.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
sales:
[
{
externalOrderNumber: String,
saleDate: 0001-01-01,
customerName: String,
customerPhone: String,
customerEmail: String,
customerZipcode: String,
salesRep: String,
storeLocation: String,
grandTotal: 0,
subtotal: 0,
discount: 0,
misc: 0,
tax: 0,
shipping: 0,
source: Undefined,
shippingAddressLine1: String,
shippingAddressLine2: String,
shippingAddressCity: String,
shippingAddressState: String,
shippingAddressZip: String,
shippingMethod: String,
paymentType: String,
customerID: String,
deliveredDate: 0001-01-01,
saleItems:
[
{
mfgSku: String,
brand: String,
sellerSku: String,
name: String,
itemQty: 0,
itemCost: 0
}
]
}
]
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }