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

Reseller Addresses

A Reseller Address is a geographical address used for billing and delivery for a reseller

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-address

    Gets a list of all active addresses for a reseller

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    Response Details

    200 Response

    {
        "result" : [
            {
                "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-11-20",
                "updated_on" : "2017-11-20"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/account/reseller-address/{uuid}

    Gets the specified reseller address

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Reseller Address to be queried

    Response Details

    200 Response

    {
        "result" : {
            "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-11-20",
            "updated_on" : "2017-11-20"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

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

    Creates a new reseller address

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • 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:

    {
        "street_one" : "1 Example Street",
        "street_two" : "",
        "street_three" : "",
        "city" : "Exampleton",
        "state" : "",
        "zip" : "EX4M PL3",
        "country_code" : "GB"
    }

    Response Details

    201 Response

    {
        "result" : {
            "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-11-20"
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    400 Response

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

    409 Response

    {
        "result" : {},
        "status_code" : 409,
        "status_message" : "Conflict"
    }
  • PUT/account/reseller-address/{uuid}

    Updates the specified Reseller Address

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Reseller Address to be updated

    PUT body

    • Name

    • Type

    • Required

      • 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:

    {
        "street_one" : "1 Example Street",
        "street_two" : "",
        "street_three" : "",
        "city" : "Exampleton",
        "state" : "",
        "zip" : "EX4M PL3",
        "country_code" : "GB"
    }

    Response Details

    200 Response

    {
        "result" : {
            "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-11-20",
            "updated_on" : "2017-11-20"
        },
        "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-address/{uuid}

    Deletes the specified Reseller Address

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Reseller Address to be deleted

    Response Details

    204 Response

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

    404 Response

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