Cancel Items
Cancel items from a transaction.
/v3/transactions/{transactionId}/cancel
POST
https://apis.sandbox.flexshopper.com/v3/transactions/{transactionId}/cancel
Path Parameters
Name | Type | Description |
---|---|---|
transactionId | string | The transaction ID provided at lease generation. |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Authorization token |
Request Body
Name | Type | Description |
---|---|---|
items | array | The list of items to be canceled. |
items.sku | string | The SKU to cancel. |
items.quantity | string | The quantity to cancel; defaults to the number ordered if not present.
For example, if a customer ordered three of an item and wanted to cancel just two, |
Response Parameters
A successful request returns the HTTP 200 OK
status code and a JSON response body that shows the lease info
Key | Type | Description |
canceled | Array | The list of successfully canceled items. |
canceled.sku | String | The SKU canceled. |
items.quantity | Number | The quantity to canceled. |
failed | Array | The list of faled cancels. |
failed.sku | String | The SKU that failed to be canceled. |
failed.quantity | Number | The quantity of cancels failed for sku. |
If the items field is not provided in the request, all items in the transaction will be canceled.
If an item is present in the items array with no quantity, all of that item will be canceled.
Last updated