POST api/Merchant/v1/UpdatePurchaseDelivered

Method updates the purchase delivered for end customer and triggers the payment and invoice delivery.

Request Information

URI Parameters

None.

Body Parameters

UpdatePurchaseDeliveredRequest
NameDescriptionTypeAdditional information
purchaseId

Id of purchase (M)

globally unique identifier

None.

OrganizationCode

string

None.

UserName

string

None.

Password

string

None.

Request Formats

application/json, text/json

Sample:
{
  "purchaseId": "b0a14ec5-08d2-4e7d-8e0e-dfb41704ed02",
  "OrganizationCode": "sample string 2",
  "UserName": "sample string 3",
  "Password": "sample string 4"
}

application/xml, text/xml

Sample:
<UpdatePurchaseDeliveredRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers.Merchant">
  <OrganizationCode xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 2</OrganizationCode>
  <Password xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 4</Password>
  <UserName xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 3</UserName>
  <purchaseId>b0a14ec5-08d2-4e7d-8e0e-dfb41704ed02</purchaseId>
</UpdatePurchaseDeliveredRequest>

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 'UpdatePurchaseDeliveredRequest'.

Response Information

Resource Description

UpdatePurchaseDeliveredReply
NameDescriptionTypeAdditional information
Reply

PurchaseReply

None.

Ok

boolean

None.

ErrorMessage

string

None.

ErrorCode

string

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Reply": {
    "Id": "3478c3fb-9980-4baf-9dc7-03304808bf37",
    "PurchaseProcessUrl": "sample string 2",
    "Status": 0
  },
  "Ok": true,
  "ErrorMessage": "sample string 2",
  "ErrorCode": "sample string 3",
  "Message": "sample string 4"
}

application/xml, text/xml

Sample:
<UpdatePurchaseDeliveredReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers.Merchant">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 3</ErrorCode>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 2</ErrorMessage>
  <Message xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 4</Message>
  <Ok xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">true</Ok>
  <Reply>
    <Id>3478c3fb-9980-4baf-9dc7-03304808bf37</Id>
    <PurchaseProcessUrl>sample string 2</PurchaseProcessUrl>
    <Status>Ok</Status>
  </Reply>
</UpdatePurchaseDeliveredReply>