FlexShopper API
3.0-preview
FlexShopper API
3.0-preview
  • Integration Guides
    • Medusa
    • Payment Plugin
  • Customer
    • Verify User Exists
    • Deeply Verify User Exists
    • Create User
    • Get Users
    • Get User
    • Create Authorization Token
    • Add Payment Method
      • Get LoanPaymentPro Child Key
      • Get Clover PKMS Key
  • Decision
    • Apply for Spending Limit
  • Lease
    • Create Lease
    • Get Transactions
    • Get Lease By ID
    • Get Transaction By ID
    • Sign Lease
    • Finalize Lease
    • Cancel Items
    • Return Items
    • Confirm Shipment
    • Confirm Receipt
Powered by GitBook
On this page
  • Request
  • Path Parameters
  • Headers
  • Body
  • Response
  • Samples

Was this helpful?

Export as PDF
  1. Lease

Return Items

Registers a customer returning an item.

POST /v3/transactions/:transactionId/return

It returns a list of items registered to return and a list of items requested to returned as failed. Probable causes of failed item requests: * The item does not exists * The item was already returned * The item has not being signed yet \

Request

Path Parameters

Name
Type
Description

transactionId

string

Transaction Id

Headers

Name
Type
Description

Authorization

string

Authorization token

Body

Name
Type
Description

items

array

The list of items to be returned.

items.sku

string

The SKU to return.

items.quantity

integer

The quantity to expect returned; defaults to the number ordered if not present.

Response

Samples

{
  "data": {
    "returned": [
      {
        "sku": "123ASD",
        "quantity": 1
      }
    ],
    "failed": [
      {
        "sku": "123ASD",
        "quantity": 1
      }
    ]
  }
}
{
  "error": {
    "statusCode": 404,
    "code": "TransactionNotFound",
    "message": "The transaction with the provided id was not found",
    "data": {}
  }
}
PreviousCancel ItemsNextConfirm Shipment

Last updated 9 days ago

Was this helpful?