POST api/v7/PrePacks

Accepts prePack information from a client.

Tables Impacted

PrePack, PrePackProduct

Request Information

URI Parameters

None.

Body Parameters

PrePack information to insert/create in db

PrePack
NameDescriptionTypeRequired?Additional information
prePackCode *

The PrePackCode is the SKU/Product Code for the prepack

string

Yes

String length: between 1 and 30, inclusive

prePackDescription

The name/description for the prepack

string

No

String length: between 1 and 128, inclusive

prePackProducts

The list of products and counts for the prepack

Collection of PrePackProduct

No

None.

customerAuditDate

Audit information

date

No

None.

Request Formats

application/json, text/json

Sample:
{
  "prePackCode": "sample string 1",
  "prePackDescription": "sample string 2",
  "prePackProducts": [
    {
      "productCode": "sample string 1",
      "count": 2
    },
    {
      "productCode": "sample string 1",
      "count": 2
    }
  ],
  "customerAuditDate": "2018-01-01T00:00:00"
}

application/xml, text/xml

Sample:
<PrePack xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <prePackCode>sample string 1</prePackCode>
  <prePackDescription>sample string 2</prePackDescription>
  <prePackProducts>
    <PrePackProduct>
      <productCode>sample string 1</productCode>
      <count>2</count>
    </PrePackProduct>
    <PrePackProduct>
      <productCode>sample string 1</productCode>
      <count>2</count>
    </PrePackProduct>
  </prePackProducts>
  <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
</PrePack>

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