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
  • Get Products
  • Response Parameters

Was this helpful?

Export as PDF
  1. API Reference
  2. Products

Get Products

Returns all vendor's products

Get Products

GET https://apis.sandbox.flexshopper.com/v3/products

This endpoint allows you to get all products associated to a vendor

Query Parameters

Name
Type
Description

page

string

Page number. If not sent, the first page is returned.

Headers

Name
Type
Description

Authorization

string

Authentication token unique for a vendor

{
  "data": {
    "products": [
      {
        "sku": "MPN123XYZ",
        "name": "Computer 1 with RAM and SSD",
        "url": "https://flexshopper.com/product/this-cool-product"
      }
    ]
  }
}Response Parameters
A successful request returns the HTTP 200 OK status code and a JSON response body that shows all transactions created.
Key
Type
Description
transactions
Array
The list transactions.
transactions.id
Number
Transaction id
transactions.createAt
Date
Transaction creation date
transactions.shippingCost
Number
Total Shipping Cost
transactions.items
Array
The list items.
transactions.items.quantity
Number
Item quantity.
transactions.items.quantityByStatus
Object
Quantity of items grouped by status. Ex. { signed: 1}
transactions.items.cost
Number
Item cost
transactions.items.description
String
Item description
transactions.items.brand
String
Item's brand
meta
Object
Result metadata
meta.count
Number
Amount of transactions
meta.totalPages
Number
Total number of pages
meta.page
Number
Current page
meta.limit
Number
Page size

Response Parameters

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all products for a given vendor.

Key

Type

Description

products

Array

The list of products.

products.sku

String

A unique identifier for the product

products.name

String

The name of the product

products.url

Number

The URL of the product in FlexShopper marketplace

PreviousProductsNextSettings

Last updated 4 years ago

Was this helpful?