patch https://example.com/orders//transactions//lineItems
The Update Order service is used to update the order lines of an existing order. An order can be updated at any time, both before and after it has been finalized.
This method is used for invoice and installment payments. For returns, remove all line items and add the return fee in a separate call to ensure that all previous fees are removed.
Orders can be updated both before and after they are finalized. If the update is made after the order has been finalized then the update will be finalized immediately. If the update is made before the order has been finalized then the update will not be finalized until the order is finalized.
HTTP Request
PATCH /orders/{orderId}/transactions/{transactionId}/lineItems
Request Parameters
Property | Type | Description |
---|---|---|
operations required | string | Valid Operations: "RemoveLineItem" , "AddLineItem" Add line item To add a new line item use the AddLineItem operation and specify a new unique line item ID.Remove line item To remove a line item use the RemoveLineItem operation and specify the line item ID to remove.Update line item To update an existing line item, include a RemoveLineItem and a AddLineItem operation in the same request and specify the same line item ID in both operations. |
transactionId required | string | The transaction ID of the authorization transaction. |
Response Parameters
status required | status | API operation status. Example: { "isSuccess": true, "errorNumber": 0, "statusKey": "SUCCESS", "statusMessage": "The operation was successful.", "errors": null, "exceptionDetails": null } |
transactionId conditional | string | Paynova's unique identifier associated with this transaction. Conditions: > This parameter is not returned in error situations. |