NAV Navbar
shell
Topics
  • Introduction
  • Authentication
  • Pagination
  • Errors
  • Resources
  • Orders
  • Products
  • Feedbacks
  • Queries
  • Webhooks
  • Shoppy Pay
  • Introduction

    Welcome to the Shoppy API. You can use our API to access Shoppy API endpoints to build your own systems on top of our platform.

    You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

    Authentication

    To authorize, use this code:

    curl "https://shoppy.gg/api/" \
        -H "Authorization m3GfjWHTfmfV5tW9bgq5qrGgJ1DLgPFgOx80aNykTC0oCaOHRr"
    

    Shoppy uses API keys via the Authorization header to allow access to the API. You can retrieve your Shoppy API Key at your settings page.

    Shoppy expects for the API key to be included in all API requests to the server in a header that looks like the following:

    Authorization: m3GfjWHTfmfV5tW9bgq5qrGgJ1DLgPFgOx80aNykTC0oCaOHRr

    Pagination

    An example of paginating orders:

    curl "https://shoppy.gg/api/1.0/orders?page=10" \
        -H "Authorization: m3GfjWHTfmfV5tW9bgq5qrGgJ1DLgPFgOx80aNykTC0oCaOHRr"
    

    Shoppy offers the ability to paginate any list resources.

    The X-Total-Pages header returns the total number of pages of the resource.

    The X-Current-Page header returns the current page you are on.

    The X-Items-Per-Page header returns how many items are being returned per page.

    Query parameters

    Parameter Default Description
    page 1 Used for pagination

    Errors

    The Shoppy API uses the following error codes:

    Error Code Meaning
    400 Bad Request -- Invalid parameters
    401 Unauthorized -- Unable to authenticate
    404 Not Found -- The specified kitten could not be found.
    405 Method Not Allowed -- Invalid method
    406 Not Acceptable -- You requested a format that isn't json.
    429 Too Many Requests -- You have reached the rate limit
    500 Internal Server Error -- We had a problem with our server. Try again later.
    503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

    Orders

    Order object

    {
        "invoice_id": "8e23b496-121a-4dc6-8ec4-c45835680db2",
        "paid_at": null,
        "product_id": 7,
        "transaction_id": null,
        "delivered": 0,
        "confirmations": 0,
        "received_amount": 0,
        "crypto_address": "1Cfyo6hFvX3MSCmKZXnuQrbXCyZBzUj9iZ",
        "crypto_amount": 0.00085043,
        "original_price": 10,
        "ip_address": "119.74.162.144",
        "email": "limweijie999@hotmail.com",
        "http_referer": "",
        "payment_gateway": "BTC",
        "custom_fields": [{
            "name": "UID",
            "value": "358641"
        }],
        "disputed_at": null,
        "http_useragent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/62.0.3202.94 Safari\/537.36",
        "created_at": "2017-12-03 13:55:30"
    }
    

    Attributes

    Parameter Description
    invoice_id Unique identifier of the order
    paid_at Date when the order has been paid
    product_id Unique identifier of the asosciated product
    transaction_id The crypto tx ID of the payment
    delivered Status if the order has been delivered. 1, if delivered
    confirmations Amount of crypto confirmations. Will be null if the payment_gateway is not a crypto currency.
    received_amount Total amount received
    crypto_address The crypto coin address created for this order. Will be null if the payment_gateway is not a crypto currency.
    crypto_amount The amount of coins required to fulfil this order. Will be null if the payment_gateway is not a crypto currency.
    original_price The fiat price to fulfil this order
    ip_address IP address of the customer that initiated the order
    email IP address of the customer that initiated the order
    payment_gateway The gateway used for this order. Bitcoin, PayPal, Ethereum, Bcash,Litecoin`
    custom_fields The custom inputs that the customer inputted.
    disputed_at Date, the payment has been disputed. Only available for PayPal and Stripe
    http_useragent Useragent of the customer that initiated the order
    created_at Date the order has been created

    Get a single order

    This endpoint retrieves a single order.

    HTTP Request

    GET https://shoppy.gg/api/1.0/orders/:ID

    Query parameters

    Parameter Description
    ID The order ID to request
    curl "https://shoppy.gg/api/1.0/orders/11251" \
        -H "Authorization: m3GfjWHTfmfV5tW9bgq5qrGgJ1DLgPFgOx80aNykTC0oCaOHRr"
    

    The above command returns JSON structured like this:

    {
        "order_id": 4336,
        "invoice_id": "8e23b496-121a-4dc6-8ec4-c45835680db2",
        "paid_at": null,
        "product_id": 7,
        "transaction_id": null,
        "delivered": 0,
        "confirmations": 0,
        "received_amount": 0,
        "crypto_address": "1Cfyo6hFvX3MSCmKZXnuQrbXCyZBzUj9iZ",
        "crypto_amount": 0.00085043,
        "original_price": 10,
        "ip_address": "119.74.162.144",
        "email": "limweijie999@hotmail.com",
        "http_referer": "",
        "payment_gateway": "BTC",
        "custom_fields": [
            {
                "name": "UID",
                "value": "358641"
            }
        ],
        "disputed_at": null,
        "http_useragent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36",
        "created_at": "2017-12-03 13:55:30",
        "pay_id": null
    }
    

    Get all orders

    This endpoint retrieves all orders.

    HTTP Request

    GET https://shoppy.gg/api/1.0/orders

    Query parameters

    Parameter Description
    page Used for pagination
    curl "https://shoppy.gg/api/1.0/orders" \
        -H "Authorization: m3GfjWHTfmfV5tW9bgq5qrGgJ1DLgPFgOx80aNykTC0oCaOHRr"
    

    The above command returns JSON structured like this:

    [
        {
            "order_id": 4336,
            "invoice_id": "8e23b496-121a-4dc6-8ec4-c45835680db2",
            "paid_at": null,
            "product_id": 7,
            "transaction_id": null,
            "delivered": 0,
            "confirmations": 0,
            "received_amount": 0,
            "crypto_address": "1Cfyo6hFvX3MSCmKZXnuQrbXCyZBzUj9iZ",
            "crypto_amount": 0.00085043,
            "original_price": 10,
            "ip_address": "123.456.789.123",
            "email": "buyer@shoppy.gg",
            "http_referer": "",
            "payment_gateway": "BTC",
            "custom_fields": [{
                "name": "UID",
                "value": "358641"
            }],
            "disputed_at": null,
            "http_useragent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/62.0.3202.94 Safari\/537.36",
            "created_at": "2017-12-03 13:55:30"
        }, {
            "order_id": 4335,
            "invoice_id": "aa805bc0-3aaa-4dbe-ba2a-3f14fd88fa5d",
            "paid_at": null,
            "product_id": 9,
            "transaction_id": null,
            "delivered": 0,
            "confirmations": 0,
            "received_amount": 0,
            "crypto_address": "1BarU63S9NUEWDNv1RmivcgAZYjDJ1c2PZ",
            "crypto_amount": 0.00297573,
            "original_price": 35,
            "ip_address": "123.456.789.123",
            "email": "buyer2@shoppy.gg",
            "http_referer": "",
            "payment_gateway": "BTC",
            "custom_fields": [{
                "name": "UID",
                "value": "1105080"
            }],
            "disputed_at": null,
            "http_useragent": "Mozilla\/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/62.0.3202.94 Safari\/537.36",
            "created_at": "2017-12-03 13:49:25"
        }
    ]
    

    Products

    Product object

    {
        "product_id": 7,
        "hashed_id": "596260a7da9fb",
        "created_at": "2017-07-09 16:58:15",
        "updated_at": "2018-01-03 02:23:12",
        "title": "Nulled VIP 3 months",
        "description": "* A new userbar to make you stand out.\r\n* Bypass the requirements to unlock hidden content.\t\r\n* Access to VIP exclusive forums.\t\r\n* Storage for 5,000 messages.\t\r\n* Access to auth key (free BoL scripts, Soapbox, ...)\t\r\n* Able to rate other members with +2/-1 likes.\t\r\n* Able to close your own threads.\t\r\n* Bypass auth requirements (auth access)\t\r\n* Able to change your username",
        "type": 2,
        "email_message": "Thank you for your support",
        "price": 10,
        "stock_warning": 0,
        "minimum_quantity": 1,
        "maximum_quantity": 10,
        "unlisted": false,
        "custom_fields": [
            {
                "name": "UID",
                "type": "2",
                "required": true,
                "iterator": "0"
            }
        ],
        "gateways": [
            "Bitcoin",
            "Ethereum"
        ],
        "required_confirmations": 1,
        "attachment_id": null,
        "attach_email_text": 1,
        "theme": 1,
        "webhook_urls": [
            "https://pay.lolaccounts.gg/shoppy.php"
        ],
        "theme_color": "#1b273d"
    }
    

    Attributes

    Parameter Description
    product_id  Unique identifier for the product
    created_at The date and time that the resources was created
    updated_at The date and time that the resources was created
    title Title of the product
    description The raw markup description of the product
    type The product type (service, file, serial)
    email_message The message to be attached to the Purchase Successful email
    price The price of the product
    stock_warning The stock warning when you get notified
    minimum_quantity The minimum quantity to order
    maximum_quantity The maximum quantity toorder
    unlisted Whether the product is listed on the user page
    custom_fields Array of custom fields attached to the product
    gateways Array of gateways for the product
    required_confirmations Amount of confirmations required
    theme Selected Theme ID
    theme_color The customized theme color, as hex

    Get a single product

    curl "https://shoppy.gg/api/1.0/products/7" \
        -H "Authorization: m3GfjWHTfmfV5tW9bgq5qrGgJ1DLgPFgOx80aNykTC0oCaOHRr"
    

    The above command returns JSON structured like this:

    {
        "product_id": 7,
        "hashed_id": "596260a7da9fb",
        "created_at": "2017-07-09 16:58:15",
        "updated_at": "2018-01-03 02:23:12",
        "title": "Nulled VIP 3 months",
        "description": "* A new userbar to make you stand out.\r\n* Bypass the requirements to unlock hidden content.\t\r\n* Access to VIP exclusive forums.\t\r\n* Storage for 5,000 messages.\t\r\n* Access to auth key (free BoL scripts, Soapbox, ...)\t\r\n* Able to rate other members with +2/-1 likes.\t\r\n* Able to close your own threads.\t\r\n* Bypass auth requirements (auth access)\t\r\n* Able to change your username",
        "type": 2,
        "email_message": "Thank you for your support",
        "price": 10,
        "stock_warning": 0,
        "minimum_quantity": 1,
        "maximum_quantity": 10,
        "unlisted": false,
        "custom_fields": [
            {
                "name": "UID",
                "type": "2",
                "required": true,
                "iterator": "0"
            }
        ],
        "gateways": [
            "Bitcoin",
            "Ethereum"
        ],
        "required_confirmations": 1,
        "attachment_id": null,
        "attach_email_text": 1,
        "theme": 1,
        "webhook_urls": [
            "https://pay.lolaccounts.gg/shoppy.php"
        ],
        "theme_color": "#1b273d"
    }
    

    This endpoint retrieves a single product.

    HTTP Request

    GET https://shoppy.gg/api/1.0/products/:ID

    Query parameters

    Parameter Description
    ID The product ID to request

    Get all products

    curl "https://shoppy.gg/api/1.0/products" \
        -H "Authorization: m3GfjWHTfmfV5tW9bgq5qrGgJ1DLgPFgOx80aNykTC0oCaOHRr"
    

    The above command returns JSON structured like this:

    [
        {
            "product_id": 7,
            "hashed_id": "596260a7da9fb",
            "created_at": "2017-07-09 16:58:15",
            "updated_at": "2018-01-03 02:23:12",
            "title": "Nulled VIP 3 months",
            "description": "* A new userbar to make you stand out.\r\n* Bypass the requirements to unlock hidden content.\t\r\n* Access to VIP exclusive forums.\t\r\n* Storage for 5,000 messages.\t\r\n* Access to auth key (free BoL scripts, Soapbox, ...)\t\r\n* Able to rate other members with +2/-1 likes.\t\r\n* Able to close your own threads.\t\r\n* Bypass auth requirements (auth access)\t\r\n* Able to change your username",
            "type": 2,
            "email_message": "Thank you for your support",
            "price": 10,
            "stock_warning": 0,
            "minimum_quantity": 1,
            "maximum_quantity": 10,
            "unlisted": false,
            "custom_fields": [
                {
                    "name": "UID",
                    "type": "2",
                    "required": true,
                    "iterator": "0"
                }
            ],
            "gateways": [
                "Bitcoin",
                "Ethereum"
            ],
            "required_confirmations": 1,
            "attachment_id": null,
            "attach_email_text": 1,
            "theme": 1,
            "webhook_urls": [
                "https://pay.lolaccounts.gg/shoppy.php"
            ],
            "theme_color": "#1b273d",
            "product_type_id": 2,
            "product_type_value": "Service",
            "product_type_label": "info"
        },
        {
            "product_id": 9,
            "hashed_id": "59e8e03746b3e",
            "created_at": "2017-07-09 16:58:15",
            "updated_at": "2018-01-02 04:52:28",
            "title": "Nulled AQUA Upgrade",
            "description": "* A new userbar to make you stand out.\r\n* Bypass the requirements to unlock hidden content.\t\r\n* Access to VIP exclusive forums.\t\r\n* Storage for 5,000 messages.\t\r\n* Access to auth key (free BoL scripts, Soapbox, ...)\t\r\n* Able to rate other members with +2/-1 likes.\t\r\n* Able to close your own threads.\t\r\n* Bypass auth requirements (auth access)\t\r\n* Able to change your username",
            "type": 1,
            "email_message": "Thank you for your support",
            "price": 10,
            "stock_warning": 0,
            "minimum_quantity": 1,
            "maximum_quantity": 10,
            "unlisted": true,
            "custom_fields": [
                {
                    "name": "UID",
                    "type": "2",
                    "required": false,
                    "iterator": "0",
                    "field_type": "number",
                    "value": "",
                    "hidden": false
                }
            ],
            "gateways": [
                "Bitcoin",
                "Ethereum"
            ],
            "required_confirmations": 1,
            "attachment_id": 2,
            "attach_email_text": 0,
            "theme": 1,
            "webhook_urls": false,
            "theme_color": "#1b273d",
            "product_type_id": 1,
            "product_type_value": "Account",
            "product_type_label": "success"
        }
    ]
    

    This endpoint retrieves all queries.

    HTTP Request

    GET https://shoppy.gg/api/1.0/products

    Query parameters

    Parameter Description
    page Used for pagination

    Feedbacks

    Feedback object

    {
        "feedback_id": 7,
        "response": "Thanks! :)",
        "rating": 1,
        "stars": 5,
        "comment": "",
        "product": {
            // Product object
        },
        "order": {
            // Order Object
        },
        "seller": {
            "username": "Shoppy"
        },
        "created_at": "2017-12-28 00:00:25"
    }
    

    Attributes

    Parameter Description
    feedback_id Unique identifier of the feedback
    response Response of seller
    rating Rating of feedback (-1 = Negative, 0 = Neutral, 1 = Positive)
    stars The amount of stars given
    comment The comment given with the feedback
    product Full product object
    order Full order object
    seller Username of seller
    created_at The date and time the feedback was created

    Get a single feedback

    curl "https://shoppy.gg/api/1.0/feedbacks/7" \
        -H "Authorization: m3GfjWHTfmfV5tW9bgq5qrGgJ1DLgPFgOx80aNykTC0oCaOHRr"
    

    The above command returns JSON structured like this:

    {
        "feedback_id": 7,
        "created_at": "2017-12-28 00:00:25",
        "response": "Thanks! :)",
        "rating": 1,
        "stars": 5,
        "comment": "",
        "reply_id": "5a44294950d4a",
        "product_title": "Nulled VIP 3 months",
        "invoice_id": "666ca8d1-d616-4794-8258-8f60aec8ef94",
        "seller_name": "finn"
    }
    

    This endpoint retrieves a single feedback.

    HTTP Request

    GET https://shoppy.gg/api/1.0/feedbacks/:ID

    Query parameters

    Parameter Description
    ID The feedback ID to request

    Get all feedbacks

    curl "https://shoppy.gg/api/1.0/feedbacks" \
        -H "Authorization: m3GfjWHTfmfV5tW9bgq5qrGgJ1DLgPFgOx80aNykTC0oCaOHRr"
    

    The above command returns JSON structured like this:

    [
        {
            "feedback_id": 7,
            "created_at": "2017-12-28 00:00:25",
            "response": "Thanks! :)",
            "rating": 1,
            "stars": 5,
            "comment": "",
            "reply_id": "5a44294950d4a",
            "product_title": "Nulled VIP 3 months",
            "invoice_id": "666ca8d1-d616-4794-8258-8f60aec8ef94",
            "seller_name": "finn"
        },
        {
            "feedback_id": 13,
            "created_at": "2018-01-01 23:08:26",
            "response": "",
            "rating": 1,
            "stars": 5,
            "comment": "Very good seller",
            "reply_id": "5a4ab15aabd7c",
            "product_title": "Nulled VIP 3 months",
            "invoice_id": "bb646d79-97bc-4151-9a83-0bc7269857b0"
        }
    ]
    

    This endpoint retrieves all feedbacks.

    HTTP Request

    GET https://shoppy.gg/api/1.0/feedbacks

    Query parameters

    Parameter Description
    page Used for pagination

    Queries

    Query Object

    {
        "query": "5a4a9fa7d8fdd",
        "status": 0,
        "subject": "Test",
        "email": "ui-test@shoppy.gg",
        "message": "Testing the Query System",
        "replies": [],
        "created_at": "2018-01-01 21:52:55"
    }
    

    Attributes

    Parameter Description
    query  Unique identifier of the query
    status Status of the query (0 - Open, 1 - User Reply, 2 - Replied, 3 - Closed, 4 - Solved)
    subject Subject of the query
    email Email of the query
    message Message of the query
    replies Array of replies
    created_at The date and time the query was created

    Get a single query

    curl "https://shoppy.gg/api/1.0/queries/5a4a7fbcca586" \
        -H "Authorization: m3GfjWHTfmfV5tW9bgq5qrGgJ1DLgPFgOx80aNykTC0oCaOHRr"
    

    The above command returns JSON structured like this:

    {
        "query": "5a4a9fa7d8fdd",
        "status": 0,
        "subject": "Test",
        "email": "ui-test@shoppy.gg",
        "message": "Testing the Query System",
        "created_at": "2018-01-01 21:52:55",
        "replies": []
    }
    

    This endpoint retrieves a single query.

    HTTP Request

    GET https://shoppy.gg/api/1.0/queries/:ID

    Query parameters

    Parameter Description
    ID The query ID to request

    Get all queries

    curl "https://shoppy.gg/api/1.0/queries" \
        -H "Authorization: m3GfjWHTfmfV5tW9bgq5qrGgJ1DLgPFgOx80aNykTC0oCaOHRr"
    

    The above command returns JSON structured like this:

    [
        {
            "query": "5a4a7fbcca586",
            "status": 4,
            "reply": 0,
            "seller_reply": 0,
            "subject": "Test",
            "email": "ui-test@shoppy.gg",
            "message": "Do you also accept BTC?",
            "created_at": "2018-01-01 19:36:44",
            "replies": [
                {
                    "query": "5a4a7fbcca586",
                    "reply": 1,
                    "seller_reply": 0,
                    "query_secret": "",
                    "subject": "hello world",
                    "email": "ui-test-reply1@shoppy.gg",
                    "message": "Reply 1",
                    "created_at": "2018-01-01 20:09:21"
                },
                {
                    "query": "5a4a7fbcca586",
                    "reply": 1,
                    "seller_reply": 0,
                    "query_secret": "",
                    "subject": "hello world",
                    "email": "ui-test-reply2@shoppy.gg",
                    "message": "Reply 2",
                    "created_at": "2018-01-01 20:08:10"
                }
            ]
        }
    ]
    

    This endpoint retrieves all queries.

    HTTP Request

    GET https://shoppy.gg/api/1.0/queries

    Query parameters

    Parameter Description
    page Used for pagination

    Webhooks

    An example webhook notification on a paid order event

    {
        "status": true,
        "webhook_type": "100",
        "data": {
            "order": {
                "email": "webhook@shoppy.gg",
                "ip_address": "123.456.789.111",
                "country_code": "NL",
                "user_agent": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_12_2)"
            },
            "product": {
                "product_id": 7,
                "hashed_id": "596260a7da9fb",
                "created_at": "2017-07-09 18:58:15",
                "updated_at": "2017-11-16 06:13:21",
                "deleted_at": null,
                "seller_id": 1,
                "title": "Nulled VIP 3 months",
                "description": "* A new userbar to make you stand out.\r\n* Bypass the requirements to unlock hidden content.\t\r\n* Access to VIP exclusive forums.\t\r\n* Storage for 5,000 messages.\t\r\n* Access to auth key (free BoL scripts, Soapbox, ...)\t\r\n* Able to rate other members with +2\/-1 likes.\t\r\n* Able to close your own threads.\t\r\n* Bypass auth requirements (auth access)\t\r\n* Able to change your username",
                "type": 2,
                "email_message": "Thank you for your support",
                "price": 10,
                "stock_warning": 0,
                "minimum_quantity": 1,
                "maximum_quantity": 1,
                "unlisted": 0,
                "webhook_url": "http://vlan.shoppy.gg/ipn",
                "custom_fields": "a:1:{i:0;a:4:{s:4:\"name\";s:3:\"UID\";s:4:\"type\";s:1:\"2\";s:8:\"required\";s:4:\"true\";s:8:\"iterator\";s:1:\"0\";}}",
                "gateways": "a:2:{i:0;s:7:\"Bitcoin\";i:1;s:8:\"Ethereum\";}",
                "required_confirmations": 1,
                "attachment_id": null,
                "attach_email_text": 0
            }
        }
    }
    

    Webhooks are HTTP callback events that is sent to a specified Webhook URL for an order. All requests are sent as a POST request and handled asynchonously.

    The content sent in the webhook is a JSON object of the resource that the webhook is related to.

    Every webhook object contains a webhook_type parameter and a data parameter with the data.

    Webhook Types

    Webhook Type Description
    100 Order completed
    200 Order disputed
    300 Product out of stock
    400 Product reached stock warning level
    500 Feedback left
    600 Ticket created
    700 Ticket reply

    Get a single webhook

    curl "https://shoppy.gg/api/1.0/webhooks/11251" \
        -H "Authorization: m3GfjWHTfmfV5tW9bgq5qrGgJ1DLgPFgOx80aNykTC0oCaOHRr"
    

    The above command returns JSON structured like this:

    {
        "webhook_id": 11251,
        "seller_id": 1,
        "created_at": "2017-12-06 00:40:24",
        "deleted_at": null,
        "updated_at": "2017-12-06 00:40:24",
        "webhook_type": 100,
        "referenced_id": 7,
        "order_id": 0,
        "endpoint": "https://requestb.in/1e7or0y1",
        "data": {
            "status": true,
            "webhook_type": "100",
            "data": {
                "order": {
                    "email": "webhook@shoppy.gg",
                    "ip_address": "123.456.789.111",
                    "country_code": "NL",
                    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_2)"
                },
                "product": {
                    "product_id": 7,
                    "hashed_id": "596260a7da9fb",
                    "created_at": "2017-07-09 16:58:15",
                    "updated_at": "2017-11-16 05:13:21",
                    "deleted_at": null,
                    "seller_id": 1,
                    "title": "Nulled VIP 3 months",
                    "description": "* A new userbar to make you stand out.\r\n* Bypass the requirements to unlock hidden content.\t\r\n* Access to VIP exclusive forums.\t\r\n* Storage for 5,000 messages.\t\r\n* Access to auth key (free BoL scripts, Soapbox, ...)\t\r\n* Able to rate other members with +2/-1 likes.\t\r\n* Able to close your own threads.\t\r\n* Bypass auth requirements (auth access)\t\r\n* Able to change your username",
                    "type": 2,
                    "email_message": "Thank you for your support",
                    "price": 10,
                    "stock_warning": 0,
                    "minimum_quantity": 1,
                    "maximum_quantity": 1,
                    "unlisted": 0,
                    "webhook_url": "https://pay.lolaccounts.gg/shoppy.php",
                    "custom_fields": "a:1:{i:0;a:4:{s:4:\"name\";s:3:\"UID\";s:4:\"type\";s:1:\"2\";s:8:\"required\";s:4:\"true\";s:8:\"iterator\";s:1:\"0\";}}",
                    "gateways": "a:2:{i:0;s:7:\"Bitcoin\";i:1;s:8:\"Ethereum\";}",
                    "required_confirmations": 1,
                    "attachment_id": null,
                    "attach_email_text": 0
                }
            }
        },
        "response_code": null,
        "retries_left": 3,
        "response_body": null
    }
    

    This endpoint retrieves a single webhook.

    GET https://shoppy.gg/api/1.0/webhooks/:ID

    Query parameters

    Parameter Description
    ID The webhook ID to request

    Get all webhooks

    curl "https://shoppy.gg/api/1.0/webhooks" \
        -H "Authorization: m3GfjWHTfmfV5tW9bgq5qrGgJ1DLgPFgOx80aNykTC0oCaOHRr"
    

    The above command returns JSON structured like this:

    [
        {
            "webhook_id": 11266,
            "seller_id": 1,
            "created_at": "2017-12-06 01:31:51",
            "deleted_at": null,
            "updated_at": "2017-12-06 01:31:51",
            "webhook_type": 100,
            "referenced_id": 7,
            "order_id": 0,
            "endpoint": "https://requestb.in/1e7or0y1",
            "data": {
                "status": true,
                "webhook_type": 100,
                "data": {
                    "order": {
                        "email": "webhook@shoppy.gg",
                        "ip_address": "123.456.789.111",
                        "country_code": "NL",
                        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_2)"
                    },
                    "product": {
                        "hashed_id": "596260a7da9fb",
                        "created_at": "2017-07-09 16:58:15",
                        "seller_id": 1,
                        "title": "Nulled VIP 3 months",
                        "type": 2,
                        "email_message": "Thank you for your support",
                        "price": 10,
                        "required_confirmations": 1
                    }
                }
            },
            "response_code": null,
            "retries_left": 3,
            "response_body": null
        },
        {
            "webhook_id": 11265,
            "seller_id": 1,
            "created_at": "2017-12-06 01:25:46",
            "deleted_at": null,
            "updated_at": "2017-12-06 01:25:46",
            "webhook_type": 100,
            "referenced_id": 7,
            "order_id": 0,
            "endpoint": "https://requestb.in/1e7or0y1",
            "data": {
                "status": true,
                "webhook_type": 100,
                "data": {
                    "order": {
                        "email": "webhook@shoppy.gg",
                        "ip_address": "123.456.789.111",
                        "country_code": "NL",
                        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_2)"
                    },
                    "product": {
                        "hashed_id": "596260a7da9fb",
                        "created_at": "2017-07-09 16:58:15",
                        "seller_id": 1,
                        "title": "Nulled VIP 3 months",
                        "type": 2,
                        "email_message": "Thank you for your support",
                        "price": 10,
                        "required_confirmations": 1
                    }
                }
            },
            "response_code": null,
            "retries_left": 3,
            "response_body": null
        }
    ]
    

    This endpoint retrieves all webhooks.

    HTTP Request

    GET https://shoppy.gg/api/1.0/webhooks

    Query parameters

    Parameter Description
    page 1

    Shoppy Pay

    Shoppy Pay provides several online payment methods to implement a realtime checkout experience for any e-commerce platform supporting a range of payment methods in one place.

    For each payment, a unique URL will be returned. The customer will have to be redirected to the URL in order to access the checkout page.

    Create a Payment

    curl -X POST "https://shoppy.gg/api/1.0/pay" \
        -H "Authorization: m3GfjWHTfmfV5tW9bgq5qrGgJ1DLgPFgOx80aNykTC0oCaOHRr" \
        -d '{ "title": "Shoppy Pay Example", "value": 9.99, "webhook_url": "https://requestb.in/1o41bep1", "email": "seller@shoppy.gg" }'
    

    The above command returns a JSON structured like this:

    {
        "status": true,
        "url": "https:\/\/shoppy.gg\/pay\/joxj0m9rF9eLRcM0uXCXWfblXMMqjwpZ4lEaROGIg8TesxcUR9FtpFGvEz8hnJIL"
    }
    

    The customer should be redirected to this URL to activate the checkout experience.

    Attributes

    Parameter Description
    title Title of the product shown on checkout page
    value The fiat price of the order
    webhook_url The webhook URL to send webhooks to on payment completion or other events
    email The email of the customer

    Delete a Payment

    curl -X DELETE "https://shoppy.gg/api/1.0/Jce2WF93tJTotIu3GJeRLGtFFcdcaLHTQqyQoqmeW6mA6XQG3zH7tT6pZ50vtoMW/" \
        -H "Authorization: m3GfjWHTfmfV5tW9bgq5qrGgJ1DLgPFgOx80aNykTC0oCaOHRr" \
    

    The above command returns a JSON structured like this:

    {
        "status": true
    }
    

    This endpoint deletes a Shoppy Pay payment.

    HTTP Request

    DELETE https://shoppy.gg/api/1.0/pay/:ID