FloorFound API (0.0.1)

Download OpenAPI specification:Download

URL: https://api-dev.floorfound.com License: Licensed Under MIT

This is a REST API application made with Express.

Products

All about /v0/products

Get Products by Organization

Get Organization Product array with pagination

Authorizations:

ApiKeyAuth

path Parameters

organizationId

required

string <uuid>

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",
"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 Organization's Product by ID

Authorizations:

ApiKeyAuth

path Parameters

organizationId required	string <uuid>
productId required	string <uuid>

Responses

Response samples

200

Content type

application/json

{"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"sku": "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 /v0/recommerce-requests

Get Recommerce Requests by Organization

Get Organization Recommerce Requests array with pagination

Authorizations:

ApiKeyAuth

path Parameters

organizationId

required

string <uuid>

query Parameters

skip	integer
take	integer

Responses

Response samples

200

Content type

application/json

{"total": 0,
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"requestType": "CONSIGNOR",
"referenceNumbers": ["string"
],
"shortId": "string",
"status": "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": [{"ffid": "string",
"productSku": "string",
"packingCondition": "string",
"parcel": true,
"status": "string",
"referenceNumbers": ["string"
],
"inboundShipmentType": "PALLETIZED",
"returnReason": "string"
}
]
}
]
}