FloorFound API (1.0)

Download OpenAPI specification:Download

URL: https://api-dev.floorfound.com

This is a RESTful API for interacting with the FloorFound system.

Products

All about /v1/products

Get Products

Get Product array with pagination

Authorizations:

ApiKeyAuth

query Parameters

skip	integer
take	integer

Responses

Response samples

200

Content type

application/json

{"total": 0,
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"sku": "string",
"upc": "string",
"description": "string",
"referenceUrl": "string",
"brand": "string",
"category": "string",
"subCategory": "string",
"assembledWeight": 0,
"assembledWidth": 0,
"assembledHeight": 0,
"assembledDepth": 0,
"listPrice": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"shippingCartons": [{"width": 0,
"height": 0,
"depth": 0,
"weight": 0
}
]
}
]
}

Get Product by ID

Get Product by ID, which can either be the UUID or SKU of the product in the FloorFound system.

Authorizations:

ApiKeyAuth

path Parameters

productId

required

string

Responses

Response samples

200

Content type

application/json

{"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"sku": "string",
"upc": "string",
"description": "string",
"referenceUrl": "string",
"brand": "string",
"category": "string",
"subCategory": "string",
"assembledWeight": 0,
"assembledWidth": 0,
"assembledHeight": 0,
"assembledDepth": 0,
"listPrice": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"shippingCartons": [{"width": 0,
"height": 0,
"depth": 0,
"weight": 0
}
]
}
}

RecommerceRequests

All about /v1/recommerce-requests

Get Recommerce Requests

Get paginated list of recommerce requests that have not been archived. List is sorted by created date in descending order.

Authorizations:

ApiKeyAuth

query Parameters

skip	integer
take	integer

Responses

Response samples

200

Content type

application/json

{"total": 0,
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"referenceNumbers": ["string"
],
"shortId": "string",
"status": "string",
"trackingNumber": "string",
"returnMethodType": "FLOORFOUND",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"customer": {"email": "string",
"phone": "string",
"phoneExt": "string",
"firstName": "string",
"lastName": "string",
"businessName": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"locationType": "RESIDENTIAL"
},
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"ffid": "string",
"status": "string",
"referenceNumbers": ["string"
],
"trackingNumbers": ["string"
],
"product": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"sku": "string",
"upc": "string",
"description": "string",
"referenceUrl": "string",
"brand": "string",
"category": "string",
"subCategory": "string",
"assembledWeight": 0,
"assembledWidth": 0,
"assembledHeight": 0,
"assembledDepth": 0,
"listPrice": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"shippingCartons": [{"width": 0,
"height": 0,
"depth": 0,
"weight": 0
}
]
},
"customerImages": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"url": "string"
}
],
"inspectionImages": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"url": "string"
}
]
}
]
}
]
}

Get a Recommerce Request by ID

Get a Recommerce Request by ID, which can either be the UUID or Short ID of the recommerce request in the FloorFound system.

Authorizations:

ApiKeyAuth

path Parameters

recommerceRequestId

required

string

Responses

Response samples

200

Content type

application/json

{"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"referenceNumbers": ["string"
],
"shortId": "string",
"status": "string",
"trackingNumber": "string",
"returnMethodType": "FLOORFOUND",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"customer": {"email": "string",
"phone": "string",
"phoneExt": "string",
"firstName": "string",
"lastName": "string",
"businessName": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"locationType": "RESIDENTIAL"
},
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"ffid": "string",
"status": "string",
"referenceNumbers": ["string"
],
"trackingNumbers": ["string"
],
"product": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"sku": "string",
"upc": "string",
"description": "string",
"referenceUrl": "string",
"brand": "string",
"category": "string",
"subCategory": "string",
"assembledWeight": 0,
"assembledWidth": 0,
"assembledHeight": 0,
"assembledDepth": 0,
"listPrice": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"shippingCartons": [{"width": 0,
"height": 0,
"depth": 0,
"weight": 0
}
]
},
"customerImages": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"url": "string"
}
],
"inspectionImages": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"url": "string"
}
]
}
]
}
}

Items

All about /v1/items

Get Items

Get paginated list of items that have not been invalidated. List is sorted by created date in descending order.

Authorizations:

ApiKeyAuth

query Parameters

skip	integer
take	integer

Responses

Response samples

200

Content type

application/json

{"total": 0,
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"ffid": "string",
"status": "string",
"referenceNumbers": ["string"
],
"trackingNumbers": ["string"
],
"product": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"sku": "string",
"upc": "string",
"description": "string",
"referenceUrl": "string",
"brand": "string",
"category": "string",
"subCategory": "string",
"assembledWeight": 0,
"assembledWidth": 0,
"assembledHeight": 0,
"assembledDepth": 0,
"listPrice": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"shippingCartons": [{"width": 0,
"height": 0,
"depth": 0,
"weight": 0
}
]
},
"customerImages": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"url": "string"
}
],
"inspectionImages": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"url": "string"
}
]
}
]
}

Get an Item by ID

Get an Item by ID, which can either be the UUID or FFID of the item in the FloorFound system.

Authorizations:

ApiKeyAuth

path Parameters

itemId

required

string

Responses

Response samples

200

Content type

application/json

{"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"ffid": "string",
"status": "string",
"referenceNumbers": ["string"
],
"trackingNumbers": ["string"
],
"product": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"sku": "string",
"upc": "string",
"description": "string",
"referenceUrl": "string",
"brand": "string",
"category": "string",
"subCategory": "string",
"assembledWeight": 0,
"assembledWidth": 0,
"assembledHeight": 0,
"assembledDepth": 0,
"listPrice": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"shippingCartons": [{"width": 0,
"height": 0,
"depth": 0,
"weight": 0
}
]
},
"customerImages": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"url": "string"
}
],
"inspectionImages": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"url": "string"
}
]
}
}