Shop.simple

Request

Fields when send to the api inside a request.

Field Type Description
id Int Id of the shop
name String Name of the shop (translated)
address Address.detailed An address
allow_comments Bool A boolean value
url String A String value
allow_order_comments Bool A boolean value
allow_product_comments Bool A boolean value
allow_order_messages Bool A boolean value
global_discount_percentage Int Discount percentage for all products
allow_orders Bool A boolean value
currency Currency 3 letter ISO 4217 currency name (string)

Response

Fields when returned by the api in a response.

Field Type Description
id Int Id of the shop
name String Name of the shop (translated)
address Address.detailed An address
allow_comments Bool A boolean value
url String A String value
allow_order_comments Bool A boolean value
allow_product_comments Bool A boolean value
allow_order_messages Bool A boolean value
global_discount_percentage Int Discount percentage for all products
allow_orders Bool A boolean value
currency Currency 3 letter ISO 4217 currency name (string)

Examples

Request

When used inside a request.

Example 1

{
    "id": 12,
    "name": "Lorenz Harvey",
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE"
    },
    "allow_comments": false,
    "url": "...",
    "allow_order_comments": false,
    "allow_product_comments": false,
    "allow_order_messages": false,
    "global_discount_percentage": 13,
    "allow_orders": false,
    "currency": "EUR"
}

Response

When returned in a response.

Example 1

{
    "id": 15,
    "name": "Anahi Davis",
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE",
        "position": {
            "latitude": 1.54361,
            "longitude": 0.45645
        }
    },
    "allow_comments": true,
    "url": "...",
    "allow_order_comments": false,
    "allow_product_comments": true,
    "allow_order_messages": true,
    "global_discount_percentage": 14,
    "allow_orders": true,
    "currency": "EUR"
}
This is a development version Do not use this version in production
1.10.0 development