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 Product

Products are the things you sell in your webshop. This API lets you see and modify what is for sale.

Accept header for requests to Webshop Product

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

Add a new product POST

URL: /l/webshop2_api/webshops/1/products

Scope:

webshop2/product/write
Last used: Never

Creates a new product in the webshop

Live testing disabled

Add a new product

Request

{
    "productId": 123,
    "title": "An item",
    "articleNumber": "a1234",
    "price": {
        "amount": 1250,
        "precision": 2
    },
    "vatPercentage": {
        "amount": 21,
        "precision": 2
    },
    "stock": 3,
    "isBackorderPossible": true,
    "actionPrice": {
        "amount": 1000,
        "precision": 2
    },
    "description": "A product description",
    "packingEntity": "btl",
    "visibility": 1,
    "depositValue": {
        "amount": 200,
        "precision": 2
    },
    "category": "Stuff",
    "modifiedDateTime": "1995-03-03 00:00:00"
}

Response

Status: 200

Update a product PUT

URL: /l/webshop2_api/webshops/1/products/2

Scope:

webshop2/product/write
Last used: Never

Updates an existing product in the webshop

Live testing disabled

Update a product

Request

{
    "productId": 123,
    "title": "An item",
    "articleNumber": "a1234",
    "price": {
        "amount": 1250,
        "precision": 2
    },
    "vatPercentage": {
        "amount": 21,
        "precision": 2
    },
    "stock": 3,
    "isBackorderPossible": true,
    "actionPrice": {
        "amount": 1000,
        "precision": 2
    },
    "description": "A product description",
    "packingEntity": "btl",
    "visibility": 1,
    "depositValue": {
        "amount": 200,
        "precision": 2
    },
    "category": "Stuff",
    "modifiedDateTime": "1995-03-03 00:00:00"
}

Response

Status: 200

Remove a product DELETE

URL: /l/webshop2_api/webshops/1/products/2

Scope:

webshop2/product/write
Last used: Never

Remove an existing product from the webshop

Live testing disabled

Remove a product

Request

Response

Status: 200

Get a product GET

URL: /l/webshop2_api/webshops/1/products/2

Scope:

webshop2/product/read
Last used: Never

Get information on a single product

Live testing disabled

Get a product

Request

json

Response

jsonStatus: 200
{
    "productId": 123,
    "title": "An item",
    "articleNumber": "a1234",
    "price": {
        "amount": 1250,
        "precision": 2
    },
    "vatPercentage": {
        "amount": 21,
        "precision": 2
    },
    "stock": 3,
    "isBackorderPossible": true,
    "actionPrice": {
        "amount": 1000,
        "precision": 2
    },
    "description": "A product description",
    "packingEntity": "btl",
    "visibility": 1,
    "depositValue": {
        "amount": 200,
        "precision": 2
    },
    "category": "Stuff",
    "modifiedDateTime": "1995-03-03 00:00:00"
}

Get multiple products GET

URL: /l/webshop2_api/webshops/1/products

Scope:

webshop2/product/read
Last used: Never

Get information on multiple products, based on search options

Parameters

Parameter Type Description
page int

The api will provide 100 results per page
articleNumber string

Find products with article numbers starting with this value
Live testing disabled

Get multiple products

Request

json

Response

jsonStatus: 200
[
    {
        "productId": 123,
        "title": "An item",
        "articleNumber": "a1234",
        "price": {
            "amount": 1250,
            "precision": 2
        },
        "vatPercentage": {
            "amount": 21,
            "precision": 2
        },
        "stock": 3,
        "isBackorderPossible": true,
        "actionPrice": {
            "amount": 1000,
            "precision": 2
        },
        "description": "A product description",
        "packingEntity": "btl",
        "visibility": 1,
        "depositValue": {
            "amount": 200,
            "precision": 2
        },
        "category": "Stuff",
        "modifiedDateTime": "1995-03-03 00:00:00"
    },
    {
        "productId": 123,
        "title": "An item",
        "articleNumber": "a1234",
        "price": {
            "amount": 1250,
            "precision": 2
        },
        "vatPercentage": {
            "amount": 21,
            "precision": 2
        },
        "stock": 3,
        "isBackorderPossible": true,
        "actionPrice": {
            "amount": 1000,
            "precision": 2
        },
        "description": "A product description",
        "packingEntity": "btl",
        "visibility": 1,
        "depositValue": {
            "amount": 200,
            "precision": 2
        },
        "category": "Stuff",
        "modifiedDateTime": "1995-03-03 00:00:00"
    }
]

Get multiple modified products GET

URL: /l/webshop2_api/webshops/1/products/modified

Scope:

webshop2/product/read
Last used: Never

Get information on recently modified products

Parameters

Parameter Type Description
page int

The api will provide 100 results per page
since date

Find products modified since this date (yyyy-mm-dd HH:ii:ss)
setId uuid

Find more pages of modified products from a previous set.
Live testing disabled

Get multiple modified products

Request

json

Response

jsonStatus: 200
[
    {
        "productId": 123,
        "title": "An item",
        "articleNumber": "a1234",
        "price": {
            "amount": 1250,
            "precision": 2
        },
        "vatPercentage": {
            "amount": 21,
            "precision": 2
        },
        "stock": 3,
        "isBackorderPossible": true,
        "actionPrice": {
            "amount": 1000,
            "precision": 2
        },
        "description": "A product description",
        "packingEntity": "btl",
        "visibility": 1,
        "depositValue": {
            "amount": 200,
            "precision": 2
        },
        "category": "Stuff",
        "modifiedDateTime": "1995-03-03 00:00:00"
    },
    {
        "productId": 123,
        "title": "An item",
        "articleNumber": "a1234",
        "price": {
            "amount": 1250,
            "precision": 2
        },
        "vatPercentage": {
            "amount": 21,
            "precision": 2
        },
        "stock": 3,
        "isBackorderPossible": true,
        "actionPrice": {
            "amount": 1000,
            "precision": 2
        },
        "description": "A product description",
        "packingEntity": "btl",
        "visibility": 1,
        "depositValue": {
            "amount": 200,
            "precision": 2
        },
        "category": "Stuff",
        "modifiedDateTime": "1995-03-03 00:00:00"
    }
]

Update product price PUT

URL: /l/webshop2_api/webshops/1/products/an/123abcd/price

Scope:

webshop2/product/write
Last used: Never

Update the price for a product based on articlenumber

Live testing disabled

Update product price

Request

json

Response

jsonStatus: 200
{
    "price": {
        "amount": 1250,
        "precision": 2
    }
}

Update product stock PUT

URL: /l/webshop2_api/webshops/1/products/1/stock

Scope:

webshop2/product/write
Last used: Never

Update the amount of stock available for a product

Live testing disabled

Update product stock

Request

json
{
    "stock": 15
}

Response

jsonStatus: 200
[]

Get product stock GET

URL: /l/webshop2_api/webshops/1/products/1/stock

Scope:

webshop2/product/read
Last used: Never

Get the available stock for a product

Live testing disabled

Get product stock

Request

json

Response

jsonStatus: 200
{
    "productId": 123,
    "stock": 15
}