API Documentation

This document is a work in progress and your opinion helps us to improve. Please let us know what we can do better. Thanks! support@procurios.com

Webshop Promotions

A promotion is a special deal or discount designed to convince people to order products.

Accept header for requests to Webshop Promotions

application/vnd.procurios.webshop+json; version=1

Read BOGO promotions GET

URL: /l/webshop2_api/webshops/1/bogo

Scope:

webshop2/promotion/read
Last used: Never

Read multiple "Buy one/get one" promotions

Parameters

Parameter Type Description
page int

The api will provide 100 results per page
ids array of uuid

Ids of bogo promotions to search for
Live testing disabled

Read BOGO promotions

Request

json

Response

jsonStatus: 200
[
    {
        "id": "0b98e02e-07c2-4e39-be9e-2499ac9ed2ae",
        "title": "Bogo title",
        "titleInWebshop": "Webshop title",
        "validFrom": "1980-01-01 00:00:00",
        "validTo": "1990-12-31 00:00:00",
        "quantityInShoppingCart": 3,
        "quantityDiscounted": 2,
        "articleNumbers": [],
        "modifiedDateTime": "1985-03-04 00:00:00",
        "discountType": "percentage",
        "discountPercentage": {
            "amount": 1250,
            "precision": 2
        }
    },
    {
        "id": "4b1726f5-b481-41da-b391-ae1da8bc8ad1",
        "title": "Bogo title",
        "titleInWebshop": "Webshop title",
        "validFrom": "1980-01-01 00:00:00",
        "validTo": "1990-12-31 00:00:00",
        "quantityInShoppingCart": 3,
        "quantityDiscounted": 2,
        "articleNumbers": [],
        "modifiedDateTime": "1985-03-04 00:00:00",
        "discountType": "percentage",
        "discountPercentage": {
            "amount": 1250,
            "precision": 2
        }
    }
]

Read product set promotions GET

URL: /l/webshop2_api/webshops/1/productSet

Scope:

webshop2/promotion/read
Last used: Never

Read multiple "Buy these together for a fixed price" promotions

Parameters

Parameter Type Description
page int

The api will provide 100 results per page
ids array of uuid

Ids of productset promotions to search for
Live testing disabled

Read product set promotions

Request

json

Response

jsonStatus: 200
[
    {
        "id": "6fa1e380-a59a-48f2-8996-3c968d7b8f68",
        "title": "ProductSet title",
        "titleInWebshop": "Webshop title",
        "validFrom": "1980-01-01 00:00:00",
        "validTo": "1990-12-31 00:00:00",
        "price": {
            "amount": 15,
            "precision": 0
        },
        "articleNumberCounts": [],
        "modifiedDateTime": "1985-03-04 00:00:00"
    },
    {
        "id": "73bdd8d3-030a-45ec-9eca-7dcdb211c41c",
        "title": "ProductSet title",
        "titleInWebshop": "Webshop title",
        "validFrom": "1980-01-01 00:00:00",
        "validTo": "1990-12-31 00:00:00",
        "price": {
            "amount": 15,
            "precision": 0
        },
        "articleNumberCounts": [],
        "modifiedDateTime": "1985-03-04 00:00:00"
    }
]

Read discount promotions GET

URL: /l/webshop2_api/webshops/1/promotion

Scope:

webshop2/promotion/read
Last used: Never

Read multiple "This product is temporarily discounted" promotions

Parameters

Parameter Type Description
page int

The api will provide 100 results per page
ids array of int

Ids of productset promotions to search for
Live testing disabled

Read discount promotions

Request

json

Response

jsonStatus: 200
[
    {
        "id": 123,
        "title": "Promotion Title",
        "titleInWebshop": "Title in webshop",
        "validFrom": "1980-01-01 00:00:00",
        "validTo": "1985-03-03 00:00:00",
        "articleNumbers": [],
        "modifiedDateTime": "1982-02-03 00:00:00",
        "applicationType": "shipping",
        "discountType": "percentage",
        "discountPercentage": {
            "amount": 1250,
            "precision": 2
        }
    },
    {
        "id": 123,
        "title": "Promotion Title",
        "titleInWebshop": "Title in webshop",
        "validFrom": "1980-01-01 00:00:00",
        "validTo": "1985-03-03 00:00:00",
        "articleNumbers": [],
        "modifiedDateTime": "1982-02-03 00:00:00",
        "applicationType": "shipping",
        "discountType": "percentage",
        "discountPercentage": {
            "amount": 1250,
            "precision": 2
        }
    }
]