FlexShopper API
3.0-legacy
FlexShopper API
3.0-legacy
  • Getting Started
  • Our Platforms
    • FlexPay Payment Platform
    • FlexShopper Backend API
  • API Reference
    • Get Started
      • API Requests
      • API Responses
      • Error Codes
    • User Management
      • Create User
      • Get Users
      • Get User
      • Verify User Exists
      • Deeply Verify User Exists
      • Get LoanPaymentPro Child Key
      • Add Payment Method
    • Customer Authentication
      • Request Passcode
      • Login Customer
    • Customer Application
      • Initiate Application
      • Get Verification Questions
      • Verify Answers
      • Validate Routing Number
    • Lease Management
      • Create Lease
      • Get Lease By ID
      • Sign Lease
      • Checkout
    • Purchase Transactions
      • Get Transactions
      • Get Transaction By ID
      • Cancel Items
      • Return Items
      • Confirm Shipment
      • Confirm Receipt
    • Products
      • Get Products
    • Settings
  • Change Log
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. API Reference
  2. Purchase Transactions

Return Items

Registers a customer returning an item.

/v3/transactions/{transactionId}/return

POST https://apis.sandbox.flexshopper.com/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

Path Parameters

Name
Type
Description

transactionId

string

Transaction Id

Headers

Name
Type
Description

Authorization

string

Authorization token

Request 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.

{
  "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 6 years ago

Was this helpful?