Fair Warning Software API Documentation

You can submit a consignment request by using the following URL and specifying the required parameters.

Method	URL
POST	https://api.fairwarningsoftware.com/v1.1.1/consignment/request

Request
{ "user_id": <user_id>, "last_name": <last_name>, "last_name": <last_name>, "email": <email>, "phone": <phone>, "country_code": <country_code>, "department_id": <department_id>, "item_description": <item_description>, "files": [ { "file" : { "filename" : <filename>, "base64" : <base64> } } ] }

Request

{
        "user_id": <user_id>,
        "last_name": <last_name>,
        "last_name": <last_name>,
        "email": <email>,
        "phone": <phone>,
        "country_code": <country_code>,
        "department_id": <department_id>,
        "item_description": <item_description>,
        "files": [
            {
                  "file" : {
                      "filename" : <filename>,
                      "base64" : <base64>
                  }
            }
        ]
}

Field	Type	Description
user_id	int	The ID of the user if they are signed in.
first_name	string	The first name of the person submitting the consignment request.
last_name	string	The last name of the person submitting the consignment request.
email	string	The email of the person submitting the consignment request.
phone	string	The phone number of the person submitting the consignment request.
country_code	string	The 2-digit country code of the person submitting the consignment request.
department_id	string	The department ID selected for the consignment request.
item_description	string	The description of the item being submitted for a consignment request.
files	object	An array of image files to be submitted with the consignment request.
file	object	An object containing an individual file for the consignment request.
filename	string	The name of the file being submitted.
base64	string	A base64 encoded string representing the file data.

Only 'jpg','jpeg','pjpeg','gif','bmp','png', and 'pdf' file types are allowed.

If successful, a success response will be returned. If not, an error will be returned instead.

Status	Response
200	{ "success": <success> }
401	{"error":"The API keys provided are invalid."}
403	{"error":"API keys are missing."}
500	{"error": <custom error>}

Field	Type	Description
success	bool	Whether or not the request was successful

How to submit a consignment request