CompletePurchaseLinesByPO API Reference

Documentation:

The CompletePurchaseLinesByPO method(s) allow you to checkout and finalize your purchase by providing the purchase order identifier provided when placing the order. You can access this method either through SOAP Services or the REST API.

SOAP Method: CompletePurchaseLinesByPO

REST Request: POST api/Ordering/CompletePurchaseLinesByPO

Properties

DataType: PurchaseRequest

NameDescriptionTypeAdditional information
PoNumber

string

None.

References

Collection of integer

None.

DataType: CompletePurchaseResponse
Parameters:
NameDescriptionTypeAdditional information
Value

integer

None.

Successful

boolean

None.

Messages

Collection of string

None.

Request Samples

application/json, text/json

Sample:
{
  "poNumber": "sample string 1",
  "references": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<PurchaseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartsSource.Api.Model">
  <PoNumber>sample string 1</PoNumber>
  <References xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </References>
</PurchaseRequest>

application/x-www-form-urlencoded

Sample: Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PurchaseRequest'.

Response Samples

application/json, text/json

Sample:
{
  "value": 1,
  "successful": true,
  "messages": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<CompletePurchaseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartsSource.Api.Model">
  <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Messages>
  <Successful>true</Successful>
  <Value>1</Value>
</CompletePurchaseResponse>