GET api/PunchOut
Request Information
URI Parameters
None.
Body Parameters
OrderProduct| Name | Description | Type | Additional information |
|---|---|---|---|
| Code | string |
None. |
|
| Description | string |
None. |
|
| Ordered | integer |
None. |
|
| Method | string |
None. |
|
| UnitOfMeasure | string |
None. |
|
| Price | decimal number |
None. |
|
| Cost | decimal number |
None. |
|
| PricePer | byte |
None. |
|
| CostPer | byte |
None. |
|
| VendorCode | string |
None. |
|
| VendorSKU | string |
None. |
|
| HideFromCustomer | boolean |
None. |
|
| DiscountItem | boolean |
None. |
|
| FreightItem | boolean |
None. |
|
| IncludeOnPackingList | boolean |
None. |
|
| ProductLineNumber | byte |
None. |
|
| Category | string |
None. |
|
| ProductType | string |
None. |
|
| ProductShipDateMonth | byte |
None. |
|
| ProductShipDateDay | byte |
None. |
|
| ProductShipDateYear | unsigned integer |
None. |
|
| Matrix | Collection of OrderProductMatrixValue |
None. |
|
| ProductTaxes | OrderProductProductTaxes |
None. |
|
| ProductSalespersons | OrderProductProductSalespersons |
None. |
|
| Artworks | Object |
None. |
|
| ProductInstructions | OrderProductProductInstructions |
None. |
|
| FromCompany | string |
None. |
|
| FromAttention | string |
None. |
|
| FromAddress1 | string |
None. |
|
| FromAddress2 | string |
None. |
|
| FromCity | string |
None. |
|
| FromState | string |
None. |
|
| FromZip | string |
None. |
|
| FromCounty | Object |
None. |
|
| FromCountry | string |
None. |
|
| FromPhone | string |
None. |
|
| FromPhoneExt | Object |
None. |
|
| FromFax | string |
None. |
|
| FromFaxExt | Object |
None. |
|
| FromCell | Object |
None. |
|
| FromCellExt | Object |
None. |
|
| FromEmail | string |
None. |
|
| FromWeb | string |
None. |
|
| ToCompany | string |
None. |
|
| ToAttention | string |
None. |
|
| ToAddress1 | string |
None. |
|
| ToAddress2 | Object |
None. |
|
| ToCity | string |
None. |
|
| ToState | string |
None. |
|
| ToZip | string |
None. |
|
| ToCounty | Object |
None. |
|
| ToCountry | string |
None. |
|
| ToPhone | string |
None. |
|
| ToPhoneExt | Object |
None. |
|
| ToFax | Object |
None. |
|
| ToFaxExt | Object |
None. |
|
| ToCell | Object |
None. |
|
| ToCellExt | Object |
None. |
|
| ToEmail | string |
None. |
|
| ToWeb | Object |
None. |
|
| AdditionalCharges | Collection of OrderProductAdditionalCharge |
None. |
Request Formats
application/json, text/json
Sample:
{
"codeField": "sample string 1",
"descriptionField": "sample string 2",
"orderedField": 3,
"methodField": "sample string 4",
"unitOfMeasureField": "sample string 5",
"priceField": 6.0,
"costField": 7.0,
"pricePerField": 64,
"costPerField": 64,
"vendorCodeField": "sample string 10",
"vendorCodeFieldSpecified": true,
"vendorSKUField": "sample string 12",
"hideFromCustomerField": true,
"discountItemField": true,
"freightItemField": true,
"includeOnPackingListField": true,
"productLineNumberField": 64,
"categoryField": "sample string 18",
"productTypeField": "sample string 19",
"productShipDateMonthField": 64,
"productShipDateMonthFieldSpecified": true,
"productShipDateDayField": 64,
"productShipDateDayFieldSpecified": true,
"productShipDateYearField": 24,
"productShipDateYearFieldSpecified": true,
"matrixField": [
{
"rowDescriptionField": "sample string 1",
"rowSequenceField": 64,
"columnDescriptionField": "sample string 3",
"columnSequenceField": 64,
"quantityField": 5,
"priceUpChargeField": 6.0,
"costUpChargeField": 7.0
},
{
"rowDescriptionField": "sample string 1",
"rowSequenceField": 64,
"columnDescriptionField": "sample string 3",
"columnSequenceField": 64,
"quantityField": 5,
"priceUpChargeField": 6.0,
"costUpChargeField": 7.0
}
],
"productTaxesField": {
"productTaxField": {
"taxCodeField": 1,
"taxDescriptionField": "sample string 2",
"reportField": true,
"isTaxableField": true,
"taxRateField": 5.0
}
},
"productSalespersonsField": {
"productSalespersonField": {
"salespersonCodeField": "sample string 1",
"salerspersonNameField": "sample string 2",
"commissionPercentField": 3.0
}
},
"artworksField": {},
"productInstructionsField": {
"purchaseOrderField": "sample string 1"
},
"fromCompanyField": "sample string 27",
"fromAttentionField": "sample string 28",
"fromAddress1Field": "sample string 29",
"fromAddress2Field": "sample string 30",
"fromCityField": "sample string 31",
"fromStateField": "sample string 32",
"fromZipField": "sample string 33",
"fromCountyField": {},
"fromCountryField": "sample string 35",
"fromPhoneField": "sample string 36",
"fromPhoneExtField": {},
"fromFaxField": "sample string 38",
"fromFaxExtField": {},
"fromCellField": {},
"fromCellExtField": {},
"fromEmailField": "sample string 42",
"fromWebField": "sample string 43",
"toCompanyField": "sample string 44",
"toAttentionField": "sample string 45",
"toAddress1Field": "sample string 46",
"toAddress2Field": {},
"toCityField": "sample string 48",
"toStateField": "sample string 49",
"toZipField": "sample string 50",
"toCountyField": {},
"toCountryField": "sample string 52",
"toPhoneField": "sample string 53",
"toPhoneExtField": {},
"toFaxField": {},
"toFaxExtField": {},
"toCellField": {},
"toCellExtField": {},
"toEmailField": "sample string 59",
"toWebField": {},
"additionalChargesField": [
{
"codeField": "sample string 1",
"descriptionField": "sample string 2",
"orderedField": 3,
"methodField": "sample string 4",
"unitOfMeasureField": "sample string 5",
"priceField": 6.0,
"costField": 7.0,
"pricePerField": 64,
"costPerField": 64,
"vendorCodeField": "sample string 10",
"vendorSKUField": "sample string 11",
"hideFromCustomerField": true,
"discountItemField": true,
"freightItemField": true,
"includeOnPackingListField": true,
"productLineNumberField": 64,
"categoryField": "sample string 17",
"productShipDateMonthField": 64,
"productShipDateDayField": 64,
"productShipDateYearField": 20,
"matrixField": [
{
"rowDescriptionField": "sample string 1",
"rowSequenceField": 64,
"columnDescriptionField": "sample string 3",
"columnSequenceField": 64,
"quantityField": 5,
"priceUpChargeField": 6.0,
"costUpChargeField": 7.0
},
{
"rowDescriptionField": "sample string 1",
"rowSequenceField": 64,
"columnDescriptionField": "sample string 3",
"columnSequenceField": 64,
"quantityField": 5,
"priceUpChargeField": 6.0,
"costUpChargeField": 7.0
}
],
"productTaxesField": {
"productTaxField": {
"taxCodeField": 1,
"taxDescriptionField": "sample string 2",
"reportField": true,
"isTaxableField": true,
"taxRateField": 5.0
}
},
"productSalespersonsField": {
"productSalespersonField": {
"salespersonCodeField": "sample string 1",
"salerspersonNameField": "sample string 2",
"commissionPercentField": 3.0
}
},
"artworksField": {},
"productInstructionsField": {
"purchaseOrderField": "sample string 1",
"orderInternalField": "sample string 2"
},
"fromCompanyField": "sample string 22",
"fromAttentionField": {},
"fromAddress1Field": "sample string 24",
"fromAddress2Field": {},
"fromCityField": "sample string 26",
"fromStateField": "sample string 27",
"fromZipField": "sample string 28",
"fromCountyField": {},
"fromCountryField": "sample string 30",
"fromPhoneField": "sample string 31",
"fromPhoneExtField": {},
"fromFaxField": "sample string 33",
"fromFaxExtField": {},
"fromCellField": {},
"fromCellExtField": {},
"fromEmailField": "sample string 37",
"fromWebField": "sample string 38",
"toCompanyField": "sample string 39",
"toAttentionField": "sample string 40",
"toAddress1Field": "sample string 41",
"toAddress2Field": {},
"toCityField": "sample string 43",
"toStateField": "sample string 44",
"toZipField": "sample string 45",
"toCountyField": {},
"toCountryField": "sample string 47",
"toPhoneField": "sample string 48",
"toPhoneExtField": {},
"toFaxField": "sample string 50",
"toFaxExtField": {},
"toCellField": {},
"toCellExtField": {},
"toEmailField": "sample string 54",
"toWebField": "sample string 55"
},
{
"codeField": "sample string 1",
"descriptionField": "sample string 2",
"orderedField": 3,
"methodField": "sample string 4",
"unitOfMeasureField": "sample string 5",
"priceField": 6.0,
"costField": 7.0,
"pricePerField": 64,
"costPerField": 64,
"vendorCodeField": "sample string 10",
"vendorSKUField": "sample string 11",
"hideFromCustomerField": true,
"discountItemField": true,
"freightItemField": true,
"includeOnPackingListField": true,
"productLineNumberField": 64,
"categoryField": "sample string 17",
"productShipDateMonthField": 64,
"productShipDateDayField": 64,
"productShipDateYearField": 20,
"matrixField": [
{
"rowDescriptionField": "sample string 1",
"rowSequenceField": 64,
"columnDescriptionField": "sample string 3",
"columnSequenceField": 64,
"quantityField": 5,
"priceUpChargeField": 6.0,
"costUpChargeField": 7.0
},
{
"rowDescriptionField": "sample string 1",
"rowSequenceField": 64,
"columnDescriptionField": "sample string 3",
"columnSequenceField": 64,
"quantityField": 5,
"priceUpChargeField": 6.0,
"costUpChargeField": 7.0
}
],
"productTaxesField": {
"productTaxField": {
"taxCodeField": 1,
"taxDescriptionField": "sample string 2",
"reportField": true,
"isTaxableField": true,
"taxRateField": 5.0
}
},
"productSalespersonsField": {
"productSalespersonField": {
"salespersonCodeField": "sample string 1",
"salerspersonNameField": "sample string 2",
"commissionPercentField": 3.0
}
},
"artworksField": {},
"productInstructionsField": {
"purchaseOrderField": "sample string 1",
"orderInternalField": "sample string 2"
},
"fromCompanyField": "sample string 22",
"fromAttentionField": {},
"fromAddress1Field": "sample string 24",
"fromAddress2Field": {},
"fromCityField": "sample string 26",
"fromStateField": "sample string 27",
"fromZipField": "sample string 28",
"fromCountyField": {},
"fromCountryField": "sample string 30",
"fromPhoneField": "sample string 31",
"fromPhoneExtField": {},
"fromFaxField": "sample string 33",
"fromFaxExtField": {},
"fromCellField": {},
"fromCellExtField": {},
"fromEmailField": "sample string 37",
"fromWebField": "sample string 38",
"toCompanyField": "sample string 39",
"toAttentionField": "sample string 40",
"toAddress1Field": "sample string 41",
"toAddress2Field": {},
"toCityField": "sample string 43",
"toStateField": "sample string 44",
"toZipField": "sample string 45",
"toCountyField": {},
"toCountryField": "sample string 47",
"toPhoneField": "sample string 48",
"toPhoneExtField": {},
"toFaxField": "sample string 50",
"toFaxExtField": {},
"toCellField": {},
"toCellExtField": {},
"toEmailField": "sample string 54",
"toWebField": "sample string 55"
}
]
}
application/x-www-form-urlencoded
Sample:
Sample not available.
application/xml, text/xml
Sample:
<OrderProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/">
<additionalChargesField>
<OrderProductAdditionalCharge>
<artworksField />
<categoryField>sample string 17</categoryField>
<codeField>sample string 1</codeField>
<costField>7</costField>
<costPerField>64</costPerField>
<descriptionField>sample string 2</descriptionField>
<discountItemField>true</discountItemField>
<freightItemField>true</freightItemField>
<fromAddress1Field>sample string 24</fromAddress1Field>
<fromAddress2Field />
<fromAttentionField />
<fromCellExtField />
<fromCellField />
<fromCityField>sample string 26</fromCityField>
<fromCompanyField>sample string 22</fromCompanyField>
<fromCountryField>sample string 30</fromCountryField>
<fromCountyField />
<fromEmailField>sample string 37</fromEmailField>
<fromFaxExtField />
<fromFaxField>sample string 33</fromFaxField>
<fromPhoneExtField />
<fromPhoneField>sample string 31</fromPhoneField>
<fromStateField>sample string 27</fromStateField>
<fromWebField>sample string 38</fromWebField>
<fromZipField>sample string 28</fromZipField>
<hideFromCustomerField>true</hideFromCustomerField>
<includeOnPackingListField>true</includeOnPackingListField>
<matrixField>
<OrderProductAdditionalChargeMatrixValue>
<columnDescriptionField>sample string 3</columnDescriptionField>
<columnSequenceField>64</columnSequenceField>
<costUpChargeField>7</costUpChargeField>
<priceUpChargeField>6</priceUpChargeField>
<quantityField>5</quantityField>
<rowDescriptionField>sample string 1</rowDescriptionField>
<rowSequenceField>64</rowSequenceField>
</OrderProductAdditionalChargeMatrixValue>
<OrderProductAdditionalChargeMatrixValue>
<columnDescriptionField>sample string 3</columnDescriptionField>
<columnSequenceField>64</columnSequenceField>
<costUpChargeField>7</costUpChargeField>
<priceUpChargeField>6</priceUpChargeField>
<quantityField>5</quantityField>
<rowDescriptionField>sample string 1</rowDescriptionField>
<rowSequenceField>64</rowSequenceField>
</OrderProductAdditionalChargeMatrixValue>
</matrixField>
<methodField>sample string 4</methodField>
<orderedField>3</orderedField>
<priceField>6</priceField>
<pricePerField>64</pricePerField>
<productInstructionsField>
<orderInternalField>sample string 2</orderInternalField>
<purchaseOrderField>sample string 1</purchaseOrderField>
</productInstructionsField>
<productLineNumberField>64</productLineNumberField>
<productSalespersonsField>
<productSalespersonField>
<commissionPercentField>3</commissionPercentField>
<salerspersonNameField>sample string 2</salerspersonNameField>
<salespersonCodeField>sample string 1</salespersonCodeField>
</productSalespersonField>
</productSalespersonsField>
<productShipDateDayField>64</productShipDateDayField>
<productShipDateMonthField>64</productShipDateMonthField>
<productShipDateYearField>20</productShipDateYearField>
<productTaxesField>
<productTaxField>
<isTaxableField>true</isTaxableField>
<reportField>true</reportField>
<taxCodeField>1</taxCodeField>
<taxDescriptionField>sample string 2</taxDescriptionField>
<taxRateField>5</taxRateField>
</productTaxField>
</productTaxesField>
<toAddress1Field>sample string 41</toAddress1Field>
<toAddress2Field />
<toAttentionField>sample string 40</toAttentionField>
<toCellExtField />
<toCellField />
<toCityField>sample string 43</toCityField>
<toCompanyField>sample string 39</toCompanyField>
<toCountryField>sample string 47</toCountryField>
<toCountyField />
<toEmailField>sample string 54</toEmailField>
<toFaxExtField />
<toFaxField>sample string 50</toFaxField>
<toPhoneExtField />
<toPhoneField>sample string 48</toPhoneField>
<toStateField>sample string 44</toStateField>
<toWebField>sample string 55</toWebField>
<toZipField>sample string 45</toZipField>
<unitOfMeasureField>sample string 5</unitOfMeasureField>
<vendorCodeField>sample string 10</vendorCodeField>
<vendorSKUField>sample string 11</vendorSKUField>
</OrderProductAdditionalCharge>
<OrderProductAdditionalCharge>
<artworksField />
<categoryField>sample string 17</categoryField>
<codeField>sample string 1</codeField>
<costField>7</costField>
<costPerField>64</costPerField>
<descriptionField>sample string 2</descriptionField>
<discountItemField>true</discountItemField>
<freightItemField>true</freightItemField>
<fromAddress1Field>sample string 24</fromAddress1Field>
<fromAddress2Field />
<fromAttentionField />
<fromCellExtField />
<fromCellField />
<fromCityField>sample string 26</fromCityField>
<fromCompanyField>sample string 22</fromCompanyField>
<fromCountryField>sample string 30</fromCountryField>
<fromCountyField />
<fromEmailField>sample string 37</fromEmailField>
<fromFaxExtField />
<fromFaxField>sample string 33</fromFaxField>
<fromPhoneExtField />
<fromPhoneField>sample string 31</fromPhoneField>
<fromStateField>sample string 27</fromStateField>
<fromWebField>sample string 38</fromWebField>
<fromZipField>sample string 28</fromZipField>
<hideFromCustomerField>true</hideFromCustomerField>
<includeOnPackingListField>true</includeOnPackingListField>
<matrixField>
<OrderProductAdditionalChargeMatrixValue>
<columnDescriptionField>sample string 3</columnDescriptionField>
<columnSequenceField>64</columnSequenceField>
<costUpChargeField>7</costUpChargeField>
<priceUpChargeField>6</priceUpChargeField>
<quantityField>5</quantityField>
<rowDescriptionField>sample string 1</rowDescriptionField>
<rowSequenceField>64</rowSequenceField>
</OrderProductAdditionalChargeMatrixValue>
<OrderProductAdditionalChargeMatrixValue>
<columnDescriptionField>sample string 3</columnDescriptionField>
<columnSequenceField>64</columnSequenceField>
<costUpChargeField>7</costUpChargeField>
<priceUpChargeField>6</priceUpChargeField>
<quantityField>5</quantityField>
<rowDescriptionField>sample string 1</rowDescriptionField>
<rowSequenceField>64</rowSequenceField>
</OrderProductAdditionalChargeMatrixValue>
</matrixField>
<methodField>sample string 4</methodField>
<orderedField>3</orderedField>
<priceField>6</priceField>
<pricePerField>64</pricePerField>
<productInstructionsField>
<orderInternalField>sample string 2</orderInternalField>
<purchaseOrderField>sample string 1</purchaseOrderField>
</productInstructionsField>
<productLineNumberField>64</productLineNumberField>
<productSalespersonsField>
<productSalespersonField>
<commissionPercentField>3</commissionPercentField>
<salerspersonNameField>sample string 2</salerspersonNameField>
<salespersonCodeField>sample string 1</salespersonCodeField>
</productSalespersonField>
</productSalespersonsField>
<productShipDateDayField>64</productShipDateDayField>
<productShipDateMonthField>64</productShipDateMonthField>
<productShipDateYearField>20</productShipDateYearField>
<productTaxesField>
<productTaxField>
<isTaxableField>true</isTaxableField>
<reportField>true</reportField>
<taxCodeField>1</taxCodeField>
<taxDescriptionField>sample string 2</taxDescriptionField>
<taxRateField>5</taxRateField>
</productTaxField>
</productTaxesField>
<toAddress1Field>sample string 41</toAddress1Field>
<toAddress2Field />
<toAttentionField>sample string 40</toAttentionField>
<toCellExtField />
<toCellField />
<toCityField>sample string 43</toCityField>
<toCompanyField>sample string 39</toCompanyField>
<toCountryField>sample string 47</toCountryField>
<toCountyField />
<toEmailField>sample string 54</toEmailField>
<toFaxExtField />
<toFaxField>sample string 50</toFaxField>
<toPhoneExtField />
<toPhoneField>sample string 48</toPhoneField>
<toStateField>sample string 44</toStateField>
<toWebField>sample string 55</toWebField>
<toZipField>sample string 45</toZipField>
<unitOfMeasureField>sample string 5</unitOfMeasureField>
<vendorCodeField>sample string 10</vendorCodeField>
<vendorSKUField>sample string 11</vendorSKUField>
</OrderProductAdditionalCharge>
</additionalChargesField>
<artworksField />
<categoryField>sample string 18</categoryField>
<codeField>sample string 1</codeField>
<costField>7</costField>
<costPerField>64</costPerField>
<descriptionField>sample string 2</descriptionField>
<discountItemField>true</discountItemField>
<freightItemField>true</freightItemField>
<fromAddress1Field>sample string 29</fromAddress1Field>
<fromAddress2Field>sample string 30</fromAddress2Field>
<fromAttentionField>sample string 28</fromAttentionField>
<fromCellExtField />
<fromCellField />
<fromCityField>sample string 31</fromCityField>
<fromCompanyField>sample string 27</fromCompanyField>
<fromCountryField>sample string 35</fromCountryField>
<fromCountyField />
<fromEmailField>sample string 42</fromEmailField>
<fromFaxExtField />
<fromFaxField>sample string 38</fromFaxField>
<fromPhoneExtField />
<fromPhoneField>sample string 36</fromPhoneField>
<fromStateField>sample string 32</fromStateField>
<fromWebField>sample string 43</fromWebField>
<fromZipField>sample string 33</fromZipField>
<hideFromCustomerField>true</hideFromCustomerField>
<includeOnPackingListField>true</includeOnPackingListField>
<matrixField>
<OrderProductMatrixValue>
<columnDescriptionField>sample string 3</columnDescriptionField>
<columnSequenceField>64</columnSequenceField>
<costUpChargeField>7</costUpChargeField>
<priceUpChargeField>6</priceUpChargeField>
<quantityField>5</quantityField>
<rowDescriptionField>sample string 1</rowDescriptionField>
<rowSequenceField>64</rowSequenceField>
</OrderProductMatrixValue>
<OrderProductMatrixValue>
<columnDescriptionField>sample string 3</columnDescriptionField>
<columnSequenceField>64</columnSequenceField>
<costUpChargeField>7</costUpChargeField>
<priceUpChargeField>6</priceUpChargeField>
<quantityField>5</quantityField>
<rowDescriptionField>sample string 1</rowDescriptionField>
<rowSequenceField>64</rowSequenceField>
</OrderProductMatrixValue>
</matrixField>
<methodField>sample string 4</methodField>
<orderedField>3</orderedField>
<priceField>6</priceField>
<pricePerField>64</pricePerField>
<productInstructionsField>
<purchaseOrderField>sample string 1</purchaseOrderField>
</productInstructionsField>
<productLineNumberField>64</productLineNumberField>
<productSalespersonsField>
<productSalespersonField>
<commissionPercentField>3</commissionPercentField>
<salerspersonNameField>sample string 2</salerspersonNameField>
<salespersonCodeField>sample string 1</salespersonCodeField>
</productSalespersonField>
</productSalespersonsField>
<productShipDateDayField>64</productShipDateDayField>
<productShipDateDayFieldSpecified>true</productShipDateDayFieldSpecified>
<productShipDateMonthField>64</productShipDateMonthField>
<productShipDateMonthFieldSpecified>true</productShipDateMonthFieldSpecified>
<productShipDateYearField>24</productShipDateYearField>
<productShipDateYearFieldSpecified>true</productShipDateYearFieldSpecified>
<productTaxesField>
<productTaxField>
<isTaxableField>true</isTaxableField>
<reportField>true</reportField>
<taxCodeField>1</taxCodeField>
<taxDescriptionField>sample string 2</taxDescriptionField>
<taxRateField>5</taxRateField>
</productTaxField>
</productTaxesField>
<productTypeField>sample string 19</productTypeField>
<toAddress1Field>sample string 46</toAddress1Field>
<toAddress2Field />
<toAttentionField>sample string 45</toAttentionField>
<toCellExtField />
<toCellField />
<toCityField>sample string 48</toCityField>
<toCompanyField>sample string 44</toCompanyField>
<toCountryField>sample string 52</toCountryField>
<toCountyField />
<toEmailField>sample string 59</toEmailField>
<toFaxExtField />
<toFaxField />
<toPhoneExtField />
<toPhoneField>sample string 53</toPhoneField>
<toStateField>sample string 49</toStateField>
<toWebField />
<toZipField>sample string 50</toZipField>
<unitOfMeasureField>sample string 5</unitOfMeasureField>
<vendorCodeField>sample string 10</vendorCodeField>
<vendorCodeFieldSpecified>true</vendorCodeFieldSpecified>
<vendorSKUField>sample string 12</vendorSKUField>
</OrderProduct>
Response Information
Resource Description
stringResponse Formats
application/json, text/json
Sample:
"sample string 1"
application/xml, text/xml
Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>