Yay.com loading

Loading

  • My Shopping Cart (0) £0.00

  • Register

Customer Management

API Access

Build custom apps using our JSON API

FREE
Get your free API Key

Sub Resellers

Create and Manage Sub Resellers of your account

Get your free API Key

Filter:

  • All
  • GET
  • POST
  • PUT
  • DELETE
  • Chargeable *

* You will be charged every time this command is run.

  • GET/account/reseller

    Gets the details of all active sub resellers on the account

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    Response Details

    200 Response

    {
        "result" : [
            {
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7",
                "name" : "Example Sub Reseller",
                "contact_name" : "Pete's Plumbing and Electrical",
                "allow_outbound" : true,
                "created_on" : "2017-05-28",
                "updated_on" : "2017-05-28",
                "ip_addresses" : [
                    {
                        "ip_range" : "255.255.255.255/32",
                        "created_on" : "2017-05-28"
                    }
                ],
                "users" : [
                    {
                        "role_id" : 1,
                        "name" : "pete_the_plumber",
                        "password" : "password",
                        "email" : "pete@example.com",
                        "contact_first_name" : "Pete",
                        "contact_last_name" : "Plumber",
                        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                        "created_on" : "2017-05-28",
                        "updated_on" : "2017-05-28"
                    }
                ],
                "addresses" : [
                    {
                        "street_one" : "1 Example Street",
                        "street_two" : "",
                        "street_three" : "",
                        "city" : "Exampleton",
                        "state" : "",
                        "zip" : "EX4M PL3",
                        "country_code" : "GB",
                        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                        "created_on" : "2017-05-28",
                        "updated_on" : "2017-05-28"
                    }
                ]
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/account/reseller/{uuid}

    Gets the details for a specific sub reseller on the account

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Sub Reseller to be queried

    Response Details

    200 Response

    {
        "result" : {
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7",
            "name" : "Example Sub Reseller",
            "contact_name" : "Pete's Plumbing and Electrical",
            "allow_outbound" : true,
            "created_on" : "2017-05-28",
            "updated_on" : "2017-05-28",
            "ip_addresses" : [
                {
                    "ip_range" : "255.255.255.255/32",
                    "created_on" : "2017-05-28"
                }
            ],
            "users" : [
                {
                    "role_id" : 1,
                    "name" : "pete_the_plumber",
                    "password" : "password",
                    "email" : "pete@example.com",
                    "contact_first_name" : "Pete",
                    "contact_last_name" : "Plumber",
                    "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                    "created_on" : "2017-05-28",
                    "updated_on" : "2017-05-28"
                }
            ],
            "addresses" : [
                {
                    "street_one" : "1 Example Street",
                    "street_two" : "",
                    "street_three" : "",
                    "city" : "Exampleton",
                    "state" : "",
                    "zip" : "EX4M PL3",
                    "country_code" : "GB",
                    "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                    "created_on" : "2017-05-28",
                    "updated_on" : "2017-05-28"
                }
            ]
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • POST/account/reseller

    Creates a new sub reseller

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • addresses

      • Array of Reseller Address

      • True

      A list of this Reseller's Addresses

      • contact_name

      • String

      • True

      The contact name for this Reseller

      • name

      • String

      • True

      The name of this Reseller

      • store_front

      • String

      • True

      The UUID of the Store this Reseller belongs to

      • users

      • Array of Reseller User

      • True

      A list of this Reseller's Users.

    Allowed IP Range

    An Allowed IP Range is a range of IP Addresses in CIDR notation that has been white-listed for access to the API.

      • ip_range

      • String

      • True

      The IP Address Range in CIDR notation

    Reseller User

    A Reseller User provides access credentials to use the API or Web Portal for a specific reseller

      • contact_first_name

      • String

      • False

      This Reseller User's first name

      • contact_last_name

      • String

      • False

      This Reseller User's last name

      • email

      • String

      • True

      This Reseller User's email address

      • name

      • String

      • True

      This Reseller User's username

      • password

      • String

      • True

      This Reseller User's password

      • role_id

      • int

      • True

      This Reseller User's role id, which determines their level of access.

    Reseller Address

    A Reseller Address is a geographical address used for billing of a reseller

      • city

      • String

      • True

      The town/city of the address

      • country_code

      • String

      • True

      The Country ISO Code

      • state

      • String

      • False

      The county/state of the street address

      • street_one

      • String

      • True

      The first line of the street address

      • street_three

      • String

      • False

      The third line of the street address

      • street_two

      • String

      • False

      The second line of the street address

      • zip

      • String

      • True

      The Zip/Post Code

    JSON all-fields example:

    {
        "store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7",
        "name" : "Example Sub Reseller",
        "contact_name" : "Pete's Plumbing and Electrical",
        "users" : [
            {
                "role_id" : 1,
                "name" : "pete_the_plumber",
                "password" : "password",
                "email" : "pete@example.com",
                "contact_first_name" : "Pete",
                "contact_last_name" : "Plumber"
            }
        ],
        "addresses" : [
            {
                "street_one" : "1 Example Street",
                "street_two" : "",
                "street_three" : "",
                "city" : "Exampleton",
                "state" : "",
                "zip" : "EX4M PL3",
                "country_code" : "GB"
            }
        ]
    }

    Response Details

    201 Response

    {
        "result" : {
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7",
            "name" : "Example Sub Reseller",
            "contact_name" : "Pete's Plumbing and Electrical",
            "allow_outbound" : true,
            "created_on" : "2017-05-28",
            "ip_addresses" : [
                {
                    "ip_range" : "255.255.255.255/32",
                    "created_on" : "2017-05-28"
                }
            ],
            "users" : [
                {
                    "role_id" : 1,
                    "name" : "pete_the_plumber",
                    "password" : "password",
                    "email" : "pete@example.com",
                    "contact_first_name" : "Pete",
                    "contact_last_name" : "Plumber",
                    "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                    "created_on" : "2017-05-28"
                }
            ],
            "addresses" : [
                {
                    "street_one" : "1 Example Street",
                    "street_two" : "",
                    "street_three" : "",
                    "city" : "Exampleton",
                    "state" : "",
                    "zip" : "EX4M PL3",
                    "country_code" : "GB",
                    "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                    "created_on" : "2017-05-28"
                }
            ]
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • PUT/account/reseller/{uuid}

    Updates a sub reseller

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Sub Reseller to be updated

    PUT body

    • Name

    • Type

    • Required

      • addresses

      • Array of Reseller Address

      • True

      A list of this Reseller's Addresses

      • contact_name

      • String

      • True

      The contact name for this Reseller

      • name

      • String

      • True

      The name of this Reseller

      • store_front

      • String

      • True

      The UUID of the Store this Reseller belongs to

      • users

      • Array of Reseller User

      • True

      A list of this Reseller's Users.

    Allowed IP Range

    An Allowed IP Range is a range of IP Addresses in CIDR notation that has been white-listed for access to the API.

      • ip_range

      • String

      • True

      The IP Address Range in CIDR notation

    Reseller User

    A Reseller User provides access credentials to use the API or Web Portal for a specific reseller

      • contact_first_name

      • String

      • False

      This Reseller User's first name

      • contact_last_name

      • String

      • False

      This Reseller User's last name

      • email

      • String

      • True

      This Reseller User's email address

      • name

      • String

      • True

      This Reseller User's username

      • password

      • String

      • True

      This Reseller User's password

      • role_id

      • int

      • True

      This Reseller User's role id, which determines their level of access.

    Reseller Address

    A Reseller Address is a geographical address used for billing of a reseller

      • city

      • String

      • True

      The town/city of the address

      • country_code

      • String

      • True

      The Country ISO Code

      • state

      • String

      • False

      The county/state of the street address

      • street_one

      • String

      • True

      The first line of the street address

      • street_three

      • String

      • False

      The third line of the street address

      • street_two

      • String

      • False

      The second line of the street address

      • zip

      • String

      • True

      The Zip/Post Code

    JSON all-fields example:

    {
        "store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7",
        "name" : "Example Sub Reseller",
        "contact_name" : "Pete's Plumbing and Electrical"
    }

    Response Details

    200 Response

    {
        "result" : {
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7",
            "name" : "Example Sub Reseller",
            "contact_name" : "Pete's Plumbing and Electrical",
            "allow_outbound" : true,
            "created_on" : "2017-05-28",
            "updated_on" : "2017-05-28",
            "ip_addresses" : [
                {
                    "ip_range" : "255.255.255.255/32",
                    "created_on" : "2017-05-28"
                }
            ],
            "users" : [
                {
                    "role_id" : 1,
                    "name" : "pete_the_plumber",
                    "password" : "password",
                    "email" : "pete@example.com",
                    "contact_first_name" : "Pete",
                    "contact_last_name" : "Plumber",
                    "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                    "created_on" : "2017-05-28",
                    "updated_on" : "2017-05-28"
                }
            ],
            "addresses" : [
                {
                    "street_one" : "1 Example Street",
                    "street_two" : "",
                    "street_three" : "",
                    "city" : "Exampleton",
                    "state" : "",
                    "zip" : "EX4M PL3",
                    "country_code" : "GB",
                    "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                    "created_on" : "2017-05-28",
                    "updated_on" : "2017-05-28"
                }
            ]
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }

    409 Response

    {
        "result" : {},
        "status_code" : 409,
        "status_message" : "Conflict"
    }
  • DELETE/account/reseller/{uuid}

    Deletes the specified sub reseller

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    Response Details

    204 Response

    {
        "result" : {},
        "status_code" : 204,
        "status_message" : "No Content"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
View Desktop Site