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 Orders

An order involves a client purchasing one or more products from your webshop.

Accept header for requests to Webshop Orders

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

Read orders GET

URL: /l/webshop2_api/webshops/1/orders

Scope:

webshop2/order/read
Last used: Never

Read multiple orders based on search criteria

Parameters

Parameter Type Description
page int

The api will provide 100 results per page

dateCreatedFrom datetime

Orders created since this moment (yyyy-mm-dd HH:ii:ss)

dateCreatedUntil datetime

Orders created before this moment (yyyy-mm-dd HH:ii:ss)

Live testing disabled

Read orders

Request

json
[]

Response

jsonStatus: 200
[
    {
        "orderId": 123,
        "externalOrderNumber": null,
        "dateCreated": "1988-02-15T00:00:00+01:00",
        "customerName": "The customer",
        "companyName": null,
        "emailAddress": null,
        "phoneNumber": null,
        "invoiceAddress": {
            "freetext": null,
            "street": "Straatweg",
            "number": "15",
            "addition": " a",
            "postcode": "",
            "town": "Houten",
            "countryCode": "NL",
            "stateCode": ""
        },
        "shippingAddress": null,
        "remarks": "some remarks",
        "delivery": "DELIVERY",
        "orderLines": [
            {
                "articleNumber": "A1234",
                "description": null,
                "quantity": 1,
                "packingEntity": "Bottle",
                "price": {
                    "amount": 1250,
                    "precision": 2
                },
                "discountPrice": {
                    "amount": 1250,
                    "precision": 2
                },
                "vatPercentage": {
                    "amount": 0,
                    "precision": 0
                }
            },
            {
                "articleNumber": "A1235",
                "description": null,
                "quantity": 1,
                "packingEntity": "Box",
                "price": {
                    "amount": 1750,
                    "precision": 2
                },
                "discountPrice": {
                    "amount": 1750,
                    "precision": 2
                },
                "vatPercentage": {
                    "amount": 0,
                    "precision": 0
                }
            }
        ],
        "attributes": []
    },
    {
        "orderId": 123,
        "externalOrderNumber": null,
        "dateCreated": "1988-02-15T00:00:00+01:00",
        "customerName": "The customer",
        "companyName": null,
        "emailAddress": null,
        "phoneNumber": null,
        "invoiceAddress": {
            "freetext": null,
            "street": "Straatweg",
            "number": "15",
            "addition": " a",
            "postcode": "",
            "town": "Houten",
            "countryCode": "NL",
            "stateCode": ""
        },
        "shippingAddress": null,
        "remarks": "some remarks",
        "delivery": "DELIVERY",
        "orderLines": [
            {
                "articleNumber": "A1234",
                "description": null,
                "quantity": 1,
                "packingEntity": "Bottle",
                "price": {
                    "amount": 1250,
                    "precision": 2
                },
                "discountPrice": {
                    "amount": 1250,
                    "precision": 2
                },
                "vatPercentage": {
                    "amount": 0,
                    "precision": 0
                }
            },
            {
                "articleNumber": "A1235",
                "description": null,
                "quantity": 1,
                "packingEntity": "Box",
                "price": {
                    "amount": 1750,
                    "precision": 2
                },
                "discountPrice": {
                    "amount": 1750,
                    "precision": 2
                },
                "vatPercentage": {
                    "amount": 0,
                    "precision": 0
                }
            }
        ],
        "attributes": []
    }
]

Read orders without an external order number GET

URL: /l/webshop2_api/webshops/1/orders/withoutExternalOrderNumber

Scope:

webshop2/order/read
Last used: Never

Read multiple orders based on search criteria that do not have an external order number.

Parameters

Parameter Type Description
page int

The api will provide 100 results per page

dateCreatedFrom datetime

Orders created since this moment (yyyy-mm-dd HH:ii:ss)

dateCreatedUntil datetime

Orders created before this moment (yyyy-mm-dd HH:ii:ss)

Live testing disabled

Read orders without an external order number

Request

json

Response

