POST api/v7/ProductVendors

Accepts a product vendor information from a client.

Tables Impacted

ProductVendor

Request Information

URI Parameters

None.

Body Parameters

Product vendor information to insert/create in db

ProductVendorRequest
NameDescriptionTypeRequired?Additional information
productCode *

PLU Key

 string

Yes

String length: between 1 and 30, inclusive
caseCost

case Cost

 decimal number

No

None.
caseSize

case Size

 integer

No

None.
preferredGM

preferred GM

 decimal number

No

None.
allowEndDate

allowed End Date

 date

No

None.
allowStartDate

allowed Start Date

 date

No

None.
allowance

allowance

 decimal number

No

None.
netCaseCost

net Case Cost

 decimal number

No

None.
orderTrigger

order Trigger

 integer

No

None.
maxOrderAmt

max Order Ammount

 integer

No

None.
minInvAmt

minInvAmt

 integer

No

None.
invOnOrder

invOnOrder

 integer

No

None.
orderDate

orderDate

 date

No

None.
returnDays

The number of days an item can still be returned.

 integer

No

None.
vendorCode *

Vendor code (Mandatory if Present)

 string

Conditional

Conditionally required: If vendor information is provided, vendorCode is required

String length: between 1 and 24, inclusive
vendorStyle

Vendor style

 string

No

String length: between 1 and 20, inclusive
vendorPartNumber

Vendor Part Number

 string

No

String length: between 1 and 20, inclusive
vendorName

Vendor Name

 string

No

String length: between 1 and 128, inclusive
customerAuditDate

Audit information

 date

No

None.

Request Formats

application/json, text/json

Sample: 
{
  "productCode": "00000000000099",
  "vendorCode": "V007",
  "vendorStyle": "Style 7",
  "vendorPartNumber": "VP007",
  "vendorName": "Vendor 7",
  "customerAuditDate": "2018-01-01T00:00:00"
}

application/xml, text/xml

Sample: 
<ProductVendorRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <vendorCode>V007</vendorCode>
  <vendorStyle>Style 7</vendorStyle>
  <vendorPartNumber>VP007</vendorPartNumber>
  <vendorName>Vendor 7</vendorName>
  <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
  <caseCost xsi:nil="true" />
  <caseSize xsi:nil="true" />
  <preferredGM xsi:nil="true" />
  <allowEndDate xsi:nil="true" />
  <allowStartDate xsi:nil="true" />
  <allowance xsi:nil="true" />
  <netCaseCost xsi:nil="true" />
  <orderTrigger xsi:nil="true" />
  <maxOrderAmt xsi:nil="true" />
  <minInvAmt xsi:nil="true" />
  <invOnOrder xsi:nil="true" />
  <orderDate xsi:nil="true" />
  <returnDays xsi:nil="true" />
  <productCode>00000000000099</productCode>
</ProductVendorRequest>

Response Information

Resource Description

Returns a HTTPResponse Message stating the success/failure of API Action

HttpResponseMessage
NameDescriptionType
Version

Version
Content

HttpContent
StatusCode

HttpStatusCode
ReasonPhrase

string
Headers

Collection of Object
RequestMessage

HttpRequestMessage
IsSuccessStatusCode

boolean

Response Formats

application/json, text/json

Sample: 
{
  "message": "Record successfully saved.",
  "propertyName": "Success"
}

application/xml, text/xml

Sample: 
<ApiValidationMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <message>Record successfully saved.</message>
  <propertyName>Success</propertyName>
</ApiValidationMessage>