jsonStatus: 200
[
    {
        "orderId": 123,
        "externalOrderNumber": null,
        "dateCreated": "1988-02-15T00:00:00+01:00",
        "customerName": "The customer",
        "companyName": null,
        "emailAddress": null,
        "phoneNumber": null,
        "invoiceAddress": {
            "freetext": null,
            "street": "Straatweg",
            "number": "15",
            "addition": " a",
            "postcode": "",
            "town": "Houten",
            "countryCode": "NL",
            "stateCode": ""
        },
        "shippingAddress": null,
        "remarks": "some remarks",
        "delivery": "DELIVERY",
        "orderLines": [
            {
                "articleNumber": "A1234",
                "description": null,
                "quantity": 1,
                "packingEntity": "Bottle",
                "price": {
                    "amount": 1250,
                    "precision": 2
                },
                "discountPrice": {
                    "amount": 1250,
                    "precision": 2
                },
                "vatPercentage": {
                    "amount": 0,
                    "precision": 0
                }
            },
            {
                "articleNumber": "A1235",
                "description": null,
                "quantity": 1,
                "packingEntity": "Box",
                "price": {
                    "amount": 1750,
                    "precision": 2
                },
                "discountPrice": {
                    "amount": 1750,
                    "precision": 2
                },
                "vatPercentage": {
                    "amount": 0,
                    "precision": 0
                }
            }
        ],
        "attributes": []
    },
    {
        "orderId": 123,
        "externalOrderNumber": null,
        "dateCreated": "1988-02-15T00:00:00+01:00",
        "customerName": "The customer",
        "companyName": null,
        "emailAddress": null,
        "phoneNumber": null,
        "invoiceAddress": {
            "freetext": null,
            "street": "Straatweg",
            "number": "15",
            "addition": " a",
            "postcode": "",
            "town": "Houten",
            "countryCode": "NL",
            "stateCode": ""
        },
        "shippingAddress": null,
        "remarks": "some remarks",
        "delivery": "DELIVERY",
        "orderLines": [
            {
                "articleNumber": "A1234",
                "description": null,
                "quantity": 1,
                "packingEntity": "Bottle",
                "price": {
                    "amount": 1250,
                    "precision": 2
                },
                "discountPrice": {
                    "amount": 1250,
                    "precision": 2
                },
                "vatPercentage": {
                    "amount": 0,
                    "precision": 0
                }
            },
            {
                "articleNumber": "A1235",
                "description": null,
                "quantity": 1,
                "packingEntity": "Box",
                "price": {
                    "amount": 1750,
                    "precision": 2
                },
                "discountPrice": {
                    "amount": 1750,
                    "precision": 2
                },
                "vatPercentage": {
                    "amount": 0,
                    "precision": 0
                }
            }
        ],
        "attributes": []
    }
]

Update an order PUT

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

Scope:

webshop2/order/write
Last used: Never

Add an external order number to an order.

Live testing disabled

Update an order

Request

json
{
    "externalOrderNumber": "order123"
}

Response

jsonStatus: 200
[]

Read a single order GET

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

Scope:

webshop2/order/read
Last used: Never

Get information on a single order

Live testing disabled

Read a single order

Request

json

Response

jsonStatus: 200
{
    "orderId": 123,
    "externalOrderNumber": null,
    "dateCreated": "1988-02-15T00:00:00+01:00",
    "customerName": "The customer",
    "companyName": null,
    "emailAddress": null,
    "phoneNumber": null,
    "invoiceAddress": {
        "freetext": null,
        "street": "Straatweg",
        "number": "15",
        "addition": " a",
        "postcode": "",
        "town": "Houten",
        "countryCode": "NL",
        "stateCode": ""
    },
    "shippingAddress": null,
    "remarks": "some remarks",
    "delivery": "DELIVERY",
    "orderLines": [
        {
            "articleNumber": "A1234",
            "description": null,
            "quantity": 1,
            "packingEntity": "Bottle",
            "price": {
                "amount": 1250,
                "precision": 2
            },
            "discountPrice": {
                "amount": 1250,
                "precision": 2
            },
            "vatPercentage": {
                "amount": 0,
                "precision": 0
            }
        },
        {
            "articleNumber": "A1235",
            "description": null,
            "quantity": 1,
            "packingEntity": "Box",
            "price": {
                "amount": 1750,
                "precision": 2
            },
            "discountPrice": {
                "amount": 1750,
                "precision": 2
            },
            "vatPercentage": {
                "amount": 0,
                "precision": 0
            }
        }
    ],
    "attributes": []
}