Back to top

Gebraucht REST API V3

API overview

Bit of a description or intro, and an introduction to how to OAuth, etc.

How to use the Gebraucht REST API

We have designed the Gebraucht API in a very RESTful way, so that your user experience is simple and straightforward (Wikipedia). You are able to:

Submit data requires an HTTP POST request Retrieve data requires an HTTP GET request Change data requires an HTTP PUT request

Requests must be sent using Content-Type “application/json”. The request and response body encoding is always UTF-8.

Global Validation & Errors

401 Unauthorized

If you try to do an request with an expired access token you receive a 401 Unauthorized

{
  "message": "The resource owner or authorization server denied the request.",
  "status_code": 401
}

If you try to access an endpoint without having an access token with the right scope, you receive a 401 Unauthorized. This is likely to happen if you have only an access token for public requests and not one that is connected to a logged in user.

{
  "message": "The requested scope is invalid, unknown, or malformed. Check the \"user\" scope.",
  "status_code": 401
}

If you try to do something without the right permissions, e.g. updating an item that doesn’t belongs to you, you receive a 401 Unauthorized.

{
  "message": "401 Unauthorized",
  "status_code": 401
}

403 Forbidden

For some endpoints the logged in user needs to have a confirmed email, if the user isn’t confirmed you’ll receive a 403 Forbidden response.

{
  "message": "User is not confirmed",
  "status_code": 403
}

403 Profile Incomplete

For some endpoints, the logged in user needs to have a complete profile. If that’s not the case, the following response will be received.

{
  "message": "Profile needs to be complete to perform this action.",
  "error_type": "profile_complete_required",
  "status_code": 403
}

404 Not Found

If you try to request an object that doesn’t exist or is not available for you, you can receive a 404 Not Found

{
  "message": "404 Not Found",
  "status_code": 404
}

422 Request Validation

Usually all validation responses should response an error code 422 with response data as follows as example. The errors param of the response always holds a list of key values, whereas the key is always the name of the validatied field and the value is a list of error objects containing an identifier (code) and a message that could be shown at the frontend. One field could have multiple errors.

The different validation error codes depend on the specific endpoint and are based on the available Laravel validation rules plus some uniquely implemented ones: https://laravel.com/docs/5.3/validation#available-validation-rules

Response 422 (application/json)

{
      "message": "422 Unprocessable Entity",
      "errors": {
          "terms": [
              {
                  "code": "required",
                  "message": "Bitte unsere AGB akzeptieren"
              }
          ],
          "password": [
              {
                  "code": "confirmed",
                  "message": "Passwörter stimmen nicht überein"
              }
          ],
          "firstname": [
              {
                  "code": "required_without",
                  "message": "Bitte deinen Vornamen angeben"
              }
          ],
          "lastname": [
              {
                  "code": "required_without",
                  "message": "Bitte deinen Nachnamen angeben"
              }
          ],
          "username": [
              {
                  "code": "required_without",
                  "message": "Benutzername benötigt, wenn kein Vorname angegeben wurde"
              }
          ]
      },
      "status_code": 422
  }

500 Server Error

If something internally breaks and goes completely wrong you receive a 500 Server error response:

{
  "error": "Something went wrong."
}

Address

Get all Addresses

Get all Addresses
GET/v3/addresses

Returns all addresses owned by an authenticated user.

Example URI

GET /v3/addresses
Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "first_name": "John",
    "last_name": "Doe",
    "street_line_1": "Bar_Street_1",
    "house_number": "123A",
    "zip_code": "12345",
    "city": "Berlin",
    "country_code": "DE",
    "company_name": "Gebraucht",
    "created_at": "2017-01-01T00:00:00+0000",
    "updated_at": "2017-01-01T00:00:00+0000"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "street_line_1": {
          "type": "string"
        },
        "house_number": {
          "type": "string"
        },
        "zip_code": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "country_code": {
          "type": "string"
        },
        "company_name": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      }
    }
  }
}

Create a new address
POST/v3/addresses

Let the authenticated user create one new address.

Example URI

POST /v3/addresses
Request
HideShow
Headers
Authorization: Bearer <access_token>
Body
{
  "first_name": "John",
  "last_name": "Doe",
  "street_line_1": "Foo_Street_1",
  "house_number: Foo_Street_2": "Hello, world!",
  "zip_code": "12345",
  "city": "Berlin",
  "country_code": "DE",
  "company": "Gebraucht"
}
Schema
{
  "type": "object",
  "properties": {
    "first_name": {
      "type": "string",
      "description": "(required, string) the first name"
    },
    "last_name": {
      "type": "string",
      "description": "(required, string) the last name"
    },
    "street_line_1": {
      "type": "string",
      "description": "(required, string) street and number of the address"
    },
    "house_number: Foo_Street_2": {
      "type": "string",
      "description": "(not required, string) additional details"
    },
    "zip_code": {
      "type": "string",
      "description": "(required, string) ZIP code of the address."
    },
    "city": {
      "type": "string",
      "description": "(required, string) city if the address"
    },
    "country_code": {
      "type": "string",
      "description": "(required, string, size:2) Country of the address"
    },
    "company": {
      "type": "string",
      "description": "(not required, string) Company of the user address"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "first_name": "John",
  "last_name": "Doe",
  "street_line_1": "Bar_Street_1",
  "house_number": "123A",
  "zip_code": "12345",
  "city": "Berlin",
  "country_code": "DE",
  "company_name": "Gebraucht",
  "created_at": "2017-01-01T00:00:00+0000",
  "updated_at": "2017-01-01T00:00:00+0000"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "street_line_1": {
      "type": "string"
    },
    "house_number": {
      "type": "string"
    },
    "zip_code": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "country_code": {
      "type": "string"
    },
    "company_name": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Profile needs to be complete to perform this action.",
  "error_type: `profile_complete_required`": "Hello, world!",
  "status_code": "403"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "error_type: `profile_complete_required`": {
      "type": "string"
    },
    "status_code": {
      "type": "string"
    }
  }
}

Get one address

Get one address
GET/v3/addresses/{id}

Let the authenticated user display one of its addresses.

Example URI

GET /v3/addresses/1
URI Parameters
HideShow
id
number (required) Example: 1
Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "first_name": "John",
    "last_name": "Doe",
    "street_line_1": "Bar_Street_1",
    "house_number": "123A",
    "zip_code": "12345",
    "city": "Berlin",
    "country_code": "DE",
    "company_name": "Gebraucht",
    "created_at": "2017-01-01T00:00:00+0000",
    "updated_at": "2017-01-01T00:00:00+0000"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "street_line_1": {
          "type": "string"
        },
        "house_number": {
          "type": "string"
        },
        "zip_code": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "country_code": {
          "type": "string"
        },
        "company_name": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      }
    }
  }
}

Remove one address
DELETE/v3/addresses/{id}

Let the authenticated user delete one address.

Example URI

DELETE /v3/addresses/1
URI Parameters
HideShow
id
number (required) Example: 1
Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  204

Update a address
PUT/v3/addresses/{id}

Let the authenticated user update one of his addresses.

Example URI

PUT /v3/addresses/1
URI Parameters
HideShow
id
number (required) Example: 1
Request
HideShow
Headers
Authorization: Bearer <access_token>
Body
{
  "first_name": "John",
  "last_name": "Doe",
  "street_line_1": "Foo_Street_1",
  "street_line_2": "Foo_Street_2",
  "zip_code": "12345",
  "city": "Berlin",
  "country_code": "DE"
}
Schema
{
  "type": "object",
  "properties": {
    "first_name": {
      "type": "string",
      "description": "(required, string) the first name"
    },
    "last_name": {
      "type": "string",
      "description": "(required, string) the last name"
    },
    "street_line_1": {
      "type": "string",
      "description": "(required, string) street and number of the address"
    },
    "street_line_2": {
      "type": "string",
      "description": "(not required, string) additional details"
    },
    "zip_code": {
      "type": "string",
      "description": "(required, string) ZIP code of the address."
    },
    "city": {
      "type": "string",
      "description": "(required, string) city if the address"
    },
    "country_code": {
      "type": "string",
      "description": "(required, string, size:2) Country of the address"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "first_name": "John",
    "last_name": "Doe",
    "street_line_1": "Bar_Street_1",
    "house_number": "123A",
    "zip_code": "12345",
    "city": "Berlin",
    "country_code": "DE",
    "company_name": "Gebraucht",
    "created_at": "2017-01-01T00:00:00+0000",
    "updated_at": "2017-01-01T00:00:00+0000"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "street_line_1": {
          "type": "string"
        },
        "house_number": {
          "type": "string"
        },
        "zip_code": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "country_code": {
          "type": "string"
        },
        "company_name": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      }
    }
  }
}

Articles

Create

Create
POST/v3/articles

Create and publish a new article for a logged in user

Example URI

POST /v3/articles
Request
HideShow
Headers
Authorization: Bearer <access_token>
Body
{
  "title": "object xyz",
  "body": "this is a long description",
  "category_id": 1,
  "price": 10,
  "stock": 5,
  "delivery_cost_split": "50/50",
  "total_delivery_cost": "10|10,51|10.51",
  "location": {
    "country_code": "DE",
    "longitude": 13.428308,
    "latitude": 52.497703,
    "post_code": "10999"
  },
  "files": [
    {
      "temp_key": "xyz",
      "keyword": "front"
    }
  ],
  "attributes": [],
  "KEY": [],
  "terms": "0|1",
  "is_draft": 0,
  "carrier_plan_id": "1",
  "min_length": "100",
  "max_length": "120",
  "min_width": "80",
  "max_width": "90",
  "min_height": "50",
  "max_height": "60",
  "min_weight": "30",
  "max_weight": "40",
  "open_for_offers": true,
  "voucher_code": "MAYFD",
  "extra_attributes (array) - KEY => VALUE array data of extra_attributes": "Hello, world!",
  "open_for_dynamic_pricing": false,
  "buyer_pickup: false (boolean,optional) - required if Category::transaction_type=MLO_ONLY_DELIVERY OR MLO_REQUIRED_DELIVERY_AND_OPTIONAL_BUYER_PICKUP": "Hello, world!",
  "transaction_type: 'managed|classified|managed_and_classified'": "Hello, world!"
}
Schema
{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "Title of the item to sell."
    },
    "body": {
      "type": "string",
      "description": "Description for the article with a max length of 4000 characters."
    },
    "category_id": {
      "type": "number",
      "description": "Id of the category."
    },
    "price": {
      "type": "number",
      "description": "Price to sell the item. Only integers allowed!"
    },
    "stock": {
      "type": "number"
    },
    "delivery_cost_split": {
      "type": "string",
      "description": "How to split delivery cost. Options are 50/50, 0/100, 100/0."
    },
    "total_delivery_cost": {
      "type": "string",
      "description": "Total delivery costs within the country. Required in case of self shipping."
    },
    "location": {
      "type": "object",
      "properties": {
        "country_code": {
          "type": "string",
          "description": "2 character country code"
        },
        "longitude": {
          "type": "number",
          "description": "Longitude as a decimal."
        },
        "latitude": {
          "type": "number",
          "description": "Latitude as a decimal."
        },
        "post_code": {
          "type": "string",
          "description": "Postcode."
        }
      },
      "required": [
        "country_code",
        "longitude",
        "latitude",
        "post_code"
      ],
      "description": "Location data object"
    },
    "files": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "temp_key": {
            "type": "string",
            "description": "temporary key you receive on uploads endpoint"
          },
          "keyword": {
            "type": "string",
            "description": "keyword linked to the photo based on category photo icons keyword"
          }
        },
        "required": [
          "temp_key"
        ]
      },
      "description": "Array objects / list of files that should be linked to the article, the order of the objects will be taken as sort indicator."
    },
    "attributes": {
      "type": "array",
      "description": "KEY => VALUE array data of attached attributes"
    },
    "KEY": {
      "type": "array",
      "description": "A single value for the attribute or a list of values within an array."
    },
    "terms": {
      "type": "string",
      "description": "Only required if the accepted_terms date from the posting user is older than the actual terms (delivered by the GET /meta request)."
    },
    "is_draft": {
      "type": "number",
      "description": "0 or 1 for false/true. If true, will be saved as paused."
    },
    "carrier_plan_id": {
      "type": "string"
    },
    "min_length": {
      "type": "string"
    },
    "max_length": {
      "type": "string"
    },
    "min_width": {
      "type": "string"
    },
    "max_width": {
      "type": "string"
    },
    "min_height": {
      "type": "string"
    },
    "max_height": {
      "type": "string"
    },
    "min_weight": {
      "type": "string"
    },
    "max_weight": {
      "type": "string"
    },
    "open_for_offers": {
      "type": "boolean",
      "description": "whether the seller is open for offers on this product"
    },
    "voucher_code": {
      "type": "string"
    },
    "extra_attributes (array) - KEY => VALUE array data of extra_attributes": {
      "type": "string"
    },
    "open_for_dynamic_pricing": {
      "type": "boolean",
      "description": "lets decrease the article price automatically after while"
    },
    "buyer_pickup: false (boolean,optional) - required if Category::transaction_type=MLO_ONLY_DELIVERY OR MLO_REQUIRED_DELIVERY_AND_OPTIONAL_BUYER_PICKUP": {
      "type": "string"
    },
    "transaction_type: 'managed|classified|managed_and_classified'": {
      "type": "string",
      "description": "Transaction type of the article"
    }
  },
  "required": [
    "files",
    "attributes"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "422 Unprocessable Entity",
  "errors": {
    "title": [
      {
        "code": "required",
        "message": "Bitte einen Titel angeben"
      }
    ],
    "files.0": [
      {
        "code": "exists",
        "message": "The selected files.0 is invalid."
      }
    ],
    "attributes.zustand.0": [
      {
        "code": "filter_setting",
        "message": "Filter Setting fehlerhaft"
      }
    ]
  },
  "status_code": 422
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
              "data": {
                "id": 1925,
                "external_id": 1111,
                "type": "USER_FREE_CLASSIFIED",
                "title": "My awesome product",
                "body": "This is an example description!",
                "imprint": "",
                "returnpolicy": "",
                "price": "30",
                "stock": "5",
                "previous_price": 25,
                "buyer_delivery_cost": "5.00",
                "seller_delivery_cost": "5.00",
                "delivery_costs_eu": "5.00",
                "delivery_time": "1 to 3 days",
                "delivery_time_eu": "3 to 7 days",
                "delivery_info": null,
                "currency": "EUR",
                "category_id": 15,
                "url": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/auto_rad_boot/boote_zubehoer/my-awesome-product-1925",
                "created_at": "2017-01-01T00:00:00+0000",
                "to_sell": 1,
                "to_trade": 1,
                "to_give_away": 1,
                "is_premium": 0,
                "is_editable": true,
                "is_buyable": false,
                "has_pending_order": false,
                "itemlist_attributes": [],
                "count_views": 1,
                "count_likes": 0,
                "status": "active",
                "renewable": false,
                "is_favorite": false,
                "open_for_offers": false,
                "buyer_delivery": false,
                "transaction_type": managed,

               "comment_count": 9,
               "carrierPlan": {
                  "data": {
                    "id": 1,
                    "title": "DHL Paket XS",
                    "price": 439,
                    "old_price": 439,
                    "pickup_service": "self_sending",
                    "sellers_phone_required": false,
                    "buyer_phone_required": false,
                    "icon": {
                      "data": {
                        "tiny": "http://abc:[email protected]/uploads/thumbs/2016/10-13/HI1YCnwQ_50x28.jpg",
                        "small": "http://abc:[email protected]/uploads/thumbs/2016/10-13/HI1YCnwQ_250x140.jpg",
                        "medium": "http://abc:[email protected]/uploads/thumbs/2016/10-13/HI1YCnwQ_500x281.jpg"
                      }
                    },
                    "description": null,
                    "info_link": null
                  }
               },
               "comments": {
                 "data": [
                   {
                     "id": 50,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 2,
                     "comment": "a lovely comment",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": []
                     },
                     "user": {
                       "data": {
                         "id": 2,
                         "display_name": "kaiserlos",
                         "username": "kaiserlos",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": null,
                         "confirmed": 1,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": null,
                         "last_login": null,
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@kaiserlos",
                         "country_of_residence_code": null,
                         "post_code": null,
                         "city": null,
                         "verified": false,
                         "response_rate": "0.00",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                         "articles_count": 369,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   },
                   {
                     "id": 51,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 5,
                     "comment": "new comment",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": [
                         {
                           "id": 52,
                           "article_id": 1908,
                           "comment_reply_id": 51,
                           "user_id": 3,
                           "comment": "reply to commment",
                           "created_at": "2017-01-01T00:00:00+0000",
                           "edited_at": null,
                           "updated_at": "2017-01-01T00:00:00+0000",
                           "is_editable": true,
                           "replies": {
                             "data": []
                           },
                           "user": {
                             "data": {
                               "id": 3,
                               "display_name": "oliver",
                               "username": "oliver",
                               "has_picture": false,
                               "picture": {
                                 "data": {
                                   "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                                   "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                                   "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                                 }
                               },
                               "bio": null,
                               "confirmed": 1,
                               "created_at": "2017-01-01T00:00:00+0000",
                               "gender": null,
                               "last_login": null,
                               "is_merchant": false,
                               "has_facebook": false,
                               "rating": "0.00",
                               "rating_count": 0,
                               "url": "http://local.gebraucht.de/@oliver",
                               "country_of_residence_code": null,
                               "post_code": null,
                               "city": null,
                               "verified": false,
                               "response_rate": "0.00",
                               "number_of_followers": 123,
                               "number_of_product_likes": 234,
                               "number_of_sales": 12,
                               "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                               "articles_count": 405,
                               "accepts_paypal": false,
                               "can_be_rated": false
                             }
                           }
                         },
                         {
                           "id": 53,
                           "article_id": 1908,
                           "comment_reply_id": 51,
                           "user_id": 1,
                           "comment": "reply to commment 2",
                           "created_at": "2017-01-01T00:00:00+0000",
                           "edited_at": null,
                           "updated_at": "2017-01-01T00:00:00+0000",
                           "is_editable": true,
                           "replies": {
                             "data": [
                               {
                                 "id": 54,
                                 "article_id": 1908,
                                 "comment_reply_id": 53,
                                 "user_id": 2,
                                 "comment": "reply to commment 3 ",
                                 "created_at": "2017-01-01T00:00:00+0000",
                                 "edited_at": null,
                                 "updated_at": "2017-01-01T00:00:00+0000",
                                 "is_editable": true,
                                 "replies": {
                                   "data": []
                                 },
                                 "user": {
                                   "data": {
                                     "id": 2,
                                     "display_name": "kaiserlos",
                                     "username": "kaiserlos",
                                     "has_picture": false,
                                     "picture": {
                                       "data": {
                                         "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                                         "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                                         "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                                       }
                                     },
                                     "bio": null,
                                     "confirmed": 1,
                                     "created_at": "2017-01-01T00:00:00+0000",
                                     "gender": null,
                                     "last_login": null,
                                     "is_merchant": false,
                                     "has_facebook": false,
                                     "rating": "0.00",
                                     "rating_count": 0,
                                     "url": "http://local.gebraucht.de/@kaiserlos",
                                     "country_of_residence_code": null,
                                     "post_code": null,
                                     "city": null,
                                     "verified": false,
                                     "response_rate": "0.00",
                                     "number_of_followers": 123,
                                     "number_of_product_likes": 234,
                                     "number_of_sales": 12,
                                     "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                                     "articles_count": 369,
                                     "accepts_paypal": false,
                                     "can_be_rated": false
                                   }
                                 }
                               }
                             ]
                           },
                           "user": {
                             "data": {
                               "id": 1,
                               "display_name": "A A.",
                               "username": "admin",
                               "has_picture": false,
                               "picture": {
                                 "data": {
                                   "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                                   "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                                   "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                                 }
                               },
                               "bio": "This is my bio line",
                               "confirmed": 0,
                               "created_at": "2017-01-01T00:00:00+0000",
                               "gender": "m",
                               "last_login": "2017-01-01T00:00:00+0000",
                               "is_merchant": false,
                               "has_facebook": false,
                               "rating": "0.00",
                               "rating_count": 0,
                               "url": "http://local.gebraucht.de/@admin",
                               "country_of_residence_code": "DE",
                               "post_code": "11111",
                               "city": null,
                               "verified": true,
                               "response_rate": "23.53",
                               "number_of_followers": 123,
                               "number_of_product_likes": 234,
                               "number_of_sales": 12,
                               "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=42.7156271,-83.7411562&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:{[email protected][email protected]@nFfB~EtCpE~DxDbF~CdGdC`[email protected][email protected]~G_DdGyDdFqE|[email protected]{[email protected][email protected]",
                               "articles_count": 403,
                               "accepts_paypal": false,
                               "can_be_rated": false
                             }
                           }
                         }
                       ]
                     },
                     "user": {
                       "data": {
                         "id": 5,
                         "display_name": "Justin K.",
                         "username": "justin",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": "I am looking to sell my excess stuff to de-clutter my life",
                         "confirmed": 1,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": "m",
                         "last_login": "2017-01-01T00:00:00+0000",
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@justin",
                         "country_of_residence_code": null,
                         "post_code": null,
                         "city": null,
                         "verified": true,
                         "response_rate": "0.00",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                         "articles_count": 368,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   },
                   {
                     "id": 55,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 1,
                     "comment": "next question",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": []
                     },
                     "user": {
                       "data": {
                         "id": 1,
                         "display_name": "A A.",
                         "username": "admin",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": "This is my bio line",
                         "confirmed": 0,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": "m",
                         "last_login": "2017-01-01T00:00:00+0000",
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@admin",
                         "country_of_residence_code": "DE",
                         "post_code": "11111",
                         "city": null,
                         "verified": true,
                         "response_rate": "23.53",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=42.7156271,-83.7411562&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:{[email protected][email protected]@nFfB~EtCpE~DxDbF~CdGdC`[email protected][email protected]~G_DdGyDdFqE|[email protected]{[email protected][email protected]",
                         "articles_count": 403,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   },
                   {
                     "id": 56,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 1,
                     "comment": "next reply!",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": []
                     },
                     "user": {
                       "data": {
                         "id": 1,
                         "display_name": "A A.",
                         "username": "admin",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": "This is my bio line",
                         "confirmed": 0,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": "m",
                         "last_login": "2017-01-01T00:00:00+0000",
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@admin",
                         "country_of_residence_code": "DE",
                         "post_code": "11111",
                         "city": null,
                         "verified": true,
                         "response_rate": "23.53",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=42.7156271,-83.7411562&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:{[email protected][email protected]@nFfB~EtCpE~DxDbF~CdGdC`[email protected][email protected]~G_DdGyDdFqE|[email protected]{[email protected][email protected]",
                         "articles_count": 403,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   },
                   {
                     "id": 63,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 5,
                     "comment": "a lovely comment",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": [
                         {
                           "id": 64,
                           "article_id": 1908,
                           "comment_reply_id": 63,
                           "user_id": 1,
                           "comment": "reply 12345",
                           "created_at": "2017-01-01T00:00:00+0000",
                           "edited_at": null,
                           "updated_at": "2017-01-01T00:00:00+0000",
                           "is_editable": true,
                           "replies": {
                             "data": []
                           },
                           "user": {
                             "data": {
                               "id": 1,
                               "display_name": "A A.",
                               "username": "admin",
                               "has_picture": false,
                               "picture": {
                                 "data": {
                                   "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                                   "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                                   "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                                 }
                               },
                               "bio": "This is my bio line",
                               "confirmed": 0,
                               "created_at": "2017-01-01T00:00:00+0000",
                               "gender": "m",
                               "last_login": "2017-01-01T00:00:00+0000",
                               "is_merchant": false,
                               "has_facebook": false,
                               "rating": "0.00",
                               "rating_count": 0,
                               "url": "http://local.gebraucht.de/@admin",
                               "country_of_residence_code": "DE",
                               "post_code": "11111",
                               "city": null,
                               "verified": true,
                               "response_rate": "23.53",
                               "number_of_followers": 123,
                               "number_of_product_likes": 234,
                               "number_of_sales": 12,
                               "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=42.7156271,-83.7411562&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:{[email protected][email protected]@nFfB~EtCpE~DxDbF~CdGdC`[email protected][email protected]~G_DdGyDdFqE|[email protected]{[email protected][email protected]",
                               "articles_count": 403,
                               "accepts_paypal": false,
                               "can_be_rated": false
                             }
                           }
                         }
                       ]
                     },
                     "user": {
                       "data": {
                         "id": 5,
                         "display_name": "Justin K.",
                         "username": "justin",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": "I am looking to sell my excess stuff to de-clutter my life",
                         "confirmed": 1,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": "m",
                         "last_login": "2017-01-01T00:00:00+0000",
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@justin",
                         "country_of_residence_code": null,
                         "post_code": null,
                         "city": null,
                         "verified": true,
                         "response_rate": "0.00",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                         "articles_count": 368,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   }
                 ]
               },

                "location": {
                  "data": {
                    "latitude": 10.000120018427,
                    "longitude": 9.9988404659265,
                    "street": "",
                    "city": "Berlin",
                    "post_code": "12345",
                    "country_code": "DE"
                  }
                },
                "user": {
                  "data": {
                    "id": 1,
                    "display_name": "dfsdf a.",
                    "username": "admin",
                    "picture": {
                      "data": {
                        "tiny": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                        "small": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                        "medium": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                      }
                    },
                    "confirmed": 1,
                    "created_at": "2017-01-01T00:00:00+0000",
                    "gender": "m",
                    "last_login": "2017-01-01T00:00:00+0000",
                    "is_merchant": false,
                    "has_facebook": false,
                    "rating": "0.00",
                    "rating_count": 0,
                    "url": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/@admin",
                    "response_rate": 99,
                    "articles_count": 5,
                    "verified": false,
                    "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.500377,13.360147&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:qvn_I{kppAP{[email protected]}[email protected][email protected][email protected]|[email protected]}[email protected]",
                    "number_of_followers": 123,
                    "number_of_product_likes": 234,
                    "number_of_sales": 12,
                    "accepts_paypal": false,
                    "can_be_rated": false
                  }
                },
                "files": {
                  "data": [
                    {
                      "id": 3359,
                      "tiny": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_36x60.jpeg",
                      "small": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_73x120.jpeg",
                      "medium": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_242x400.jpeg",
                      "big": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_424x700.jpeg",
                      "large": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_606x1000.jpeg"
                    }
                  ]
                },
                "filtersettings": {
                  "data": [
                    {
                      "id": 1,
                      "key": "transport",
                      "position": 1000,
                      "value_select": "Transport",
                      "value_form": "Transport",
                      "value_details": "Transport",
                      "type_form": "checkbox",
                      "type_select": "radio",
                      "show_at_select": 1,
                      "show_at_form": 1,
                      "show_at_details": 1,
                      "show_at_form_if_filtersetting": "NULL",
                      "show_at_head": 1,
                      "show_at_itemlist": 0,
                      "show_at_itemlist_format": "",
                      "template_select": "list",
                      "template_form": "list",
                      "template_detail": "",
                      "individual_values": 0,
                      "min_setting_count": 0,
                      "max_setting_count": 0,
                      "settings": {
                        "data": [
                          {
                            "id": 2,
                            "filter_id": 1,
                            "filter_key": null,
                            "value_key": "versand",
                            "value_select": "Versand",
                            "value_description": null,
                            "value_form": "Versand",
                            "value_details": "Versand",
                            "position": 1,
                            "is_individual_value": "0"
                          }
                        ]
                      }
                    },
                    {
                      "id": 3,
                      "key": "zustand",
                      "position": 1000,
                      "value_select": "Zustand",
                      "value_form": "Zustand",
                      "value_details": "Zustand",
                      "type_form": "select",
                      "type_select": "checkbox",
                      "show_at_select": 1,
                      "show_at_form": 1,
                      "show_at_details": 1,
                      "show_at_form_if_filtersetting": "NULL",
                      "show_at_head": 1,
                      "show_at_itemlist": 0,
                      "show_at_itemlist_format": "",
                      "template_select": "list"
                      "template_form": "list",
                      "template_detail": "",
                      "individual_values": 0,
                      "min_setting_count": 0,
                      "max_setting_count": 0,
                      "settings": {
                        "data": [
                          {
                            "id": 364,
                            "filter_id": 3,
                            "filter_key": null,
                            "value_key": "good",
                            "value_select": "Gut",
                            "value_description": "Der Artikel hat einige offensichtliche Gebrauchsspuren, z.B. deutliche Kratzer oder kleine Beschädigungen.",
                            "value_form": "Gut",
                            "value_details": "Gut",
                            "position": 3,
                            "is_individual_value": "0"
                          }
                        ]
                      }
                    }
                  ]
                },
                "extra_attributes" => {"code" => "1010"},

              }
            },

Retrieve Article

Retrieve Article
GET/v3/articles/{id}?include={include}&count_hit={count_hit}

Get information about one Article

Example URI

GET /v3/articles/5?include=comments|carrierPlan&count_hit=false
URI Parameters
HideShow
id
number (required) Example: 5

Id of the article.

include
string (optional) Example: comments|carrierPlan

Additional includes as comma seperated list: Values.

count_hit
boolean (optional) Example: false

whether the hit should be counted as read. Default false.

Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
      "data": [
        {
          "id": 1902,
          "external_id": 1111,
          "type": "USER_FREE_CLASSIFIED",
          "title": "Wäschemangel",
          "body": "restaurationsbedürftige Wäschemangel an Selbstabholer",
          "imprint": "",
          "returnpolicy": "",
          "price": 35,
          "previous_price": 25,
          "delivery_cost_split": null,
          "seller_delivery_cost": null,
          "buyer_delivery_cost": null,
          "delivery_costs_eu": null,
          "delivery_time": null,
          "delivery_time_eu": null,
          "delivery_info": null,
          "currency": "EUR",
          "category_id": 8,
          "url": "http://local.gebraucht.de/freizeit_hobby_sport/haustiere_tiere/waschemangel-1902",
          "created_at": "2016-10-14T10:14:22+0000",
          "to_sell": 1,
          "to_trade": 0,
          "to_give_away": 0,
          "is_premium": 0,
          "is_editable": true,
          "is_buyable": false,
          "itemlist_attributes": [],
          "response_rate": "0.00",
          "comment_count": 0,
          "count_views": "0",
          "count_likes": "0",
          "is_new": false,
          "carrierPlan": {
              "data": {
                "id": 1,
                "title": "DHL Paket XS",
                "price": 439,
                "old_price": 439,
                "pickup_service": "self_sending",
                "sellers_phone_required": false,
                "buyer_phone_required": false,
                "icon": {
                  "data": {
                    "tiny": "http://abc:[email protected]/uploads/thumbs/2016/10-13/HI1YCnwQ_50x28.jpg",
                    "small": "http://abc:[email protected]/uploads/thumbs/2016/10-13/HI1YCnwQ_250x140.jpg",
                    "medium": "http://abc:[email protected]/uploads/thumbs/2016/10-13/HI1YCnwQ_500x281.jpg"
                  }
                },
                "description": null,
                "info_link": null
              }
           },
          "policies": {
            "data": [
              {
                "label": "Returns",
                "description": "Accepted within 1 month of purchase",
                "link_label": "Buyer pays shipping",
                "link_url": "http://local.gebraucht.de/policy/returns"
              },
              {
                "label": "Returns",
                "description": "Accepted within 1 week of purchase",
                "link_label": null,
                "link_url": null
              },
              {
                "label": "Payments",
                "description": "Paypal, Direct Debit, Credit Card, Bank Transfer",
                "link_label": "Payment Information",
                "link_url": "http://local.gebraucht.de/policy/payments"
              },
              {
                "label": "Guarentee",
                "description": "Buyer protection",
                "link_label": "If paid with Paypal or credit card",
                "link_url": "http://local.gebraucht.de/policy/guarentee"
              }
            ]
          },
          "carrier_plan_id": null,
          "min_length": 0,
          "max_length": 0,
          "min_width": 0,
          "max_width": 0,
          "min_height": 0,
          "max_height": 0,
          "min_weight": 0,
          "max_weight": 0,
          "status": "active",
          "renewable": true,
          "is_favorite": true,
          "location": {
            "data": {
              "latitude": 54.48477919768,
              "longitude": 9.0600323027975,
              "street": "",
              "city": "Husum",
              "post_code": "",
              "country_code": "DE"
            }
          },
          "user": {
            "data": {
              "id": 8,
              "display_name": "Justin K.",
              "username": "justin098",
              "has_picture": false,
              "picture": {
                "data": {
                  "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                  "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                  "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                }
              },
              "bio": "",
              "confirmed": 1,
              "created_at": "2017-01-02T15:11:04+0000",
              "gender": "m",
              "last_login": "2017-03-01T11:25:33+0000",
              "is_merchant": false,
              "has_facebook": false,
              "rating": "0.00",
              "rating_count": 0,
              "url": "http://local.gebraucht.de/@justin098",
              "country_of_residence_code": null,
              "post_code": null,
              "city": null,
              "verified": true,
              "response_rate": "0.00",
              "number_of_followers": 0,
              "number_of_product_likes": 0,
              "number_of_sales": 0,
              "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
              "articles_count": 2,
              "accepts_paypal": false,
              "can_be_rated": false,
              "email": "[email protected]",
              "accepted_terms": "2017-01-02T00:00:00+0000",
              "firstname": "Justin",
              "lastname": "Kingsss",
              "birthday": "2017-03-01T15:59:17+0000",
              "email_temp": "",
              "profile_is_complete": false,
              "profile_not_complete_errors": {
                "country_of_residence_code": [
                  {
                    "code": "required",
                    "message": "Bitte Wohnsitz angeben."
                  }
                ],
                "post_code": [
                  {
                    "code": "required",
                    "message": "Bitte Postleitzahl angeben."
                  }
                ]
              }
            }
          },
          "files": {
            "data": [
              {
                "id": 3257,
                "tiny": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/Rh1UNpWg_45x60.jpg",
                "small": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/Rh1UNpWg_90x120.jpg",
                "medium": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/Rh1UNpWg_300x400.jpg",
                "big": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/Rh1UNpWg_525x700.jpg",
                "large": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/Rh1UNpWg_1000x1000_grab.jpg",
                "position": null,
                "keyword": null
              },
              {
                "id": 3258,
                "tiny": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/0wOEi5b2_45x60.jpg",
                "small": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/0wOEi5b2_90x120.jpg",
                "medium": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/0wOEi5b2_300x400.jpg",
                "big": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/0wOEi5b2_525x700.jpg",
                "large": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/0wOEi5b2_749x1000.jpg",
                "position": null,
                "keyword": null
              }
            ]
          },
          "filtersettings": {
            "data": [
              {
                "id": 30,
                "key": "paymentmethod",
                "position": 600,
                "value_select": "Zahlungsmethode",
                "value_form": "Zahlungsmethode",
                "value_details": "Zahlungsmethode",
                "required": 0,
                "type_form": "radio",
                "type_select": "radio",
                "show_at_select": 1,
                "show_at_form": 0,
                "show_at_details": 0,
                "show_at_form_if_filtersetting": "NULL",
                "show_at_head": 0,
                "show_at_itemlist": 0,
                "show_at_itemlist_format": null,
                "template_select": "list",
                "template_form": "list",
                "template_detail": null,
                "individual_values": 0,
                "min_setting_count": 0,
                "max_setting_count": 0,
                "settings": {
                  "data": [
                    {
                      "id": 354,
                      "filter_id": 30,
                      "filter_key": "paymentmethod",
                      "value_key": "paypal",
                      "value_select": "Paypal",
                      "value_description": "NULL",
                      "value_form": "Paypal",
                      "value_details": "Paypal",
                      "position": 0,
                      "is_individual_value": "0",
                      "active_icon": null,
                      "active_checksum": "",
                      "inactive_icon": null,
                      "inactive_checksum": ""
                    }
                  ]
                }
              },
              {
                "id": 3,
                "key": "zustand",
                "position": 700,
                "value_select": "Zustand",
                "value_form": "Zustand",
                "value_details": "Zustand",
                "required": 1,
                "type_form": "select",
                "type_select": "checkbox",
                "show_at_select": 1,
                "show_at_form": 1,
                "show_at_details": 1,
                "show_at_form_if_filtersetting": "NULL",
                "show_at_head": 1,
                "show_at_itemlist": 0,
                "show_at_itemlist_format": null,
                "template_select": "list",
                "template_form": "list",
                "template_detail": null,
                "individual_values": 0,
                "min_setting_count": 0,
                "max_setting_count": 0,
                "settings": {
                  "data": [
                    {
                      "id": 5,
                      "filter_id": 3,
                      "filter_key": "zustand",
                      "value_key": "as-new",
                      "value_select": "Wie neu",
                      "value_description": "Der Artikel ist neuwertig und weist keinerlei Gebrauchsspuren auf.",
                      "value_form": "Wie neu",
                      "value_details": "Wie neu",
                      "position": 1,
                      "is_individual_value": "0",
                      "active_icon": null,
                      "active_checksum": "",
                      "inactive_icon": null,
                      "inactive_checksum": ""
                    }
                  ]
                }
              },
              {
                "id": 32,
                "key": "collection",
                "position": 1000,
                "value_select": "Collection",
                "value_form": "Collection",
                "value_details": "Collection",
                "required": 0,
                "type_form": "checkbox",
                "type_select": "checkbox",
                "show_at_select": 0,
                "show_at_form": 0,
                "show_at_details": 0,
                "show_at_form_if_filtersetting": "NULL",
                "show_at_head": 0,
                "show_at_itemlist": 0,
                "show_at_itemlist_format": null,
                "template_select": "list",
                "template_form": "list",
                "template_detail": null,
                "individual_values": 0,
                "min_setting_count": 0,
                "max_setting_count": 0,
                "settings": {
                  "data": [
                    {
                      "id": 365,
                      "filter_id": 32,
                      "filter_key": "collection",
                      "value_key": "selected_by_us",
                      "value_select": "Von uns ausgewählt",
                      "value_description": "NULL",
                      "value_form": "Von uns ausgewählt",
                      "value_details": "Von uns ausgewählt",
                      "position": 1000,
                      "is_individual_value": "0",
                      "active_icon": null,
                      "active_checksum": "",
                      "inactive_icon": null,
                      "inactive_checksum": ""
                    }
                  ]
                }
              },
              {
                "id": 1,
                "key": "transport",
                "position": 1000,
                "value_select": "Transport",
                "value_form": "Transport",
                "value_details": "Transport",
                "required": 1,
                "type_form": "checkbox",
                "type_select": "radio",
                "show_at_select": 1,
                "show_at_form": 1,
                "show_at_details": 1,
                "show_at_form_if_filtersetting": "NULL",
                "show_at_head": 1,
                "show_at_itemlist": 0,
                "show_at_itemlist_format": null,
                "template_select": "list",
                "template_form": "transport_inline",
                "template_detail": null,
                "individual_values": 0,
                "min_setting_count": 0,
                "max_setting_count": 0,
                "settings": {
                  "data": [
                    {
                      "id": 1,
                      "filter_id": 1,
                      "filter_key": "transport",
                      "value_key": "abholung",
                      "value_select": "Abholung",
                      "value_description": "NULL",
                      "value_form": "Abholung",
                      "value_details": "Abholung",
                      "position": 2,
                      "is_individual_value": "0",
                      "active_icon": null,
                      "active_checksum": "",
                      "inactive_icon": null,
                      "inactive_checksum": ""
                    }
                  ]
                }
              }
            ]
          }
        },
        {
          "id": 1802,
          "type": "USER_FREE_CLASSIFIED",
          "title": "DDR Sammlung 1949-1990 in 7 SAFEdual Bindern gestempelt komplett",
          "body": "Biete hier eine komplette gestempelte Sammlung DDR ab 1949 - 1990 in 7 SAFE dual Bindern an, dabei alle gesuchten Ausgaben enthalten ab Michel-Nr. 242 bis 3365 im hochwertigen Zubehör, keine Wellenstempel gesichtet aber ungeprüft und ohne Obligo, immer wieder mit zusätzlichem teuren Material wie ZDR, Briefe, Dienst, MH, Bogenteile - schöne Sammlung - gegen Höchstgebot abzugeben. Besichtigung und Abholung erwünscht. Gegen Aufgeld kann die Sammlung auch verschickt werden. Die 20 Bilder zeigen nur einen kleinen Teil der lückenlosen Sammlung.",
          "imprint": "",
          "returnpolicy": "",
          "price": null,
          "delivery_cost_split": null,
          "seller_delivery_cost": null,
          "buyer_delivery_cost": null,
          "delivery_costs_eu": null,
          "delivery_time": null,
          "delivery_time_eu": null,
          "delivery_info": null,
          "currency": "EUR",
          "category_id": 289,
          "url": "http://local.gebraucht.de/freizeit_hobby_sport/fanartikel/ddr-sammlung-1949-1990-in-7-safedual-bindern-gestempelt-komplett-1802",
          "created_at": "2016-10-14T10:13:50+0000",
          "to_sell": 1,
          "to_trade": 0,
          "to_give_away": 0,
          "is_premium": 0,
          "is_editable": true,
          "is_buyable": false,
          "itemlist_attributes": [],
          "response_rate": "0.00",
          "comment_count": 0,
          "count_views": 0,
          "count_likes": 0,
          "is_new": false,
          "policies": {
            "data": [
              {
                "label": "Returns",
                "description": "Accepted within 1 month of purchase",
                "link_label": "Buyer pays shipping",
                "link_url": "http://local.gebraucht.de/policy/returns"
              },
              {
                "label": "Returns",
                "description": "Accepted within 1 week of purchase",
                "link_label": null,
                "link_url": null
              },
              {
                "label": "Payments",
                "description": "Paypal, Direct Debit, Credit Card, Bank Transfer",
                "link_label": "Payment Information",
                "link_url": "http://local.gebraucht.de/policy/payments"
              },
              {
                "label": "Guarentee",
                "description": "Buyer protection",
                "link_label": "If paid with Paypal or credit card",
                "link_url": "http://local.gebraucht.de/policy/guarentee"
              }
            ]
          },
          "carrier_plan_id": null,
          "min_length": 0,
          "max_length": 0,
          "min_width": 0,
          "max_width": 0,
          "min_height": 0,
          "max_height": 0,
          "min_weight": 0,
          "max_weight": 0,
          "status": "elapsed",
          "renewable": true,
          "is_favorite": true,
          "location": {
            "data": {
              "latitude": 50.833004724258,
              "longitude": 8.5559837295205,
              "street": "",
              "city": "Dautphetal",
              "post_code": "",
              "country_code": "DE"
            }
          },
          "user": {
            "data": {
              "id": 8,
              "display_name": "Justin K.",
              "username": "justin098",
              "has_picture": false,
              "picture": {
                "data": {
                  "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                  "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                  "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                }
              },
              "bio": "",
              "confirmed": 1,
              "created_at": "2017-01-02T15:11:04+0000",
              "gender": "m",
              "last_login": "2017-03-01T11:25:33+0000",
              "is_merchant": false,
              "has_facebook": false,
              "rating": "0.00",
              "rating_count": 0,
              "url": "http://local.gebraucht.de/@justin098",
              "country_of_residence_code": null,
              "post_code": null,
              "city": null,
              "verified": true,
              "response_rate": "0.00",
              "number_of_followers": 0,
              "number_of_product_likes": 0,
              "number_of_sales": 0,
              "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
              "articles_count": 2,
              "accepts_paypal": false,
              "can_be_rated": false,
              "email": "[email protected]",
              "accepted_terms": "2017-01-02T00:00:00+0000",
              "firstname": "Justin",
              "lastname": "Kingsss",
              "birthday": "2017-03-01T15:59:17+0000",
              "email_temp": "",
              "profile_is_complete": false,
              "profile_not_complete_errors": {
                "country_of_residence_code": [
                  {
                    "code": "required",
                    "message": "Bitte Wohnsitz angeben."
                  }
                ],
                "post_code": [
                  {
                    "code": "required",
                    "message": "Bitte Postleitzahl angeben."
                  }
                ]
              }
            }
          },
          "files": {
            "data": [
              {
                "id": 3082,
                "tiny": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/ZMxaoOmK_60x45.jpg",
                "small": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/ZMxaoOmK_120x90.jpg",
                "medium": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/ZMxaoOmK_400x300.jpg",
                "big": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/ZMxaoOmK_700x525.jpg",
                "large": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/ZMxaoOmK_1000x750.jpg",
                "position": null,
                "keyword": null
              },
              {
                "id": 3083,
                "tiny": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/KKe1PvIW_60x45.jpg",
                "small": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/KKe1PvIW_120x90.jpg",
                "medium": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/KKe1PvIW_400x300.jpg",
                "big": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/KKe1PvIW_700x525.jpg",
                "large": "http://local.gebraucht.de/uploads/thumbs/2016/10-14/KKe1PvIW_1000x750.jpg",
                "position": null,
                "keyword": null
              }
            ]
          },
          "filtersettings": {
            "data": [
              {
                "id": 30,
                "key": "paymentmethod",
                "position": 600,
                "value_select": "Zahlungsmethode",
                "value_form": "Zahlungsmethode",
                "value_details": "Zahlungsmethode",
                "required": 0,
                "type_form": "radio",
                "type_select": "radio",
                "show_at_select": 1,
                "show_at_form": 0,
                "show_at_details": 0,
                "show_at_form_if_filtersetting": "NULL",
                "show_at_head": 0,
                "show_at_itemlist": 0,
                "show_at_itemlist_format": null,
                "template_select": "list",
                "template_form": "list",
                "template_detail": null,
                "individual_values": 0,
                "min_setting_count": 0,
                "max_setting_count": 0,
                "settings": {
                  "data": [
                    {
                      "id": 354,
                      "filter_id": 30,
                      "filter_key": "paymentmethod",
                      "value_key": "paypal",
                      "value_select": "Paypal",
                      "value_description": "NULL",
                      "value_form": "Paypal",
                      "value_details": "Paypal",
                      "position": 0,
                      "is_individual_value": "0",
                      "active_icon": null,
                      "active_checksum": "",
                      "inactive_icon": null,
                      "inactive_checksum": ""
                    }
                  ]
                }
              },
              {
                "id": 3,
                "key": "zustand",
                "position": 700,
                "value_select": "Zustand",
                "value_form": "Zustand",
                "value_details": "Zustand",
                "required": 1,
                "type_form": "select",
                "type_select": "checkbox",
                "show_at_select": 1,
                "show_at_form": 1,
                "show_at_details": 1,
                "show_at_form_if_filtersetting": "NULL",
                "show_at_head": 1,
                "show_at_itemlist": 0,
                "show_at_itemlist_format": null,
                "template_select": "list",
                "template_form": "list",
                "template_detail": null,
                "individual_values": 0,
                "min_setting_count": 0,
                "max_setting_count": 0,
                "settings": {
                  "data": [
                    {
                      "id": 364,
                      "filter_id": 3,
                      "filter_key": "zustand",
                      "value_key": "good",
                      "value_select": "Gut",
                      "value_description": "Der Artikel hat einige offensichtliche Gebrauchsspuren, z.B. deutliche Kratzer oder kleine Beschädigungen.",
                      "value_form": "Gut",
                      "value_details": "Gut",
                      "position": 3,
                      "is_individual_value": "0",
                      "active_icon": null,
                      "active_checksum": "",
                      "inactive_icon": null,
                      "inactive_checksum": ""
                    }
                  ]
                }
              },
              {
                "id": 32,
                "key": "collection",
                "position": 1000,
                "value_select": "Collection",
                "value_form": "Collection",
                "value_details": "Collection",
                "required": 0,
                "type_form": "checkbox",
                "type_select": "checkbox",
                "show_at_select": 0,
                "show_at_form": 0,
                "show_at_details": 0,
                "show_at_form_if_filtersetting": "NULL",
                "show_at_head": 0,
                "show_at_itemlist": 0,
                "show_at_itemlist_format": null,
                "template_select": "list",
                "template_form": "list",
                "template_detail": null,
                "individual_values": 0,
                "min_setting_count": 0,
                "max_setting_count": 0,
                "settings": {
                  "data": [
                    {
                      "id": 366,
                      "filter_id": 32,
                      "filter_key": "collection",
                      "value_key": "popular",
                      "value_select": "Beliebt",
                      "value_description": "NULL",
                      "value_form": "Beliebt",
                      "value_details": "Beliebt",
                      "position": 1000,
                      "is_individual_value": "0",
                      "active_icon": null,
                      "active_checksum": "",
                      "inactive_icon": null,
                      "inactive_checksum": ""
                    }
                  ]
                }
              },
              {
                "id": 1,
                "key": "transport",
                "position": 1000,
                "value_select": "Transport",
                "value_form": "Transport",
                "value_details": "Transport",
                "required": 1,
                "type_form": "checkbox",
                "type_select": "radio",
                "show_at_select": 1,
                "show_at_form": 1,
                "show_at_details": 1,
                "show_at_form_if_filtersetting": "NULL",
                "show_at_head": 1,
                "show_at_itemlist": 0,
                "show_at_itemlist_format": null,
                "template_select": "list",
                "template_form": "transport_inline",
                "template_detail": null,
                "individual_values": 0,
                "min_setting_count": 0,
                "max_setting_count": 0,
                "settings": {
                  "data": [
                    {
                      "id": 1,
                      "filter_id": 1,
                      "filter_key": "transport",
                      "value_key": "abholung",
                      "value_select": "Abholung",
                      "value_description": "NULL",
                      "value_form": "Abholung",
                      "value_details": "Abholung",
                      "position": 2,
                      "is_individual_value": "0",
                      "active_icon": null,
                      "active_checksum": "",
                      "inactive_icon": null,
                      "inactive_checksum": ""
                    }
                  ]
                }
              }
            ]
          },
          "extra_attributes" => {"code" => "1010"},
          "open_for_dynamic_pricing" => true,
        },
      ],
      "meta": {
        "pagination": {
          "total": 2,
          "count": 2,
          "per_page": 10,
          "current_page": 1,
          "total_pages": 1,
          "links": []
        }
      }
    }
Response  403
HideShow
Headers
Content-Type: application/json
Body
{}
Response  404
HideShow
Body
{
  "message": "404 Not Found",
  "status_code": 404
}

Retrieve Article Likers With Their Articles

Retrieve Article Likers With Their Articles
GET/v3/articles/{id}/likes

Get information about one Article’s likers and their own articles

Example URI

GET /v3/articles/5/likes
URI Parameters
HideShow
id
number (required) Example: 5

Id of the article.

Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
## UserTransformer (object)
+ data (array)
    + (object)
        + id: 1 (number)
        + merchant_id: 101 (number)
        + display_name: Max A. (string)
        + username: maxa3 (string)
        + has_picture: false (boolean)
        + picture (object)
            + data (object)
                + tiny: http://local3.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png (string)
                + small: http://local3.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png (string)
                + medium: http://local3.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png (string)
        + confirmed: true (boolean)
        + created_at: `2017-01-01T00:00:00+0000` (string)
        + gender: null (string)
        + last_login: null (string)
        + is_merchant: false (boolean)
        + has_facebook: false (boolean)
        + rating: 1 (number)
        + rating_count: 5 (number)
        + url: http://local3.gebraucht.de/@maxa3 (string)
        + country_of_residence_code: DE (string)
        + post_code: 10999 (string)
        + city: Berlin (string)
        + response_rate: 99 (number)
        + verified: false (boolean)
        + map_static_image: https://maps.googleapis.com/maps/staticmap?center=52.500377,13.360147&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:qvn_I{kppAP{[email protected]}[email protected]~B`[email protected][email protected]|[email protected]}[email protected] (string)
        + number_of_followers: 123 (number)
        + number_of_product_likes: 234 (number)
        + number_of_sales: 12 (number)
        + accepts_paypal: false (boolean)
        + can_be_rated: false (boolean)
        + ratings (object)
            + data (array)
        + email: [email protected] (string)
        + accepted_terms: `2017-01-01T00:00:00+0000` (string)
        + firstname: Max (string)
        + lastname: Abc (string)
        + birthday: `2017-01-01T00:00:00+0000` (string)
        + email_temp: [email protected] (string)
        + profile_is_complete: false (boolean)
        + profile_not_complete_errors (object)
            + country_of_residence_coe (array)
                + (object)
                    + code: required (string)
                    + message: Bitte country of residence code angeben. (string)
            + post_code (array)
                + (object)
                    + code: required (string)
                    + message: Bitte Postleitzahl angeben. (string)
        + has_set_password: true (boolean)
        + verification_status: 2 (number) - 0 = nothing uploaded, 1 = created, 2 = pending, 3 = verified, 4 = declined
        + pages (object)
            + data (array)
                - MerchantPageListTransformer
                - MerchantPageListTransformer
        + merchant (object)
            + data (MerchantTransformer)
Response  403
HideShow
Headers
Content-Type: application/json
Body
{}
Response  404
HideShow
Body
{
  "message": "404 Not Found",
  "status_code": 404
}

Retrieve Similar

Retrieve Similar
GET/v3/articles/{id}/similar?size={size}&from={from}

Get similar results base don an article id

Example URI

GET /v3/articles/5/similar?size=10&from=0
URI Parameters
HideShow
id
number (required) Example: 5

The Id of the article that should be used to get similar articles to

size
number (optional) Example: 10

Pagination: How many items you want to get (max 100), default=10

from
number (optional) Example: 0

Pagination: offset, default=0

Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 62,
      "type": "USER_FREE_CLASSIFIED",
      "title": "Thermo Regenkombi: Regenjacke und Regenhose gefüttert in 86/92",
      "body": "Ich biete diese tolle Regenkombi, bestehend aus Regenjacke und passender Regenhose von Tchibo / TCM in der Doppegröße 86/92 an. Jacke und Latzhose sind mit Fleece gefüttert, die Kapuze kann man enger stellen. Die Hose ist an den Knien und Unterschenkeln schon schmuddelig und weist zwei, drei Kratzer auf, die Verschlüsse sind ebenfalls zerkratzt. Für den Kindergarten als Matsch- oder Buddelhose ist die Kombination noch perfekt, sie ist wasserabweisend und erfüllt noch einwandfrei seinen Zweck. Wir sind ein Nichtraucherhaushalt. Einfach Termin vereinbaren und vorbeikommen. Auf Wunsch Versand gegen Übernahme der Portokosten.",
      "imprint": "",
      "returnpolicy": "",
      "price": "5",
      "delivery_costs": null,
      "delivery_cost_split": null,
      "buyer_delivery_cost": null,
      "seller_delivery_cost": null,
      "delivery_costs_eu": null,
      "delivery_time": null,
      "delivery_time_eu": null,
      "delivery_info": null,
      "currency": "EUR",
      "category_id": 55,
      "url": "http://local.gebraucht.de/familie_kind_baby/spielzeug/thermo-regenkombi-regenjacke-und-regenhose-gefuttert-in-8692-62",
      "created_at": "2017-01-01T00:00:00+0000",
      "to_sell": 1,
      "to_trade": 0,
      "to_give_away": 0,
      "is_premium": 0,
      "is_editable": true,
      "is_buyable": false,
      "itemlist_attributes": [],
      "count_views": "0",
      "count_likes": "0",
      "is_new": false,
      "status": "active",
      "renewable": false,
      "is_favorite": false,
      "location": {
        "data": {
          "latitude": 52.420980514058,
          "longitude": 13.305670843697,
          "street": "",
          "city": "Berlin",
          "post_code": "12207",
          "country_code": "DE"
        }
      },
      "user": {
        "data": {
          "id": 3,
          "display_name": "Oliver K.",
          "username": "oliver",
          "has_picture": true,
          "picture": {
            "data": {
              "tiny": "http://local.gebraucht.de/uploads/thumbs/2016/11-03/Af5tJYfd_50x50.jpg",
              "small": "http://local.gebraucht.de/uploads/thumbs/2016/11-03/Af5tJYfd_250x250.jpg",
              "medium": "http://local.gebraucht.de/uploads/thumbs/2016/11-03/Af5tJYfd_500x500.jpg"
            }
          },
          "confirmed": 1,
          "created_at": "2017-01-01T00:00:00+0000",
          "gender": "m",
          "last_login": "2017-01-01T00:00:00+0000",
          "is_merchant": false,
          "has_facebook": true,
          "rating": "0.00",
          "rating_count": 0,
          "url": "http://local.gebraucht.de/@oliver",
          "country_of_residence_code": null,
          "post_code": null,
          "city": null,
          "verified": true,
          "accepts_paypal": false,
          "can_be_rated": false
        }
      },
      "files": {
        "data": [
          {
            "id": 109,
            "tiny": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/sidLi4WW_60x45.jpg",
            "small": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/sidLi4WW_120x90.jpg",
            "medium": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/sidLi4WW_400x300.jpg",
            "big": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/sidLi4WW_700x525.jpg",
            "large": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/sidLi4WW_1000x750.jpg"
          },
          {
            "id": 110,
            "tiny": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/SMsi5GQC_60x45.jpg",
            "small": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/SMsi5GQC_120x90.jpg",
            "medium": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/SMsi5GQC_400x300.jpg",
            "big": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/SMsi5GQC_700x525.jpg",
            "large": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/SMsi5GQC_1000x750.jpg"
          }
        ]
      },
      "filtersettings": {
        "data": [
          {
            "id": 30,
            "key": "paymentmethod",
            "position": 600,
            "value_select": "Zahlungsmethode",
            "value_form": "Zahlungsmethode",
            "value_details": "Zahlungsmethode",
            "type_form": "radio",
            "type_select": "radio",
            "show_at_select": 1,
            "show_at_form": 0,
            "show_at_details": 0,
            "show_at_form_if_filtersetting": "NULL",
            "show_at_head": 0,
            "show_at_itemlist": 0,
            "show_at_itemlist_format": null,
            "template_select": "list",
            "template_form": null,
            "template_detail": null,
            "individual_values": 0,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": [
                {
                  "id": 354,
                  "filter_id": 30,
                  "filter_key": "paymentmethod",
                  "value_key": "paypal",
                  "value_select": "Paypal",
                  "value_description": "NULL",
                  "value_form": "Paypal",
                  "value_details": "Paypal",
                  "position": 0,
                  "is_individual_value": "0"
                }
              ]
            }
          },
          {
            "id": 3,
            "key": "zustand",
            "position": 700,
            "value_select": "Zustand",
            "value_form": "Zustand",
            "value_details": "Zustand",
            "type_form": "select",
            "type_select": "checkbox",
            "show_at_select": 1,
            "show_at_form": 1,
            "show_at_details": 1,
            "show_at_form_if_filtersetting": "NULL",
            "show_at_head": 1,
            "show_at_itemlist": 0,
            "show_at_itemlist_format": null,
            "template_select": "list",
            "template_form": "single_list",
            "template_detail": null,
            "individual_values": 0,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": [
                {
                  "id": 8,
                  "filter_id": 3,
                  "filter_key": "zustand",
                  "value_key": "acceptable",
                  "value_select": "Akzeptabel",
                  "value_description": "Der Artikel hat starke Gebrauchsspuren oder sogar Schäden, wie Brüche oder mehrere tiefe Kratzer oder starke Verschmutzung.",
                  "value_form": "Akzeptabel",
                  "value_details": "Akzeptabel",
                  "position": 4,
                  "is_individual_value": "0"
                }
              ]
            }
          },
          {
            "id": 32,
            "key": "collection",
            "position": 1000,
            "value_select": "Collection",
            "value_form": "Collection",
            "value_details": "Collection",
            "type_form": "checkbox",
            "type_select": "checkbox",
            "show_at_select": 0,
            "show_at_form": 0,
            "show_at_details": 0,
            "show_at_form_if_filtersetting": "NULL",
            "show_at_head": 0,
            "show_at_itemlist": 0,
            "show_at_itemlist_format": null,
            "template_select": "list",
            "template_form": null,
            "template_detail": null,
            "individual_values": 0,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": [
                {
                  "id": 366,
                  "filter_id": 32,
                  "filter_key": "collection",
                  "value_key": "popular",
                  "value_select": "Beliebt",
                  "value_description": "NULL",
                  "value_form": "Beliebt",
                  "value_details": "Beliebt",
                  "position": 1000,
                  "is_individual_value": "0"
                },
                {
                  "id": 365,
                  "filter_id": 32,
                  "filter_key": "collection",
                  "value_key": "selected_by_us",
                  "value_select": "Von uns ausgewählt",
                  "value_description": "NULL",
                  "value_form": "Von uns ausgewählt",
                  "value_details": "Von uns ausgewählt",
                  "position": 1000,
                  "is_individual_value": "0"
                }
              ]
            }
          },
          {
            "id": 1,
            "key": "transport",
            "position": 1000,
            "value_select": "Transport",
            "value_form": "Transport",
            "value_details": "Transport",
            "type_form": "checkbox",
            "type_select": "radio",
            "show_at_select": 1,
            "show_at_form": 1,
            "show_at_details": 1,
            "show_at_form_if_filtersetting": "NULL",
            "show_at_head": 1,
            "show_at_itemlist": 0,
            "show_at_itemlist_format": null,
            "template_select": "list",
            "template_form": "transport_inline",
            "template_detail": null,
            "individual_values": 0,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": [
                {
                  "id": 2,
                  "filter_id": 1,
                  "filter_key": "transport",
                  "value_key": "versand",
                  "value_select": "Versand",
                  "value_description": "NULL",
                  "value_form": "Versand",
                  "value_details": "Versand",
                  "position": 1,
                  "is_individual_value": "0"
                }
              ]
            }
          }
        ]
      }
    },
    {
      "id": 35,
      "type": "USER_FREE_CLASSIFIED",
      "title": "Scleich - 42014 -Unterstall -Tränke und Krippe -für Pferde/ Tiere",
      "body": "Futterstelle von Schleich - 42014 - wie neu, Unterstall - Tränke und Futterkrippe Neupreis 15,99 TOP Zustand",
      "imprint": "",
      "returnpolicy": "",
      "price": "9",
      "delivery_cost_split": null,
      "delivery_costs": null,
      "buyer_delivery_cost": null,
      "seller_delivery_cost": null,
      "delivery_costs_eu": null,
      "delivery_time": null,
      "delivery_time_eu": null,
      "delivery_info": null,
      "currency": "EUR",
      "category_id": 54,
      "url": "http://local.gebraucht.de/familie_kind_baby/kinderzimmer/scleich-42014-unterstall-tranke-und-krippe-fur-pferde-tiere-35",
      "created_at": "2017-01-01T00:00:00+0000",
      "to_sell": 1,
      "to_trade": 0,
      "to_give_away": 0,
      "is_premium": 0,
      "is_editable": true,
      "is_buyable": false,
      "itemlist_attributes": [],
      "count_views": 0,
      "count_likes": 0,
      "is_new": false,
      "status": "active",
      "renewable": false,
      "is_favorite": false,
      "location": {
        "data": {
          "latitude": 53.614674990272,
          "longitude": 10.117449497467,
          "street": "",
          "city": "Hamburg",
          "post_code": "22159",
          "country_code": "DE"
        }
      },
      "user": {
        "data": {
          "id": 1,
          "display_name": "Admin M.",
          "username": "admin",
          "has_picture": true,
          "picture": {
            "data": {
              "tiny": "http://local.gebraucht.de/uploads/thumbs/2016/11-07/PNbLpbxC_50x37.png",
              "small": "http://local.gebraucht.de/uploads/thumbs/2016/11-07/PNbLpbxC_250x187.png",
              "medium": "http://local.gebraucht.de/uploads/thumbs/2016/11-07/PNbLpbxC_500x373.png"
            }
          },
          "confirmed": 1,
          "created_at": "2017-01-01T00:00:00+0000",
          "gender": "m",
          "last_login": "2017-01-01T00:00:00+0000",
          "is_merchant": false,
          "has_facebook": false,
          "rating": "0.00",
          "rating_count": 0,
          "url": "http://local.gebraucht.de/@admin",
          "country_of_residence_code": null,
          "post_code": null,
          "city": null,
          "verified": true,
          "accepts_paypal": false,
          "can_be_rated": false
        }
      },
      "files": {
        "data": [
          {
            "id": 60,
            "tiny": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/KV3TlMrI_60x40.jpg",
            "small": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/KV3TlMrI_120x80.jpg",
            "medium": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/KV3TlMrI_400x266.jpg",
            "big": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/KV3TlMrI_700x465.jpg",
            "large": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/KV3TlMrI_1000x664.jpg"
          },
          {
            "id": 61,
            "tiny": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/c2QldBfT_60x40.jpg",
            "small": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/c2QldBfT_120x80.jpg",
            "medium": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/c2QldBfT_400x266.jpg",
            "big": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/c2QldBfT_700x465.jpg",
            "large": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/c2QldBfT_1000x1000_grab.jpg"
          }
        ]
      },
      "filtersettings": {
        "data": [
          {
            "id": 30,
            "key": "paymentmethod",
            "position": 600,
            "value_select": "Zahlungsmethode",
            "value_form": "Zahlungsmethode",
            "value_details": "Zahlungsmethode",
            "type_form": "radio",
            "type_select": "radio",
            "show_at_select": 1,
            "show_at_form": 0,
            "show_at_details": 0,
            "show_at_form_if_filtersetting": "NULL",
            "show_at_head": 0,
            "show_at_itemlist": 0,
            "show_at_itemlist_format": null,
            "template_select": "list",
            "template_form": null,
            "template_detail": null,
            "individual_values": 0,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": [
                {
                  "id": 354,
                  "filter_id": 30,
                  "filter_key": "paymentmethod",
                  "value_key": "paypal",
                  "value_select": "Paypal",
                  "value_description": "NULL",
                  "value_form": "Paypal",
                  "value_details": "Paypal",
                  "position": 0,
                  "is_individual_value": "0"
                }
              ]
            }
          },
          {
            "id": 3,
            "key": "zustand",
            "position": 700,
            "value_select": "Zustand",
            "value_form": "Zustand",
            "value_details": "Zustand",
            "type_form": "select",
            "type_select": "checkbox",
            "show_at_select": 1,
            "show_at_form": 1,
            "show_at_details": 1,
            "show_at_form_if_filtersetting": "NULL",
            "show_at_head": 1,
            "show_at_itemlist": 0,
            "show_at_itemlist_format": null,
            "template_select": "list",
            "template_form": "single_list",
            "template_detail": null,
            "individual_values": 0,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": [
                {
                  "id": 8,
                  "filter_id": 3,
                  "filter_key": "zustand",
                  "value_key": "acceptable",
                  "value_select": "Akzeptabel",
                  "value_description": "Der Artikel hat starke Gebrauchsspuren oder sogar Schäden, wie Brüche oder mehrere tiefe Kratzer oder starke Verschmutzung.",
                  "value_form": "Akzeptabel",
                  "value_details": "Akzeptabel",
                  "position": 4,
                  "is_individual_value": "0"
                }
              ]
            }
          },
          {
            "id": 32,
            "key": "collection",
            "position": 1000,
            "value_select": "Collection",
            "value_form": "Collection",
            "value_details": "Collection",
            "type_form": "checkbox",
            "type_select": "checkbox",
            "show_at_select": 0,
            "show_at_form": 0,
            "show_at_details": 0,
            "show_at_form_if_filtersetting": "NULL",
            "show_at_head": 0,
            "show_at_itemlist": 0,
            "show_at_itemlist_format": null,
            "template_select": "list",
            "template_form": null,
            "template_detail": null,
            "individual_values": 0,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": [
                {
                  "id": 365,
                  "filter_id": 32,
                  "filter_key": "collection",
                  "value_key": "selected_by_us",
                  "value_select": "Von uns ausgewählt",
                  "value_description": "NULL",
                  "value_form": "Von uns ausgewählt",
                  "value_details": "Von uns ausgewählt",
                  "position": 1000,
                  "is_individual_value": "0"
                }
              ]
            }
          },
          {
            "id": 1,
            "key": "transport",
            "position": 1000,
            "value_select": "Transport",
            "value_form": "Transport",
            "value_details": "Transport",
            "type_form": "checkbox",
            "type_select": "radio",
            "show_at_select": 1,
            "show_at_form": 1,
            "show_at_details": 1,
            "show_at_form_if_filtersetting": "NULL",
            "show_at_head": 1,
            "show_at_itemlist": 0,
            "show_at_itemlist_format": null,
            "template_select": "list",
            "template_form": "transport_inline",
            "template_detail": null,
            "individual_values": 0,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": [
                {
                  "id": 2,
                  "filter_id": 1,
                  "filter_key": "transport",
                  "value_key": "versand",
                  "value_select": "Versand",
                  "value_description": "NULL",
                  "value_form": "Versand",
                  "value_details": "Versand",
                  "position": 1,
                  "is_individual_value": "0"
                }
              ]
            }
          }
        ]
      }
    },
    {
      "id": 12,
      "type": "USER_FREE_CLASSIFIED",
      "title": "Jack Wolfskin Pulloverjacke Gr.140",
      "body": "Hallo hier habe ich eine gern getragene Pulloverjacke von Jack Wolfskin sie war leider mit meinem Kind im Stroh und das hat es mir leider nicht vor dem waschen gesagt es kann sein das sich da noch Stroh an der Jacke anfindet was ich nicht gefunden habe ist dann eher was zum rumtoben und draußen spielen.Der Neupreis lag bei 59,95€ Versand muß ich gucken ob es noch als Päckchen durchgeht",
      "imprint": "",
      "returnpolicy": "",
      "price": "10",
      "delivery_cost_split": null,
      "seller_delivery_cost": null,
      "buyer_delivery_cost": null,
      "delivery_costs_eu": null,
      "delivery_time": null,
      "delivery_time_eu": null,
      "delivery_info": null,
      "currency": "EUR",
      "category_id": 52,
      "url": "http://local.gebraucht.de/familie_kind_baby/babyausstattung/jack-wolfskin-pulloverjacke-gr140-12",
      "created_at": "2017-01-01T00:00:00+0000",
      "to_sell": 1,
      "to_trade": 0,
      "to_give_away": 0,
      "is_premium": 0,
      "is_editable": true,
      "is_buyable": false,
      "itemlist_attributes": [],
      "count_views": "0",
      "count_likes": "0",
      "is_new": false,
      "status": "active",
      "renewable": false,
      "is_favorite": false,
      "location": {
        "data": {
          "latitude": 54.169534226917,
          "longitude": 9.6633915816524,
          "street": "",
          "city": "Stafstedt",
          "post_code": "",
          "country_code": "DE"
        }
      },
      "user": {
        "data": {
          "id": 3,
          "display_name": "Oliver K.",
          "username": "oliver",
          "has_picture": true,
          "picture": {
            "data": {
              "tiny": "http://local.gebraucht.de/uploads/thumbs/2016/11-03/Af5tJYfd_50x50.jpg",
              "small": "http://local.gebraucht.de/uploads/thumbs/2016/11-03/Af5tJYfd_250x250.jpg",
              "medium": "http://local.gebraucht.de/uploads/thumbs/2016/11-03/Af5tJYfd_500x500.jpg"
            }
          },
          "confirmed": 1,
          "created_at": "2017-01-01T00:00:00+0000",
          "gender": "m",
          "last_login": "2017-01-01T00:00:00+0000",
          "is_merchant": false,
          "has_facebook": true,
          "rating": "0.00",
          "rating_count": 0,
          "url": "http://local.gebraucht.de/@oliver",
          "country_of_residence_code": null,
          "post_code": null,
          "city": null,
          "verified": true,
          "accepts_paypal": false,
          "can_be_rated": false
        }
      },
      "files": {
        "data": [
          {
            "id": 18,
            "tiny": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/4IUl9NUH_45x60.jpg",
            "small": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/4IUl9NUH_90x120.jpg",
            "medium": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/4IUl9NUH_300x400.jpg",
            "big": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/4IUl9NUH_525x700.jpg",
            "large": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/4IUl9NUH_749x1000.jpg"
          },
          {
            "id": 19,
            "tiny": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/lJ04sStx_45x60.jpg",
            "small": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/lJ04sStx_90x120.jpg",
            "medium": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/lJ04sStx_300x400.jpg",
            "big": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/lJ04sStx_525x700.jpg",
            "large": "http://local.gebraucht.de/uploads/thumbs/2016/10-13/lJ04sStx_749x1000.jpg"
          }
        ]
      },
      "filtersettings": {
        "data": [
          {
            "id": 30,
            "key": "paymentmethod",
            "position": 600,
            "value_select": "Zahlungsmethode",
            "value_form": "Zahlungsmethode",
            "value_details": "Zahlungsmethode",
            "type_form": "radio",
            "type_select": "radio",
            "show_at_select": 1,
            "show_at_form": 0,
            "show_at_details": 0,
            "show_at_form_if_filtersetting": "NULL",
            "show_at_head": 0,
            "show_at_itemlist": 0,
            "show_at_itemlist_format": null,
            "template_select": "list",
            "template_form": null,
            "template_detail": null,
            "individual_values": 0,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": [
                {
                  "id": 354,
                  "filter_id": 30,
                  "filter_key": "paymentmethod",
                  "value_key": "paypal",
                  "value_select": "Paypal",
                  "value_description": "NULL",
                  "value_form": "Paypal",
                  "value_details": "Paypal",
                  "position": 0,
                  "is_individual_value": "0"
                }
              ]
            }
          },
          {
            "id": 3,
            "key": "zustand",
            "position": 700,
            "value_select": "Zustand",
            "value_form": "Zustand",
            "value_details": "Zustand",
            "type_form": "select",
            "type_select": "checkbox",
            "show_at_select": 1,
            "show_at_form": 1,
            "show_at_details": 1,
            "show_at_form_if_filtersetting": "NULL",
            "show_at_head": 1,
            "show_at_itemlist": 0,
            "show_at_itemlist_format": null,
            "template_select": "list",
            "template_form": "single_list",
            "template_detail": null,
            "individual_values": 0,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": [
                {
                  "id": 11,
                  "filter_id": 3,
                  "filter_key": "zustand",
                  "value_key": "very-good",
                  "value_select": "Sehr gut",
                  "value_description": "Der Artikel hat nur wenige leichte Gebrauchsspuren und ist in einem sehr gepflegten Zustand.",
                  "value_form": "Sehr gut",
                  "value_details": "Sehr gut",
                  "position": 2,
                  "is_individual_value": "0"
                }
              ]
            }
          },
          {
            "id": 32,
            "key": "collection",
            "position": 1000,
            "value_select": "Collection",
            "value_form": "Collection",
            "value_details": "Collection",
            "type_form": "checkbox",
            "type_select": "checkbox",
            "show_at_select": 0,
            "show_at_form": 0,
            "show_at_details": 0,
            "show_at_form_if_filtersetting": "NULL",
            "show_at_head": 0,
            "show_at_itemlist": 0,
            "show_at_itemlist_format": null,
            "template_select": "list",
            "template_form": null,
            "template_detail": null,
            "individual_values": 0,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": [
                {
                  "id": 366,
                  "filter_id": 32,
                  "filter_key": "collection",
                  "value_key": "popular",
                  "value_select": "Beliebt",
                  "value_description": "NULL",
                  "value_form": "Beliebt",
                  "value_details": "Beliebt",
                  "position": 1000,
                  "is_individual_value": "0"
                }
              ]
            }
          },
          {
            "id": 1,
            "key": "transport",
            "position": 1000,
            "value_select": "Transport",
            "value_form": "Transport",
            "value_details": "Transport",
            "type_form": "checkbox",
            "type_select": "radio",
            "show_at_select": 1,
            "show_at_form": 1,
            "show_at_details": 1,
            "show_at_form_if_filtersetting": "NULL",
            "show_at_head": 1,
            "show_at_itemlist": 0,
            "show_at_itemlist_format": null,
            "template_select": "list",
            "template_form": "transport_inline",
            "template_detail": null,
            "individual_values": 0,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": [
                {
                  "id": 2,
                  "filter_id": 1,
                  "filter_key": "transport",
                  "value_key": "versand",
                  "value_select": "Versand",
                  "value_description": "NULL",
                  "value_form": "Versand",
                  "value_details": "Versand",
                  "position": 1,
                  "is_individual_value": "0"
                }
              ]
            }
          }
        ]
      }
    }
  ],
  "meta": {
    "cursor": {
      "current": 0,
      "total": 67,
      "count": 3,
      "next": 3
    }
  }
}

Delete

Delete
DELETE/v3/articles/{id}

Deletes an item

Example URI

DELETE /v3/articles/5
URI Parameters
HideShow
id
number (required) Example: 5

The id of the article to delete

Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "403 Not Found",
  "status_code": 404
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "404 Not Found",
  "status_code": 404
}

Toggle Favorite

Toggle Favorite
POST/v3/articles/{id}/togglefavorite

Adds or removes an item to the user favorites.

Example URI

POST /v3/articles/5/togglefavorite
URI Parameters
HideShow
id
number (required) Example: 5

The id of the article

Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "added"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "deleted"
}

Partial update

Partial update
PATCH/v3/articles/

Partial update of an existing article by id (int/string) or external_id(int/string)

Fields forbidden for change: id, user_id, category_id

Example URI

PATCH /v3/articles/
Request
HideShow
Headers
Authorization: Bearer <access_token>
Body
{
  "title": "object xyz",
  "body": "this is a long description",
  "price": "10|10,51 EUR|10.51 EUR",
  "stock": 5,
  "delivery_cost_split": "50/50",
  "total_delivery_cost": "10|10,51 EUR|10.51 EUR",
  "delivery_time": "1 to 3 working days",
  "delivery_costs_eu": "10|10,51|10.51",
  "delivery_time_eu": "3 to 5 working days",
  "to_trade": "0|1",
  "to_give_away": "0|1"
}
Schema
{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "Title of the item to sell."
    },
    "body": {
      "type": "string",
      "description": "Description for the article with a max length of 4000 characters."
    },
    "price": {
      "type": "string",
      "description": "Price to sell the item. Comma will be handled as decimal seperator."
    },
    "stock": {
      "type": "number"
    },
    "delivery_cost_split": {
      "type": "string",
      "description": "How to split delivery cost. Options are 50/50, 0/100, 100/0."
    },
    "total_delivery_cost": {
      "type": "string",
      "description": "Total delivery costs within the country. Can be required if the transport attribute is contains zu delivery as an option."
    },
    "delivery_time": {
      "type": "string",
      "description": "Short description of the estimated delivery time for country wide delivery. Max length of 30 Characters."
    },
    "delivery_costs_eu": {
      "type": "string",
      "description": "Delivery costs to send it to an other european country."
    },
    "delivery_time_eu": {
      "type": "string",
      "description": "Short description of the estimated delivery time for eu wide delivery. Max length of 30 Characters."
    },
    "to_trade": {
      "type": "string",
      "description": "If true the item is marked as tradable item so the user is open to trade it for another item."
    },
    "to_give_away": {
      "type": "string",
      "description": "If true the item is marked to give away for free."
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "422 Unprocessable Entity",
  "errors": {
    "title": [
      {
        "code": "error_code",
        "message": "validation_message"
      }
    ]
  },
  "status_code": 422
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
              "data": {
                "id": 1925,
                "external_id": 1111,
                "type": "USER_FREE_CLASSIFIED",
                "title": "My awesome product",
                "body": "This is an example description!",
                "imprint": "",
                "returnpolicy": "",
                "price": "30",
                "stock": "5",
                "previous_price": 25,
                "buyer_delivery_cost": "5.00",
                "seller_delivery_cost": "5.00",
                "delivery_costs_eu": "5.00",
                "delivery_time": "1 to 3 days",
                "delivery_time_eu": "3 to 7 days",
                "delivery_info": null,
                "currency": "EUR",
                "category_id": 15,
                "url": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/auto_rad_boot/boote_zubehoer/my-awesome-product-1925",
                "created_at": "2017-01-01T00:00:00+0000",
                "to_sell": 1,
                "to_trade": 1,
                "to_give_away": 1,
                "is_premium": 0,
                "is_editable": true,
                "is_buyable": false,
                "has_pending_order": false,
                "itemlist_attributes": [],
                "count_views": 1,
                "count_likes": 0,
                "status": "active",
                "renewable": false,
                "is_favorite": false,
                "open_for_offers": false,
                "buyer_delivery": false,
                "transaction_type": managed,

               "comment_count": 9,
               "carrierPlan": {
                  "data": {
                    "id": 1,
                    "title": "DHL Paket XS",
                    "price": 439,
                    "old_price": 439,
                    "pickup_service": "self_sending",
                    "sellers_phone_required": false,
                    "buyer_phone_required": false,
                    "icon": {
                      "data": {
                        "tiny": "http://abc:[email protected]/uploads/thumbs/2016/10-13/HI1YCnwQ_50x28.jpg",
                        "small": "http://abc:[email protected]/uploads/thumbs/2016/10-13/HI1YCnwQ_250x140.jpg",
                        "medium": "http://abc:[email protected]/uploads/thumbs/2016/10-13/HI1YCnwQ_500x281.jpg"
                      }
                    },
                    "description": null,
                    "info_link": null
                  }
               },
               "comments": {
                 "data": [
                   {
                     "id": 50,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 2,
                     "comment": "a lovely comment",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": []
                     },
                     "user": {
                       "data": {
                         "id": 2,
                         "display_name": "kaiserlos",
                         "username": "kaiserlos",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": null,
                         "confirmed": 1,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": null,
                         "last_login": null,
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@kaiserlos",
                         "country_of_residence_code": null,
                         "post_code": null,
                         "city": null,
                         "verified": false,
                         "response_rate": "0.00",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                         "articles_count": 369,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   },
                   {
                     "id": 51,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 5,
                     "comment": "new comment",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": [
                         {
                           "id": 52,
                           "article_id": 1908,
                           "comment_reply_id": 51,
                           "user_id": 3,
                           "comment": "reply to commment",
                           "created_at": "2017-01-01T00:00:00+0000",
                           "edited_at": null,
                           "updated_at": "2017-01-01T00:00:00+0000",
                           "is_editable": true,
                           "replies": {
                             "data": []
                           },
                           "user": {
                             "data": {
                               "id": 3,
                               "display_name": "oliver",
                               "username": "oliver",
                               "has_picture": false,
                               "picture": {
                                 "data": {
                                   "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                                   "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                                   "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                                 }
                               },
                               "bio": null,
                               "confirmed": 1,
                               "created_at": "2017-01-01T00:00:00+0000",
                               "gender": null,
                               "last_login": null,
                               "is_merchant": false,
                               "has_facebook": false,
                               "rating": "0.00",
                               "rating_count": 0,
                               "url": "http://local.gebraucht.de/@oliver",
                               "country_of_residence_code": null,
                               "post_code": null,
                               "city": null,
                               "verified": false,
                               "response_rate": "0.00",
                               "number_of_followers": 123,
                               "number_of_product_likes": 234,
                               "number_of_sales": 12,
                               "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                               "articles_count": 405,
                               "accepts_paypal": false,
                               "can_be_rated": false
                             }
                           }
                         },
                         {
                           "id": 53,
                           "article_id": 1908,
                           "comment_reply_id": 51,
                           "user_id": 1,
                           "comment": "reply to commment 2",
                           "created_at": "2017-01-01T00:00:00+0000",
                           "edited_at": null,
                           "updated_at": "2017-01-01T00:00:00+0000",
                           "is_editable": true,
                           "replies": {
                             "data": [
                               {
                                 "id": 54,
                                 "article_id": 1908,
                                 "comment_reply_id": 53,
                                 "user_id": 2,
                                 "comment": "reply to commment 3 ",
                                 "created_at": "2017-01-01T00:00:00+0000",
                                 "edited_at": null,
                                 "updated_at": "2017-01-01T00:00:00+0000",
                                 "is_editable": true,
                                 "replies": {
                                   "data": []
                                 },
                                 "user": {
                                   "data": {
                                     "id": 2,
                                     "display_name": "kaiserlos",
                                     "username": "kaiserlos",
                                     "has_picture": false,
                                     "picture": {
                                       "data": {
                                         "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                                         "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                                         "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                                       }
                                     },
                                     "bio": null,
                                     "confirmed": 1,
                                     "created_at": "2017-01-01T00:00:00+0000",
                                     "gender": null,
                                     "last_login": null,
                                     "is_merchant": false,
                                     "has_facebook": false,
                                     "rating": "0.00",
                                     "rating_count": 0,
                                     "url": "http://local.gebraucht.de/@kaiserlos",
                                     "country_of_residence_code": null,
                                     "post_code": null,
                                     "city": null,
                                     "verified": false,
                                     "response_rate": "0.00",
                                     "number_of_followers": 123,
                                     "number_of_product_likes": 234,
                                     "number_of_sales": 12,
                                     "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                                     "articles_count": 369,
                                     "accepts_paypal": false,
                                     "can_be_rated": false
                                   }
                                 }
                               }
                             ]
                           },
                           "user": {
                             "data": {
                               "id": 1,
                               "display_name": "A A.",
                               "username": "admin",
                               "has_picture": false,
                               "picture": {
                                 "data": {
                                   "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                                   "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                                   "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                                 }
                               },
                               "bio": "This is my bio line",
                               "confirmed": 0,
                               "created_at": "2017-01-01T00:00:00+0000",
                               "gender": "m",
                               "last_login": "2017-01-01T00:00:00+0000",
                               "is_merchant": false,
                               "has_facebook": false,
                               "rating": "0.00",
                               "rating_count": 0,
                               "url": "http://local.gebraucht.de/@admin",
                               "country_of_residence_code": "DE",
                               "post_code": "11111",
                               "city": null,
                               "verified": true,
                               "response_rate": "23.53",
                               "number_of_followers": 123,
                               "number_of_product_likes": 234,
                               "number_of_sales": 12,
                               "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=42.7156271,-83.7411562&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:{[email protected][email protected]@nFfB~EtCpE~DxDbF~CdGdC`[email protected][email protected]~G_DdGyDdFqE|[email protected]{[email protected][email protected]",
                               "articles_count": 403,
                               "accepts_paypal": false,
                               "can_be_rated": false
                             }
                           }
                         }
                       ]
                     },
                     "user": {
                       "data": {
                         "id": 5,
                         "display_name": "Justin K.",
                         "username": "justin",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": "I am looking to sell my excess stuff to de-clutter my life",
                         "confirmed": 1,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": "m",
                         "last_login": "2017-01-01T00:00:00+0000",
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@justin",
                         "country_of_residence_code": null,
                         "post_code": null,
                         "city": null,
                         "verified": true,
                         "response_rate": "0.00",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                         "articles_count": 368,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   },
                   {
                     "id": 55,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 1,
                     "comment": "next question",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": []
                     },
                     "user": {
                       "data": {
                         "id": 1,
                         "display_name": "A A.",
                         "username": "admin",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": "This is my bio line",
                         "confirmed": 0,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": "m",
                         "last_login": "2017-01-01T00:00:00+0000",
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@admin",
                         "country_of_residence_code": "DE",
                         "post_code": "11111",
                         "city": null,
                         "verified": true,
                         "response_rate": "23.53",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=42.7156271,-83.7411562&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:{[email protected][email protected]@nFfB~EtCpE~DxDbF~CdGdC`[email protected][email protected]~G_DdGyDdFqE|[email protected]{[email protected][email protected]",
                         "articles_count": 403,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   },
                   {
                     "id": 56,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 1,
                     "comment": "next reply!",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": []
                     },
                     "user": {
                       "data": {
                         "id": 1,
                         "display_name": "A A.",
                         "username": "admin",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": "This is my bio line",
                         "confirmed": 0,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": "m",
                         "last_login": "2017-01-01T00:00:00+0000",
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@admin",
                         "country_of_residence_code": "DE",
                         "post_code": "11111",
                         "city": null,
                         "verified": true,
                         "response_rate": "23.53",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=42.7156271,-83.7411562&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:{[email protected][email protected]@nFfB~EtCpE~DxDbF~CdGdC`[email protected][email protected]~G_DdGyDdFqE|[email protected]{[email protected][email protected]",
                         "articles_count": 403,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   },
                   {
                     "id": 63,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 5,
                     "comment": "a lovely comment",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": [
                         {
                           "id": 64,
                           "article_id": 1908,
                           "comment_reply_id": 63,
                           "user_id": 1,
                           "comment": "reply 12345",
                           "created_at": "2017-01-01T00:00:00+0000",
                           "edited_at": null,
                           "updated_at": "2017-01-01T00:00:00+0000",
                           "is_editable": true,
                           "replies": {
                             "data": []
                           },
                           "user": {
                             "data": {
                               "id": 1,
                               "display_name": "A A.",
                               "username": "admin",
                               "has_picture": false,
                               "picture": {
                                 "data": {
                                   "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                                   "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                                   "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                                 }
                               },
                               "bio": "This is my bio line",
                               "confirmed": 0,
                               "created_at": "2017-01-01T00:00:00+0000",
                               "gender": "m",
                               "last_login": "2017-01-01T00:00:00+0000",
                               "is_merchant": false,
                               "has_facebook": false,
                               "rating": "0.00",
                               "rating_count": 0,
                               "url": "http://local.gebraucht.de/@admin",
                               "country_of_residence_code": "DE",
                               "post_code": "11111",
                               "city": null,
                               "verified": true,
                               "response_rate": "23.53",
                               "number_of_followers": 123,
                               "number_of_product_likes": 234,
                               "number_of_sales": 12,
                               "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=42.7156271,-83.7411562&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:{[email protected][email protected]@nFfB~EtCpE~DxDbF~CdGdC`[email protected][email protected]~G_DdGyDdFqE|[email protected]{[email protected][email protected]",
                               "articles_count": 403,
                               "accepts_paypal": false,
                               "can_be_rated": false
                             }
                           }
                         }
                       ]
                     },
                     "user": {
                       "data": {
                         "id": 5,
                         "display_name": "Justin K.",
                         "username": "justin",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": "I am looking to sell my excess stuff to de-clutter my life",
                         "confirmed": 1,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": "m",
                         "last_login": "2017-01-01T00:00:00+0000",
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@justin",
                         "country_of_residence_code": null,
                         "post_code": null,
                         "city": null,
                         "verified": true,
                         "response_rate": "0.00",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                         "articles_count": 368,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   }
                 ]
               },

                "location": {
                  "data": {
                    "latitude": 10.000120018427,
                    "longitude": 9.9988404659265,
                    "street": "",
                    "city": "Berlin",
                    "post_code": "12345",
                    "country_code": "DE"
                  }
                },
                "user": {
                  "data": {
                    "id": 1,
                    "display_name": "dfsdf a.",
                    "username": "admin",
                    "picture": {
                      "data": {
                        "tiny": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                        "small": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                        "medium": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                      }
                    },
                    "confirmed": 1,
                    "created_at": "2017-01-01T00:00:00+0000",
                    "gender": "m",
                    "last_login": "2017-01-01T00:00:00+0000",
                    "is_merchant": false,
                    "has_facebook": false,
                    "rating": "0.00",
                    "rating_count": 0,
                    "url": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/@admin",
                    "response_rate": 99,
                    "articles_count": 5,
                    "verified": false,
                    "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.500377,13.360147&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:qvn_I{kppAP{[email protected]}[email protected][email protected][email protected]|[email protected]}[email protected]",
                    "number_of_followers": 123,
                    "number_of_product_likes": 234,
                    "number_of_sales": 12,
                    "accepts_paypal": false,
                    "can_be_rated": false
                  }
                },
                "files": {
                  "data": [
                    {
                      "id": 3359,
                      "tiny": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_36x60.jpeg",
                      "small": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_73x120.jpeg",
                      "medium": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_242x400.jpeg",
                      "big": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_424x700.jpeg",
                      "large": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_606x1000.jpeg"
                    }
                  ]
                },
                "filtersettings": {
                  "data": [
                    {
                      "id": 1,
                      "key": "transport",
                      "position": 1000,
                      "value_select": "Transport",
                      "value_form": "Transport",
                      "value_details": "Transport",
                      "type_form": "checkbox",
                      "type_select": "radio",
                      "show_at_select": 1,
                      "show_at_form": 1,
                      "show_at_details": 1,
                      "show_at_form_if_filtersetting": "NULL",
                      "show_at_head": 1,
                      "show_at_itemlist": 0,
                      "show_at_itemlist_format": "",
                      "template_select": "list",
                      "template_form": "list",
                      "template_detail": "",
                      "individual_values": 0,
                      "min_setting_count": 0,
                      "max_setting_count": 0,
                      "settings": {
                        "data": [
                          {
                            "id": 2,
                            "filter_id": 1,
                            "filter_key": null,
                            "value_key": "versand",
                            "value_select": "Versand",
                            "value_description": null,
                            "value_form": "Versand",
                            "value_details": "Versand",
                            "position": 1,
                            "is_individual_value": "0"
                          }
                        ]
                      }
                    },
                    {
                      "id": 3,
                      "key": "zustand",
                      "position": 1000,
                      "value_select": "Zustand",
                      "value_form": "Zustand",
                      "value_details": "Zustand",
                      "type_form": "select",
                      "type_select": "checkbox",
                      "show_at_select": 1,
                      "show_at_form": 1,
                      "show_at_details": 1,
                      "show_at_form_if_filtersetting": "NULL",
                      "show_at_head": 1,
                      "show_at_itemlist": 0,
                      "show_at_itemlist_format": "",
                      "template_select": "list"
                      "template_form": "list",
                      "template_detail": "",
                      "individual_values": 0,
                      "min_setting_count": 0,
                      "max_setting_count": 0,
                      "settings": {
                        "data": [
                          {
                            "id": 364,
                            "filter_id": 3,
                            "filter_key": null,
                            "value_key": "good",
                            "value_select": "Gut",
                            "value_description": "Der Artikel hat einige offensichtliche Gebrauchsspuren, z.B. deutliche Kratzer oder kleine Beschädigungen.",
                            "value_form": "Gut",
                            "value_details": "Gut",
                            "position": 3,
                            "is_individual_value": "0"
                          }
                        ]
                      }
                    }
                  ]
                },
                "extra_attributes" => {"code" => "1010"},

              }
            },

Update

Update
PUT/article

Update an existing article

The fields: ‘category_id’,‘title’,‘body’,‘price’,‘delivery_cost_split’,‘total_delivery_cost’,‘delivery_costs_eu’,‘delivery_info’,‘delivery_time’,‘delivery_time_eu’,‘to_sell’,‘to_trade’,‘to_give_away’, ‘location’ are not required and only updated if they are set in the request. => The data from the PUT request must be sent as x-www-form-urlencoded

Example URI

PUT /article
Request
HideShow
Headers
Authorization: Bearer <access_token>
Body
{
  "id": 1,
  "title": "object xyz",
  "body": "this is a long description",
  "category_id": 1,
  "price": "10|10,51|10.51",
  "stock": 5,
  "delivery_cost_split": "50/50",
  "total_delivery_cost": "10|10,51|10.51",
  "delivery_time": "1 to 3 working days",
  "delivery_costs_eu": "10|10,51|10.51",
  "delivery_time_eu": "3 to 5 working days",
  "to_trade": "0|1",
  "to_give_away": "0|1",
  "location": {
    "country_code": "DE",
    "longitude": 13.428308,
    "latitude": 52.497703,
    "post_code": "10999"
  },
  "files": [],
  "attributes": [],
  "KEY": []
}
Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "ID of the item to edit."
    },
    "title": {
      "type": "string",
      "description": "Title of the item to sell."
    },
    "body": {
      "type": "string",
      "description": "Description for the article with a max length of 4000 characters."
    },
    "category_id": {
      "type": "number",
      "description": "Id of the category."
    },
    "price": {
      "type": "string",
      "description": "Price to sell the item. Comma will be handled as decimal seperator."
    },
    "stock": {
      "type": "number"
    },
    "delivery_cost_split": {
      "type": "string",
      "description": "How to split delivery cost. Options are 50/50, 0/100, 100/0."
    },
    "total_delivery_cost": {
      "type": "string",
      "description": "Total delivery costs within the country. Can be required if the transport attribute is contains zu delivery as an option."
    },
    "delivery_time": {
      "type": "string",
      "description": "Short description of the estimated delivery time for country wide delivery. Max length of 30 Characters."
    },
    "delivery_costs_eu": {
      "type": "string",
      "description": "Delivery costs to send it to an other european country."
    },
    "delivery_time_eu": {
      "type": "string",
      "description": "Short description of the estimated delivery time for eu wide delivery. Max length of 30 Characters."
    },
    "to_trade": {
      "type": "string",
      "description": "If true the item is marked as tradable item so the user is open to trade it for another item."
    },
    "to_give_away": {
      "type": "string",
      "description": "If true the item is marked to give away for free."
    },
    "location": {
      "type": "object",
      "properties": {
        "country_code": {
          "type": "string",
          "description": "2 character country code"
        },
        "longitude": {
          "type": "number",
          "description": "Longitude as a decimal."
        },
        "latitude": {
          "type": "number",
          "description": "Latitude as a decimal."
        },
        "post_code": {
          "type": "string",
          "description": "Postcode."
        }
      },
      "required": [
        "country_code",
        "longitude",
        "latitude",
        "post_code"
      ],
      "description": "Location data object"
    },
    "files": {
      "type": "array",
      "description": "List of temporary file keys as well as ID's of existing files linked to that article"
    },
    "attributes": {
      "type": "array",
      "description": "KEY => VALUE array data of attached attributes"
    },
    "KEY": {
      "type": "array",
      "description": "A single value for the attribute or a list of values within an array."
    }
  },
  "required": [
    "id",
    "files",
    "attributes"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "422 Unprocessable Entity",
  "errors": {
    "title": [
      {
        "code": "required",
        "message": "Bitte einen Titel angeben"
      }
    ],
    "files.0": [
      {
        "code": "exists",
        "message": "The selected files.0 is invalid."
      }
    ],
    "attributes.zustand.0": [
      {
        "code": "filter_setting",
        "message": "Filter Setting fehlerhaft"
      }
    ]
  },
  "status_code": 422
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
              "data": {
                "id": 1925,
                "external_id": 1111,
                "type": "USER_FREE_CLASSIFIED",
                "title": "My awesome product",
                "body": "This is an example description!",
                "imprint": "",
                "returnpolicy": "",
                "price": "30",
                "stock": "5",
                "previous_price": 25,
                "buyer_delivery_cost": "5.00",
                "seller_delivery_cost": "5.00",
                "delivery_costs_eu": "5.00",
                "delivery_time": "1 to 3 days",
                "delivery_time_eu": "3 to 7 days",
                "delivery_info": null,
                "currency": "EUR",
                "category_id": 15,
                "url": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/auto_rad_boot/boote_zubehoer/my-awesome-product-1925",
                "created_at": "2017-01-01T00:00:00+0000",
                "to_sell": 1,
                "to_trade": 1,
                "to_give_away": 1,
                "is_premium": 0,
                "is_editable": true,
                "is_buyable": false,
                "has_pending_order": false,
                "itemlist_attributes": [],
                "count_views": 1,
                "count_likes": 0,
                "status": "active",
                "renewable": false,
                "is_favorite": false,
                "open_for_offers": false,
                "buyer_delivery": false,
                "transaction_type": managed,

               "comment_count": 9,
               "carrierPlan": {
                  "data": {
                    "id": 1,
                    "title": "DHL Paket XS",
                    "price": 439,
                    "old_price": 439,
                    "pickup_service": "self_sending",
                    "sellers_phone_required": false,
                    "buyer_phone_required": false,
                    "icon": {
                      "data": {
                        "tiny": "http://abc:[email protected]/uploads/thumbs/2016/10-13/HI1YCnwQ_50x28.jpg",
                        "small": "http://abc:[email protected]/uploads/thumbs/2016/10-13/HI1YCnwQ_250x140.jpg",
                        "medium": "http://abc:[email protected]/uploads/thumbs/2016/10-13/HI1YCnwQ_500x281.jpg"
                      }
                    },
                    "description": null,
                    "info_link": null
                  }
               },
               "comments": {
                 "data": [
                   {
                     "id": 50,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 2,
                     "comment": "a lovely comment",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": []
                     },
                     "user": {
                       "data": {
                         "id": 2,
                         "display_name": "kaiserlos",
                         "username": "kaiserlos",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": null,
                         "confirmed": 1,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": null,
                         "last_login": null,
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@kaiserlos",
                         "country_of_residence_code": null,
                         "post_code": null,
                         "city": null,
                         "verified": false,
                         "response_rate": "0.00",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                         "articles_count": 369,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   },
                   {
                     "id": 51,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 5,
                     "comment": "new comment",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": [
                         {
                           "id": 52,
                           "article_id": 1908,
                           "comment_reply_id": 51,
                           "user_id": 3,
                           "comment": "reply to commment",
                           "created_at": "2017-01-01T00:00:00+0000",
                           "edited_at": null,
                           "updated_at": "2017-01-01T00:00:00+0000",
                           "is_editable": true,
                           "replies": {
                             "data": []
                           },
                           "user": {
                             "data": {
                               "id": 3,
                               "display_name": "oliver",
                               "username": "oliver",
                               "has_picture": false,
                               "picture": {
                                 "data": {
                                   "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                                   "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                                   "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                                 }
                               },
                               "bio": null,
                               "confirmed": 1,
                               "created_at": "2017-01-01T00:00:00+0000",
                               "gender": null,
                               "last_login": null,
                               "is_merchant": false,
                               "has_facebook": false,
                               "rating": "0.00",
                               "rating_count": 0,
                               "url": "http://local.gebraucht.de/@oliver",
                               "country_of_residence_code": null,
                               "post_code": null,
                               "city": null,
                               "verified": false,
                               "response_rate": "0.00",
                               "number_of_followers": 123,
                               "number_of_product_likes": 234,
                               "number_of_sales": 12,
                               "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                               "articles_count": 405,
                               "accepts_paypal": false,
                               "can_be_rated": false
                             }
                           }
                         },
                         {
                           "id": 53,
                           "article_id": 1908,
                           "comment_reply_id": 51,
                           "user_id": 1,
                           "comment": "reply to commment 2",
                           "created_at": "2017-01-01T00:00:00+0000",
                           "edited_at": null,
                           "updated_at": "2017-01-01T00:00:00+0000",
                           "is_editable": true,
                           "replies": {
                             "data": [
                               {
                                 "id": 54,
                                 "article_id": 1908,
                                 "comment_reply_id": 53,
                                 "user_id": 2,
                                 "comment": "reply to commment 3 ",
                                 "created_at": "2017-01-01T00:00:00+0000",
                                 "edited_at": null,
                                 "updated_at": "2017-01-01T00:00:00+0000",
                                 "is_editable": true,
                                 "replies": {
                                   "data": []
                                 },
                                 "user": {
                                   "data": {
                                     "id": 2,
                                     "display_name": "kaiserlos",
                                     "username": "kaiserlos",
                                     "has_picture": false,
                                     "picture": {
                                       "data": {
                                         "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                                         "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                                         "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                                       }
                                     },
                                     "bio": null,
                                     "confirmed": 1,
                                     "created_at": "2017-01-01T00:00:00+0000",
                                     "gender": null,
                                     "last_login": null,
                                     "is_merchant": false,
                                     "has_facebook": false,
                                     "rating": "0.00",
                                     "rating_count": 0,
                                     "url": "http://local.gebraucht.de/@kaiserlos",
                                     "country_of_residence_code": null,
                                     "post_code": null,
                                     "city": null,
                                     "verified": false,
                                     "response_rate": "0.00",
                                     "number_of_followers": 123,
                                     "number_of_product_likes": 234,
                                     "number_of_sales": 12,
                                     "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                                     "articles_count": 369,
                                     "accepts_paypal": false,
                                     "can_be_rated": false
                                   }
                                 }
                               }
                             ]
                           },
                           "user": {
                             "data": {
                               "id": 1,
                               "display_name": "A A.",
                               "username": "admin",
                               "has_picture": false,
                               "picture": {
                                 "data": {
                                   "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                                   "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                                   "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                                 }
                               },
                               "bio": "This is my bio line",
                               "confirmed": 0,
                               "created_at": "2017-01-01T00:00:00+0000",
                               "gender": "m",
                               "last_login": "2017-01-01T00:00:00+0000",
                               "is_merchant": false,
                               "has_facebook": false,
                               "rating": "0.00",
                               "rating_count": 0,
                               "url": "http://local.gebraucht.de/@admin",
                               "country_of_residence_code": "DE",
                               "post_code": "11111",
                               "city": null,
                               "verified": true,
                               "response_rate": "23.53",
                               "number_of_followers": 123,
                               "number_of_product_likes": 234,
                               "number_of_sales": 12,
                               "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=42.7156271,-83.7411562&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:{[email protected][email protected]@nFfB~EtCpE~DxDbF~CdGdC`[email protected][email protected]~G_DdGyDdFqE|[email protected]{[email protected][email protected]",
                               "articles_count": 403,
                               "accepts_paypal": false,
                               "can_be_rated": false
                             }
                           }
                         }
                       ]
                     },
                     "user": {
                       "data": {
                         "id": 5,
                         "display_name": "Justin K.",
                         "username": "justin",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": "I am looking to sell my excess stuff to de-clutter my life",
                         "confirmed": 1,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": "m",
                         "last_login": "2017-01-01T00:00:00+0000",
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@justin",
                         "country_of_residence_code": null,
                         "post_code": null,
                         "city": null,
                         "verified": true,
                         "response_rate": "0.00",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                         "articles_count": 368,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   },
                   {
                     "id": 55,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 1,
                     "comment": "next question",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": []
                     },
                     "user": {
                       "data": {
                         "id": 1,
                         "display_name": "A A.",
                         "username": "admin",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": "This is my bio line",
                         "confirmed": 0,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": "m",
                         "last_login": "2017-01-01T00:00:00+0000",
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@admin",
                         "country_of_residence_code": "DE",
                         "post_code": "11111",
                         "city": null,
                         "verified": true,
                         "response_rate": "23.53",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=42.7156271,-83.7411562&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:{[email protected][email protected]@nFfB~EtCpE~DxDbF~CdGdC`[email protected][email protected]~G_DdGyDdFqE|[email protected]{[email protected][email protected]",
                         "articles_count": 403,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   },
                   {
                     "id": 56,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 1,
                     "comment": "next reply!",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": []
                     },
                     "user": {
                       "data": {
                         "id": 1,
                         "display_name": "A A.",
                         "username": "admin",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": "This is my bio line",
                         "confirmed": 0,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": "m",
                         "last_login": "2017-01-01T00:00:00+0000",
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@admin",
                         "country_of_residence_code": "DE",
                         "post_code": "11111",
                         "city": null,
                         "verified": true,
                         "response_rate": "23.53",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=42.7156271,-83.7411562&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:{[email protected][email protected]@nFfB~EtCpE~DxDbF~CdGdC`[email protected][email protected]~G_DdGyDdFqE|[email protected]{[email protected][email protected]",
                         "articles_count": 403,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   },
                   {
                     "id": 63,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 5,
                     "comment": "a lovely comment",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": [
                         {
                           "id": 64,
                           "article_id": 1908,
                           "comment_reply_id": 63,
                           "user_id": 1,
                           "comment": "reply 12345",
                           "created_at": "2017-01-01T00:00:00+0000",
                           "edited_at": null,
                           "updated_at": "2017-01-01T00:00:00+0000",
                           "is_editable": true,
                           "replies": {
                             "data": []
                           },
                           "user": {
                             "data": {
                               "id": 1,
                               "display_name": "A A.",
                               "username": "admin",
                               "has_picture": false,
                               "picture": {
                                 "data": {
                                   "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                                   "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                                   "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                                 }
                               },
                               "bio": "This is my bio line",
                               "confirmed": 0,
                               "created_at": "2017-01-01T00:00:00+0000",
                               "gender": "m",
                               "last_login": "2017-01-01T00:00:00+0000",
                               "is_merchant": false,
                               "has_facebook": false,
                               "rating": "0.00",
                               "rating_count": 0,
                               "url": "http://local.gebraucht.de/@admin",
                               "country_of_residence_code": "DE",
                               "post_code": "11111",
                               "city": null,
                               "verified": true,
                               "response_rate": "23.53",
                               "number_of_followers": 123,
                               "number_of_product_likes": 234,
                               "number_of_sales": 12,
                               "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=42.7156271,-83.7411562&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:{[email protected][email protected]@nFfB~EtCpE~DxDbF~CdGdC`[email protected][email protected]~G_DdGyDdFqE|[email protected]{[email protected][email protected]",
                               "articles_count": 403,
                               "accepts_paypal": false,
                               "can_be_rated": false
                             }
                           }
                         }
                       ]
                     },
                     "user": {
                       "data": {
                         "id": 5,
                         "display_name": "Justin K.",
                         "username": "justin",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": "I am looking to sell my excess stuff to de-clutter my life",
                         "confirmed": 1,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": "m",
                         "last_login": "2017-01-01T00:00:00+0000",
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@justin",
                         "country_of_residence_code": null,
                         "post_code": null,
                         "city": null,
                         "verified": true,
                         "response_rate": "0.00",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                         "articles_count": 368,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   }
                 ]
               },

                "location": {
                  "data": {
                    "latitude": 10.000120018427,
                    "longitude": 9.9988404659265,
                    "street": "",
                    "city": "Berlin",
                    "post_code": "12345",
                    "country_code": "DE"
                  }
                },
                "user": {
                  "data": {
                    "id": 1,
                    "display_name": "dfsdf a.",
                    "username": "admin",
                    "picture": {
                      "data": {
                        "tiny": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                        "small": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                        "medium": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                      }
                    },
                    "confirmed": 1,
                    "created_at": "2017-01-01T00:00:00+0000",
                    "gender": "m",
                    "last_login": "2017-01-01T00:00:00+0000",
                    "is_merchant": false,
                    "has_facebook": false,
                    "rating": "0.00",
                    "rating_count": 0,
                    "url": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/@admin",
                    "response_rate": 99,
                    "articles_count": 5,
                    "verified": false,
                    "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.500377,13.360147&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:qvn_I{kppAP{[email protected]}[email protected][email protected][email protected]|[email protected]}[email protected]",
                    "number_of_followers": 123,
                    "number_of_product_likes": 234,
                    "number_of_sales": 12,
                    "accepts_paypal": false,
                    "can_be_rated": false
                  }
                },
                "files": {
                  "data": [
                    {
                      "id": 3359,
                      "tiny": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_36x60.jpeg",
                      "small": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_73x120.jpeg",
                      "medium": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_242x400.jpeg",
                      "big": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_424x700.jpeg",
                      "large": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_606x1000.jpeg"
                    }
                  ]
                },
                "filtersettings": {
                  "data": [
                    {
                      "id": 1,
                      "key": "transport",
                      "position": 1000,
                      "value_select": "Transport",
                      "value_form": "Transport",
                      "value_details": "Transport",
                      "type_form": "checkbox",
                      "type_select": "radio",
                      "show_at_select": 1,
                      "show_at_form": 1,
                      "show_at_details": 1,
                      "show_at_form_if_filtersetting": "NULL",
                      "show_at_head": 1,
                      "show_at_itemlist": 0,
                      "show_at_itemlist_format": "",
                      "template_select": "list",
                      "template_form": "list",
                      "template_detail": "",
                      "individual_values": 0,
                      "min_setting_count": 0,
                      "max_setting_count": 0,
                      "settings": {
                        "data": [
                          {
                            "id": 2,
                            "filter_id": 1,
                            "filter_key": null,
                            "value_key": "versand",
                            "value_select": "Versand",
                            "value_description": null,
                            "value_form": "Versand",
                            "value_details": "Versand",
                            "position": 1,
                            "is_individual_value": "0"
                          }
                        ]
                      }
                    },
                    {
                      "id": 3,
                      "key": "zustand",
                      "position": 1000,
                      "value_select": "Zustand",
                      "value_form": "Zustand",
                      "value_details": "Zustand",
                      "type_form": "select",
                      "type_select": "checkbox",
                      "show_at_select": 1,
                      "show_at_form": 1,
                      "show_at_details": 1,
                      "show_at_form_if_filtersetting": "NULL",
                      "show_at_head": 1,
                      "show_at_itemlist": 0,
                      "show_at_itemlist_format": "",
                      "template_select": "list"
                      "template_form": "list",
                      "template_detail": "",
                      "individual_values": 0,
                      "min_setting_count": 0,
                      "max_setting_count": 0,
                      "settings": {
                        "data": [
                          {
                            "id": 364,
                            "filter_id": 3,
                            "filter_key": null,
                            "value_key": "good",
                            "value_select": "Gut",
                            "value_description": "Der Artikel hat einige offensichtliche Gebrauchsspuren, z.B. deutliche Kratzer oder kleine Beschädigungen.",
                            "value_form": "Gut",
                            "value_details": "Gut",
                            "position": 3,
                            "is_individual_value": "0"
                          }
                        ]
                      }
                    }
                  ]
                },
                "extra_attributes" => {"code" => "1010"},

              }
            },

Update by external Id

Update by external Id
PUT/article?external_id=

Update an existing article using external_id to resolve articles.

Example URI

PUT /article?external_id=
URI Parameters
HideShow
external_id: `5` (string, required) - The external_id of the article.
string (required) 
Request
HideShow
Headers
Authorization: Bearer <access_token>
Body
{
  "title": "object xyz",
  "body": "this is a long description",
  "category_id": 1,
  "price": "10|10,51|10.51",
  "stock": 5,
  "delivery_cost_split": "50/50",
  "total_delivery_cost": "10|10,51|10.51",
  "delivery_time": "1 to 3 working days",
  "delivery_costs_eu": "10|10,51|10.51",
  "delivery_time_eu": "3 to 5 working days",
  "to_trade": "0|1",
  "to_give_away": "0|1",
  "location": {
    "country_code": "DE",
    "longitude": 13.428308,
    "latitude": 52.497703,
    "post_code": "10999"
  },
  "files": [],
  "attributes": [],
  "KEY": []
}
Schema
{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "Title of the item to sell."
    },
    "body": {
      "type": "string",
      "description": "Description for the article with a max length of 4000 characters."
    },
    "category_id": {
      "type": "number",
      "description": "Id of the category."
    },
    "price": {
      "type": "string",
      "description": "Price to sell the item. Comma will be handled as decimal seperator."
    },
    "stock": {
      "type": "number"
    },
    "delivery_cost_split": {
      "type": "string",
      "description": "How to split delivery cost. Options are 50/50, 0/100, 100/0."
    },
    "total_delivery_cost": {
      "type": "string",
      "description": "Total delivery costs within the country. Can be required if the transport attribute is contains zu delivery as an option."
    },
    "delivery_time": {
      "type": "string",
      "description": "Short description of the estimated delivery time for country wide delivery. Max length of 30 Characters."
    },
    "delivery_costs_eu": {
      "type": "string",
      "description": "Delivery costs to send it to an other european country."
    },
    "delivery_time_eu": {
      "type": "string",
      "description": "Short description of the estimated delivery time for eu wide delivery. Max length of 30 Characters."
    },
    "to_trade": {
      "type": "string",
      "description": "If true the item is marked as tradable item so the user is open to trade it for another item."
    },
    "to_give_away": {
      "type": "string",
      "description": "If true the item is marked to give away for free."
    },
    "location": {
      "type": "object",
      "properties": {
        "country_code": {
          "type": "string",
          "description": "2 character country code"
        },
        "longitude": {
          "type": "number",
          "description": "Longitude as a decimal."
        },
        "latitude": {
          "type": "number",
          "description": "Latitude as a decimal."
        },
        "post_code": {
          "type": "string",
          "description": "Postcode."
        }
      },
      "required": [
        "country_code",
        "longitude",
        "latitude",
        "post_code"
      ],
      "description": "Location data object"
    },
    "files": {
      "type": "array",
      "description": "List of temporary file keys as well as ID's of existing files linked to that article"
    },
    "attributes": {
      "type": "array",
      "description": "KEY => VALUE array data of attached attributes"
    },
    "KEY": {
      "type": "array",
      "description": "A single value for the attribute or a list of values within an array."
    }
  },
  "required": [
    "files",
    "attributes"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "422 Unprocessable Entity",
  "errors": {
    "title": [
      {
        "code": "required",
        "message": "Bitte einen Titel angeben"
      }
    ],
    "files.0": [
      {
        "code": "exists",
        "message": "The selected files.0 is invalid."
      }
    ],
    "attributes.zustand.0": [
      {
        "code": "filter_setting",
        "message": "Filter Setting fehlerhaft"
      }
    ]
  },
  "status_code": 422
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
              "data": {
                "id": 1925,
                "external_id": 1111,
                "type": "USER_FREE_CLASSIFIED",
                "title": "My awesome product",
                "body": "This is an example description!",
                "imprint": "",
                "returnpolicy": "",
                "price": "30",
                "stock": "5",
                "previous_price": 25,
                "buyer_delivery_cost": "5.00",
                "seller_delivery_cost": "5.00",
                "delivery_costs_eu": "5.00",
                "delivery_time": "1 to 3 days",
                "delivery_time_eu": "3 to 7 days",
                "delivery_info": null,
                "currency": "EUR",
                "category_id": 15,
                "url": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/auto_rad_boot/boote_zubehoer/my-awesome-product-1925",
                "created_at": "2017-01-01T00:00:00+0000",
                "to_sell": 1,
                "to_trade": 1,
                "to_give_away": 1,
                "is_premium": 0,
                "is_editable": true,
                "is_buyable": false,
                "has_pending_order": false,
                "itemlist_attributes": [],
                "count_views": 1,
                "count_likes": 0,
                "status": "active",
                "renewable": false,
                "is_favorite": false,
                "open_for_offers": false,
                "buyer_delivery": false,
                "transaction_type": managed,

               "comment_count": 9,
               "carrierPlan": {
                  "data": {
                    "id": 1,
                    "title": "DHL Paket XS",
                    "price": 439,
                    "old_price": 439,
                    "pickup_service": "self_sending",
                    "sellers_phone_required": false,
                    "buyer_phone_required": false,
                    "icon": {
                      "data": {
                        "tiny": "http://abc:[email protected]/uploads/thumbs/2016/10-13/HI1YCnwQ_50x28.jpg",
                        "small": "http://abc:[email protected]/uploads/thumbs/2016/10-13/HI1YCnwQ_250x140.jpg",
                        "medium": "http://abc:[email protected]/uploads/thumbs/2016/10-13/HI1YCnwQ_500x281.jpg"
                      }
                    },
                    "description": null,
                    "info_link": null
                  }
               },
               "comments": {
                 "data": [
                   {
                     "id": 50,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 2,
                     "comment": "a lovely comment",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": []
                     },
                     "user": {
                       "data": {
                         "id": 2,
                         "display_name": "kaiserlos",
                         "username": "kaiserlos",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": null,
                         "confirmed": 1,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": null,
                         "last_login": null,
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@kaiserlos",
                         "country_of_residence_code": null,
                         "post_code": null,
                         "city": null,
                         "verified": false,
                         "response_rate": "0.00",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                         "articles_count": 369,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   },
                   {
                     "id": 51,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 5,
                     "comment": "new comment",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": [
                         {
                           "id": 52,
                           "article_id": 1908,
                           "comment_reply_id": 51,
                           "user_id": 3,
                           "comment": "reply to commment",
                           "created_at": "2017-01-01T00:00:00+0000",
                           "edited_at": null,
                           "updated_at": "2017-01-01T00:00:00+0000",
                           "is_editable": true,
                           "replies": {
                             "data": []
                           },
                           "user": {
                             "data": {
                               "id": 3,
                               "display_name": "oliver",
                               "username": "oliver",
                               "has_picture": false,
                               "picture": {
                                 "data": {
                                   "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                                   "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                                   "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                                 }
                               },
                               "bio": null,
                               "confirmed": 1,
                               "created_at": "2017-01-01T00:00:00+0000",
                               "gender": null,
                               "last_login": null,
                               "is_merchant": false,
                               "has_facebook": false,
                               "rating": "0.00",
                               "rating_count": 0,
                               "url": "http://local.gebraucht.de/@oliver",
                               "country_of_residence_code": null,
                               "post_code": null,
                               "city": null,
                               "verified": false,
                               "response_rate": "0.00",
                               "number_of_followers": 123,
                               "number_of_product_likes": 234,
                               "number_of_sales": 12,
                               "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                               "articles_count": 405,
                               "accepts_paypal": false,
                               "can_be_rated": false
                             }
                           }
                         },
                         {
                           "id": 53,
                           "article_id": 1908,
                           "comment_reply_id": 51,
                           "user_id": 1,
                           "comment": "reply to commment 2",
                           "created_at": "2017-01-01T00:00:00+0000",
                           "edited_at": null,
                           "updated_at": "2017-01-01T00:00:00+0000",
                           "is_editable": true,
                           "replies": {
                             "data": [
                               {
                                 "id": 54,
                                 "article_id": 1908,
                                 "comment_reply_id": 53,
                                 "user_id": 2,
                                 "comment": "reply to commment 3 ",
                                 "created_at": "2017-01-01T00:00:00+0000",
                                 "edited_at": null,
                                 "updated_at": "2017-01-01T00:00:00+0000",
                                 "is_editable": true,
                                 "replies": {
                                   "data": []
                                 },
                                 "user": {
                                   "data": {
                                     "id": 2,
                                     "display_name": "kaiserlos",
                                     "username": "kaiserlos",
                                     "has_picture": false,
                                     "picture": {
                                       "data": {
                                         "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                                         "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                                         "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                                       }
                                     },
                                     "bio": null,
                                     "confirmed": 1,
                                     "created_at": "2017-01-01T00:00:00+0000",
                                     "gender": null,
                                     "last_login": null,
                                     "is_merchant": false,
                                     "has_facebook": false,
                                     "rating": "0.00",
                                     "rating_count": 0,
                                     "url": "http://local.gebraucht.de/@kaiserlos",
                                     "country_of_residence_code": null,
                                     "post_code": null,
                                     "city": null,
                                     "verified": false,
                                     "response_rate": "0.00",
                                     "number_of_followers": 123,
                                     "number_of_product_likes": 234,
                                     "number_of_sales": 12,
                                     "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                                     "articles_count": 369,
                                     "accepts_paypal": false,
                                     "can_be_rated": false
                                   }
                                 }
                               }
                             ]
                           },
                           "user": {
                             "data": {
                               "id": 1,
                               "display_name": "A A.",
                               "username": "admin",
                               "has_picture": false,
                               "picture": {
                                 "data": {
                                   "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                                   "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                                   "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                                 }
                               },
                               "bio": "This is my bio line",
                               "confirmed": 0,
                               "created_at": "2017-01-01T00:00:00+0000",
                               "gender": "m",
                               "last_login": "2017-01-01T00:00:00+0000",
                               "is_merchant": false,
                               "has_facebook": false,
                               "rating": "0.00",
                               "rating_count": 0,
                               "url": "http://local.gebraucht.de/@admin",
                               "country_of_residence_code": "DE",
                               "post_code": "11111",
                               "city": null,
                               "verified": true,
                               "response_rate": "23.53",
                               "number_of_followers": 123,
                               "number_of_product_likes": 234,
                               "number_of_sales": 12,
                               "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=42.7156271,-83.7411562&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:{[email protected][email protected]@nFfB~EtCpE~DxDbF~CdGdC`[email protected][email protected]~G_DdGyDdFqE|[email protected]{[email protected][email protected]",
                               "articles_count": 403,
                               "accepts_paypal": false,
                               "can_be_rated": false
                             }
                           }
                         }
                       ]
                     },
                     "user": {
                       "data": {
                         "id": 5,
                         "display_name": "Justin K.",
                         "username": "justin",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": "I am looking to sell my excess stuff to de-clutter my life",
                         "confirmed": 1,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": "m",
                         "last_login": "2017-01-01T00:00:00+0000",
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@justin",
                         "country_of_residence_code": null,
                         "post_code": null,
                         "city": null,
                         "verified": true,
                         "response_rate": "0.00",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                         "articles_count": 368,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   },
                   {
                     "id": 55,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 1,
                     "comment": "next question",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": []
                     },
                     "user": {
                       "data": {
                         "id": 1,
                         "display_name": "A A.",
                         "username": "admin",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": "This is my bio line",
                         "confirmed": 0,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": "m",
                         "last_login": "2017-01-01T00:00:00+0000",
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@admin",
                         "country_of_residence_code": "DE",
                         "post_code": "11111",
                         "city": null,
                         "verified": true,
                         "response_rate": "23.53",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=42.7156271,-83.7411562&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:{[email protected][email protected]@nFfB~EtCpE~DxDbF~CdGdC`[email protected][email protected]~G_DdGyDdFqE|[email protected]{[email protected][email protected]",
                         "articles_count": 403,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   },
                   {
                     "id": 56,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 1,
                     "comment": "next reply!",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": []
                     },
                     "user": {
                       "data": {
                         "id": 1,
                         "display_name": "A A.",
                         "username": "admin",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": "This is my bio line",
                         "confirmed": 0,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": "m",
                         "last_login": "2017-01-01T00:00:00+0000",
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@admin",
                         "country_of_residence_code": "DE",
                         "post_code": "11111",
                         "city": null,
                         "verified": true,
                         "response_rate": "23.53",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=42.7156271,-83.7411562&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:{[email protected][email protected]@nFfB~EtCpE~DxDbF~CdGdC`[email protected][email protected]~G_DdGyDdFqE|[email protected]{[email protected][email protected]",
                         "articles_count": 403,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   },
                   {
                     "id": 63,
                     "article_id": 1908,
                     "comment_reply_id": null,
                     "user_id": 5,
                     "comment": "a lovely comment",
                     "created_at": "2017-01-01T00:00:00+0000",
                     "edited_at": null,
                     "updated_at": "2017-01-01T00:00:00+0000",
                     "is_editable": true,
                     "replies": {
                       "data": [
                         {
                           "id": 64,
                           "article_id": 1908,
                           "comment_reply_id": 63,
                           "user_id": 1,
                           "comment": "reply 12345",
                           "created_at": "2017-01-01T00:00:00+0000",
                           "edited_at": null,
                           "updated_at": "2017-01-01T00:00:00+0000",
                           "is_editable": true,
                           "replies": {
                             "data": []
                           },
                           "user": {
                             "data": {
                               "id": 1,
                               "display_name": "A A.",
                               "username": "admin",
                               "has_picture": false,
                               "picture": {
                                 "data": {
                                   "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                                   "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                                   "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                                 }
                               },
                               "bio": "This is my bio line",
                               "confirmed": 0,
                               "created_at": "2017-01-01T00:00:00+0000",
                               "gender": "m",
                               "last_login": "2017-01-01T00:00:00+0000",
                               "is_merchant": false,
                               "has_facebook": false,
                               "rating": "0.00",
                               "rating_count": 0,
                               "url": "http://local.gebraucht.de/@admin",
                               "country_of_residence_code": "DE",
                               "post_code": "11111",
                               "city": null,
                               "verified": true,
                               "response_rate": "23.53",
                               "number_of_followers": 123,
                               "number_of_product_likes": 234,
                               "number_of_sales": 12,
                               "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=42.7156271,-83.7411562&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:{[email protected][email protected]@nFfB~EtCpE~DxDbF~CdGdC`[email protected][email protected]~G_DdGyDdFqE|[email protected]{[email protected][email protected]",
                               "articles_count": 403,
                               "accepts_paypal": false,
                               "can_be_rated": false
                             }
                           }
                         }
                       ]
                     },
                     "user": {
                       "data": {
                         "id": 5,
                         "display_name": "Justin K.",
                         "username": "justin",
                         "has_picture": false,
                         "picture": {
                           "data": {
                             "tiny": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                             "small": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                             "medium": "http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                           }
                         },
                         "bio": "I am looking to sell my excess stuff to de-clutter my life",
                         "confirmed": 1,
                         "created_at": "2017-01-01T00:00:00+0000",
                         "gender": "m",
                         "last_login": "2017-01-01T00:00:00+0000",
                         "is_merchant": false,
                         "has_facebook": false,
                         "rating": "0.00",
                         "rating_count": 0,
                         "url": "http://local.gebraucht.de/@justin",
                         "country_of_residence_code": null,
                         "post_code": null,
                         "city": null,
                         "verified": true,
                         "response_rate": "0.00",
                         "number_of_followers": 123,
                         "number_of_product_likes": 234,
                         "number_of_sales": 12,
                         "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.4977025,13.4283081&size=320x200&zoom=3",
                         "articles_count": 368,
                         "accepts_paypal": false,
                         "can_be_rated": false
                       }
                     }
                   }
                 ]
               },

                "location": {
                  "data": {
                    "latitude": 10.000120018427,
                    "longitude": 9.9988404659265,
                    "street": "",
                    "city": "Berlin",
                    "post_code": "12345",
                    "country_code": "DE"
                  }
                },
                "user": {
                  "data": {
                    "id": 1,
                    "display_name": "dfsdf a.",
                    "username": "admin",
                    "picture": {
                      "data": {
                        "tiny": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/generated/default_userphoto_50_50_0.png",
                        "small": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/generated/default_userphoto_250_250_0.png",
                        "medium": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/generated/default_userphoto_500_500_0.png"
                      }
                    },
                    "confirmed": 1,
                    "created_at": "2017-01-01T00:00:00+0000",
                    "gender": "m",
                    "last_login": "2017-01-01T00:00:00+0000",
                    "is_merchant": false,
                    "has_facebook": false,
                    "rating": "0.00",
                    "rating_count": 0,
                    "url": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/@admin",
                    "response_rate": 99,
                    "articles_count": 5,
                    "verified": false,
                    "map_static_image": "https://maps.googleapis.com/maps/staticmap?center=52.500377,13.360147&size=320x200&zoom=12&path=fillcolor:0x12a83033|color:0x12a830|weight:3|enc:qvn_I{kppAP{[email protected]}[email protected][email protected][email protected]|[email protected]}[email protected]",
                    "number_of_followers": 123,
                    "number_of_product_likes": 234,
                    "number_of_sales": 12,
                    "accepts_paypal": false,
                    "can_be_rated": false
                  }
                },
                "files": {
                  "data": [
                    {
                      "id": 3359,
                      "tiny": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_36x60.jpeg",
                      "small": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_73x120.jpeg",
                      "medium": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_242x400.jpeg",
                      "big": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_424x700.jpeg",
                      "large": "http://local3.gebraucht.de.192.168.1.110.xip.io:8000/uploads/thumbs/2016/08-17/IegOF5i1_606x1000.jpeg"
                    }
                  ]
                },
                "filtersettings": {
                  "data": [
                    {
                      "id": 1,
                      "key": "transport",
                      "position": 1000,
                      "value_select": "Transport",
                      "value_form": "Transport",
                      "value_details": "Transport",
                      "type_form": "checkbox",
                      "type_select": "radio",
                      "show_at_select": 1,
                      "show_at_form": 1,
                      "show_at_details": 1,
                      "show_at_form_if_filtersetting": "NULL",
                      "show_at_head": 1,
                      "show_at_itemlist": 0,
                      "show_at_itemlist_format": "",
                      "template_select": "list",
                      "template_form": "list",
                      "template_detail": "",
                      "individual_values": 0,
                      "min_setting_count": 0,
                      "max_setting_count": 0,
                      "settings": {
                        "data": [
                          {
                            "id": 2,
                            "filter_id": 1,
                            "filter_key": null,
                            "value_key": "versand",
                            "value_select": "Versand",
                            "value_description": null,
                            "value_form": "Versand",
                            "value_details": "Versand",
                            "position": 1,
                            "is_individual_value": "0"
                          }
                        ]
                      }
                    },
                    {
                      "id": 3,
                      "key": "zustand",
                      "position": 1000,
                      "value_select": "Zustand",
                      "value_form": "Zustand",
                      "value_details": "Zustand",
                      "type_form": "select",
                      "type_select": "checkbox",
                      "show_at_select": 1,
                      "show_at_form": 1,
                      "show_at_details": 1,
                      "show_at_form_if_filtersetting": "NULL",
                      "show_at_head": 1,
                      "show_at_itemlist": 0,
                      "show_at_itemlist_format": "",
                      "template_select": "list"
                      "template_form": "list",
                      "template_detail": "",
                      "individual_values": 0,
                      "min_setting_count": 0,
                      "max_setting_count": 0,
                      "settings": {
                        "data": [
                          {
                            "id": 364,
                            "filter_id": 3,
                            "filter_key": null,
                            "value_key": "good",
                            "value_select": "Gut",
                            "value_description": "Der Artikel hat einige offensichtliche Gebrauchsspuren, z.B. deutliche Kratzer oder kleine Beschädigungen.",
                            "value_form": "Gut",
                            "value_details": "Gut",
                            "position": 3,
                            "is_individual_value": "0"
                          }
                        ]
                      }
                    }
                  ]
                },
                "extra_attributes" => {"code" => "1010"},

              }
            },

Verify

Verify
PUT/v3/articles/{id}/verify

Dont need

Example URI

PUT /v3/articles/5/verify
URI Parameters
HideShow
id
number (required) Example: 5

The Id of the user

Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "TODO not needed": "TODO not needed",
  }

Toggle Pause

Toggle Pause
PUT/v3/articles/{id}/togglepause

Dont need

Example URI

PUT /v3/articles/5/togglepause
URI Parameters
HideShow
id
number (required) Example: 5

The Id of the user

Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "paused",
  "article_status": "paused"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Artikel kann nicht erneuert werden - bitte ein neues erstellen.",
  "status_code": 403
}

Renew Runtime

Renew Runtime
PUT/v3/articles/renewruntime

Renew the runtime of an article of the user if it’s elapsed

Example URI

PUT /v3/articles/renewruntime
Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "runtime_renewed",
  "article_status": "active"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "403 Forbidden",
  "status_code": 403
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Artikel kann nicht erneuert werden - bitte ein neues erstellen",
  "status_code": 403
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "404 Not Found",
  "status_code": 404
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Article is not elapsed",
  "status_code": 406
}

Contact

Contact
POST/v3/articles/{id}/contact

only possible if not a user and for FREE CLASSIFIED ADS

Example URI

POST /v3/articles/1910/contact
URI Parameters
HideShow
id
number (required) Example: 1910

The Id of the article

Request
HideShow
Headers
Authorization: Bearer <access_token>
Body
{
  "body": "the message you want to send",
  "name": "the name of the user"
}
Schema
{
  "type": "object",
  "properties": {
    "body": {
      "type": "string",
      "description": "The message you want to send"
    },
    "name": {
      "type": "string",
      "description": "The name of the user"
    }
  },
  "required": [
    "body",
    "name"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "TODO FAILS - ": "TODO",
    }

Hit

Hit
POST/v3/articles/{id}/hit

Example URI

POST /v3/articles/1910/hit
URI Parameters
HideShow
id
number (required) Example: 1910

The Id of the article

Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200

Resource Deals

Retrieve Deal
GET/v3/articles/{id}/deal?include={include}

Retrieves the deal for the given article for the currently logged-in user (requires user scope!). If no such deal exists, creates a new, blank one.

Example URI

GET /v3/articles/1910/deal?include=article,article.carrierPlan
URI Parameters
HideShow
id
number (required) Example: 1910

The Id of the article

include
string (optional) Example: article,article.carrierPlan

Receive additional information via includes. carrierPlan could be usefull for buyer_phone_required indicator in checkout.

Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Body
{
  "data": {
    "article_id": 5,
    "available_payment_methods": {
      "sofort": true,
      "creditcard": true,
      "paypal": false
    },
    "payment_method_identifier": "creditcard",
    "telephone": "0800 000 000",
    "billing_address": {
      "data": {
        "id": 1,
        "first_name": "John",
        "last_name": "Doe",
        "street_line_1": "Bar_Street_1",
        "house_number": "123A",
        "zip_code": "12345",
        "city": "Berlin",
        "country_code": "DE",
        "company_name": "Gebraucht",
        "created_at": "2017-01-01T00:00:00+0000",
        "updated_at": "2017-01-01T00:00:00+0000"
      }
    },
    "shipping_address": {
      "data": {
        "id": 1,
        "first_name": "John",
        "last_name": "Doe",
        "street_line_1": "Bar_Street_1",
        "house_number": "123A",
        "zip_code": "12345",
        "city": "Berlin",
        "country_code": "DE",
        "company_name": "Gebraucht",
        "created_at": "2017-01-01T00:00:00+0000",
        "updated_at": "2017-01-01T00:00:00+0000"
      }
    },
    "card": {
      "data": {
        "id": 5,
        "mangopay_card_internal_id": 8494514,
        "alias": "777010XXXXXX4412",
        "expiration": 1019,
        "provider": "VISA",
        "country": "DE",
        "currency": "EUR",
        "active": true,
        "valid": "UNKNOWN",
        "default": true,
        "created_at": "2017-01-01T00:00:00+0000"
      }
    },
    "article": "ARTICLE_OBJECT"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "article_id": {
          "type": "number"
        },
        "available_payment_methods": {
          "type": "object",
          "properties": {
            "sofort": {
              "type": "boolean"
            },
            "creditcard": {
              "type": "boolean"
            },
            "paypal": {
              "type": "boolean"
            }
          }
        },
        "payment_method_identifier": {
          "type": "string"
        },
        "telephone": {
          "type": "string"
        },
        "billing_address": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "first_name": {
                  "type": "string"
                },
                "last_name": {
                  "type": "string"
                },
                "street_line_1": {
                  "type": "string"
                },
                "house_number": {
                  "type": "string"
                },
                "zip_code": {
                  "type": "string"
                },
                "city": {
                  "type": "string"
                },
                "country_code": {
                  "type": "string"
                },
                "company_name": {
                  "type": "string"
                },
                "created_at": {
                  "type": "string"
                },
                "updated_at": {
                  "type": "string"
                }
              }
            }
          }
        },
        "shipping_address": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "first_name": {
                  "type": "string"
                },
                "last_name": {
                  "type": "string"
                },
                "street_line_1": {
                  "type": "string"
                },
                "house_number": {
                  "type": "string"
                },
                "zip_code": {
                  "type": "string"
                },
                "city": {
                  "type": "string"
                },
                "country_code": {
                  "type": "string"
                },
                "company_name": {
                  "type": "string"
                },
                "created_at": {
                  "type": "string"
                },
                "updated_at": {
                  "type": "string"
                }
              }
            }
          }
        },
        "card": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "mangopay_card_internal_id": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "expiration": {
                  "type": "number"
                },
                "provider": {
                  "type": "string"
                },
                "country": {
                  "type": "string"
                },
                "currency": {
                  "type": "string"
                },
                "active": {
                  "type": "boolean"
                },
                "valid": {
                  "type": "string"
                },
                "default": {
                  "type": "boolean"
                },
                "created_at": {
                  "type": "string"
                }
              }
            }
          }
        },
        "article": {
          "type": "string"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Update Deal
PUT/v3/articles/{id}/deal?include=

Retrieves the deal for the given article for the currently logged-in user (requires user scope!).

Example URI

PUT /v3/articles/1910/deal?include=
URI Parameters
HideShow
id
number (required) Example: 1910

The Id of the article

Request
HideShow
Headers
Authorization: Bearer <access_token>
Body
{
  "billing_address_id": 4,
  "shipping_address_id": 5,
  "payment_method_identifier": "null",
  "card_id": 7,
  "telephone": "0800 000 000"
}
Schema
{
  "type": "object",
  "properties": {
    "billing_address_id": {
      "type": "number",
      "description": "The address id of the desired billing address"
    },
    "shipping_address_id": {
      "type": "number",
      "description": "The address id of the desired shipping address"
    },
    "payment_method_identifier": {
      "type": "string",
      "description": "The payment method identifier"
    },
    "card_id": {
      "type": "number",
      "description": "The card id"
    },
    "telephone": {
      "type": "string",
      "description": "The phone number to be used for this deal / order"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Body
{
  "data": {
    "article_id": 5,
    "available_payment_methods": {
      "sofort": true,
      "creditcard": true,
      "paypal": false
    },
    "payment_method_identifier": "creditcard",
    "telephone": "0800 000 000",
    "billing_address": {
      "data": {
        "id": 1,
        "first_name": "John",
        "last_name": "Doe",
        "street_line_1": "Bar_Street_1",
        "house_number": "123A",
        "zip_code": "12345",
        "city": "Berlin",
        "country_code": "DE",
        "company_name": "Gebraucht",
        "created_at": "2017-01-01T00:00:00+0000",
        "updated_at": "2017-01-01T00:00:00+0000"
      }
    },
    "shipping_address": {
      "data": {
        "id": 1,
        "first_name": "John",
        "last_name": "Doe",
        "street_line_1": "Bar_Street_1",
        "house_number": "123A",
        "zip_code": "12345",
        "city": "Berlin",
        "country_code": "DE",
        "company_name": "Gebraucht",
        "created_at": "2017-01-01T00:00:00+0000",
        "updated_at": "2017-01-01T00:00:00+0000"
      }
    },
    "card": {
      "data": {
        "id": 5,
        "mangopay_card_internal_id": 8494514,
        "alias": "777010XXXXXX4412",
        "expiration": 1019,
        "provider": "VISA",
        "country": "DE",
        "currency": "EUR",
        "active": true,
        "valid": "UNKNOWN",
        "default": true,
        "created_at": "2017-01-01T00:00:00+0000"
      }
    },
    "article": "ARTICLE_OBJECT"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "article_id": {
          "type": "number"
        },
        "available_payment_methods": {
          "type": "object",
          "properties": {
            "sofort": {
              "type": "boolean"
            },
            "creditcard": {
              "type": "boolean"
            },
            "paypal": {
              "type": "boolean"
            }
          }
        },
        "payment_method_identifier": {
          "type": "string"
        },
        "telephone": {
          "type": "string"
        },
        "billing_address": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "first_name": {
                  "type": "string"
                },
                "last_name": {
                  "type": "string"
                },
                "street_line_1": {
                  "type": "string"
                },
                "house_number": {
                  "type": "string"
                },
                "zip_code": {
                  "type": "string"
                },
                "city": {
                  "type": "string"
                },
                "country_code": {
                  "type": "string"
                },
                "company_name": {
                  "type": "string"
                },
                "created_at": {
                  "type": "string"
                },
                "updated_at": {
                  "type": "string"
                }
              }
            }
          }
        },
        "shipping_address": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "first_name": {
                  "type": "string"
                },
                "last_name": {
                  "type": "string"
                },
                "street_line_1": {
                  "type": "string"
                },
                "house_number": {
                  "type": "string"
                },
                "zip_code": {
                  "type": "string"
                },
                "city": {
                  "type": "string"
                },
                "country_code": {
                  "type": "string"
                },
                "company_name": {
                  "type": "string"
                },
                "created_at": {
                  "type": "string"
                },
                "updated_at": {
                  "type": "string"
                }
              }
            }
          }
        },
        "card": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "mangopay_card_internal_id": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "expiration": {
                  "type": "number"
                },
                "provider": {
                  "type": "string"
                },
                "country": {
                  "type": "string"
                },
                "currency": {
                  "type": "string"
                },
                "active": {
                  "type": "boolean"
                },
                "valid": {
                  "type": "string"
                },
                "default": {
                  "type": "boolean"
                },
                "created_at": {
                  "type": "string"
                }
              }
            }
          }
        },
        "article": {
          "type": "string"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Checkout Fees Calculate
POST/v3/articles/{id}/checkout-fees

Calculate all fees before checkout

Example URI

POST /v3/articles/1910/checkout-fees
URI Parameters
HideShow
id
number (required) Example: 1910

The Id of the article

Request
HideShow
Body
+ Headers
           Authorization : Bearer <access_token>

+ Attributes
            + offer_amount: 2000 (integer, optional) - The offer amount if any
            + voucher_code: MAY1010 (string, optional) - the voucher code if any
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    data: {
        items: [
            {
                name: 'Product',
                type: 'ARTICLE_PRICE',
                amount: 5000,
                currency: 'EUR'
            },
            {
                name: 'Offered amount',
                type: 'OFFER_AMOUNT',
                amount: 4000,
                currency: 'EUR'
            },
            {
                name: 'Shipping',
                type: 'DELIVERY_FEE',
                amount: 500,
                currency: 'EUR'
            },
            {
                name: 'Discount',
                type: 'VOUCHER',
                code: 'A34Q89F00',
                amount: -1000,
                currency: 'EUR'
            }
        ]
    }
}

Store Fees Calculate
POST/v3/articles/store-fees

Calculate all fees before checkout

Example URI

POST /v3/articles/store-fees
URI Parameters
HideShow
id
number (required) Example: 1910

The Id of the article

Request
HideShow
Body
+ Headers
           Authorization : Bearer <access_token>

+ Attributes
            + price: 2000 (integer, required) - The article fee
            + currency: `EUR` (string, required) - amounts currency
            + carrier_plan_id: 22 (integer, required) - the carrier plan Id
            + voucher_code: MAY1010 (string, optional) - the voucher code if any
            + article_id: 22 (integer, optional) - article id if checking the available article
            + category_id: 4 (integer, optional) - category id
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "name": "Product",
      "type": "ARTICLE_PRICE",
      "amount": "30",
      "currency": "eur"
    },
    {
      "name": "Shipping",
      "type": "DELIVERY_FEE",
      "amount": 224,
      "currency": "eur"
    },
    {
      "name": "Service  fee",
      "type": "SERVICE_FEE",
      "amount": 3,
      "currency": "eur"
    },
    {
      "name": "May Discount",
      "type": "VOUCHER",
      "code": "May1010",
      "amount": -10,
      "currency": "eur"
    },
    {
      "name": "profit",
      "type": "PROFIT",
      "amount": 247,
      "currency": "eur"
    }
  ]
}

export user articles

export user articles
GET/v3/articles/export

Let the authenticated user export his own articles as csv file.

Example URI

GET /v3/articles/export
URI Parameters
HideShow
filter_status
string (optional) Example: active
Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: text/csv

BankAccounts

Show current bank account of the user

Show current bank account of the user
GET/v3/bankaccount

Example URI

GET /v3/bankaccount
Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Body
{
  "data": {
    "id": 1,
    "first_name": "John",
    "last_name": "Doe",
    "street_line_1": "Bar_Street_1",
    "house_number": "123A",
    "zip_code": "12345",
    "city": "Berlin",
    "country_code": "DE",
    "company_name": "Gebraucht",
    "iban": "DE123456789",
    "bic": "DEXXXBIC",
    "created_at": "2017-01-01T00:00:00+0000"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "street_line_1": {
          "type": "string"
        },
        "house_number": {
          "type": "string"
        },
        "zip_code": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "country_code": {
          "type": "string"
        },
        "company_name": {
          "type": "string"
        },
        "iban": {
          "type": "string"
        },
        "bic": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Create new bank account for the user that will automatically become the default one
POST/v3/bankaccount

Example URI

POST /v3/bankaccount
Request
HideShow
Headers
Authorization: Bearer <access_token>
Body
{
  "first_name": "John",
  "last_name": "Doe",
  "street_line_1": "Foo_Street_1",
  "house_number: Foo_Street_2": "Hello, world!",
  "zip_code": "12345",
  "city": "Berlin",
  "country_code": "DE",
  "company": "Gebraucht",
  "iban": "DE89370400440532013000",
  "bic": "COBADEFFXXX"
}
Schema
{
  "type": "object",
  "properties": {
    "first_name": {
      "type": "string",
      "description": "(required, string) the first name"
    },
    "last_name": {
      "type": "string",
      "description": "(required, string) the last name"
    },
    "street_line_1": {
      "type": "string",
      "description": "(required, string) street and number of the address"
    },
    "house_number: Foo_Street_2": {
      "type": "string",
      "description": "(not required, string) additional details"
    },
    "zip_code": {
      "type": "string",
      "description": "(required, string) ZIP code of the address."
    },
    "city": {
      "type": "string",
      "description": "(required, string) city if the address"
    },
    "country_code": {
      "type": "string",
      "description": "(required, string, size:2) Country of the address"
    },
    "company": {
      "type": "string",
      "description": "(not required, string) Company of the user address"
    },
    "iban": {
      "type": "string",
      "description": "(required, string) iban code in allcaps"
    },
    "bic": {
      "type": "string",
      "description": "(required, string) bic code in allcaps"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Body
{
  "data": {
    "id": 1,
    "first_name": "John",
    "last_name": "Doe",
    "street_line_1": "Bar_Street_1",
    "house_number": "123A",
    "zip_code": "12345",
    "city": "Berlin",
    "country_code": "DE",
    "company_name": "Gebraucht",
    "iban": "DE123456789",
    "bic": "DEXXXBIC",
    "created_at": "2017-01-01T00:00:00+0000"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "street_line_1": {
          "type": "string"
        },
        "house_number": {
          "type": "string"
        },
        "zip_code": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "country_code": {
          "type": "string"
        },
        "company_name": {
          "type": "string"
        },
        "iban": {
          "type": "string"
        },
        "bic": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Cars

Retrieve manufacturer names

Retrieve manufacturer names
GET/v3/car/manufacturers

Example URI

GET /v3/car/manufacturers
Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
          "Abarth",
          "AC",
          "Acura",
          "Aixam",
          "Alfa Romeo",
          "Alpina",
          "ARO",
          "Asia Motors",
          "Aston Martin",
          "Audi",
          "Austin",
          "Auto Union",
          "Autobianchi",
          "Barkas",
          "Bedford",
          "Bentley",
          "Bertone",
          "Bitter",
          "BMW",
          "Borgward",
          "Bugatti",
    }

Retrieve car models

Retrieve car models
GET/v3/car/models/{manufacturer}

Get all car models produced by the given manufacturer

Example URI

GET /v3/car/models/BMW
URI Parameters
HideShow
manufacturer
string (required) Example: BMW

name of the manufacturer.

Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 241,
      "manufacturer": "'BMW'",
      "model": "'02 Cabriolet'",
      "series": "'E10'",
      "produced_from": "'1967",
      "produced_to": "'1975"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    }
  }
}

Retrieve car types for a given model

Retrieve car types for a given model
GET/v3/car/cartypes/model/

Get all car type of the given car model.

Example URI

GET /v3/car/cartypes/model/
URI Parameters
HideShow
manufacturer
int (required) Example: 5

id of the model in our system.

Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 28,
      "type": "'1.3'",
      "power_kilowatt": 50,
      "power_horsepower": 68,
      "produced_from": "'1983",
      "produced_to": "'1989",
      "displacement": "1178",
      "carIdentifiers": {
        "data": {
          "id": 32169,
          "manufacturer_number_HSN": "\"4000\"",
          "model_number_TSN": "\"386\""
        }
      },
      "CarModelTransformer": {
        "data": {
          "id": 241,
          "manufacturer": "'BMW'",
          "model": "'02 Cabriolet'",
          "series": "'E10'",
          "produced_from": "'1967",
          "produced_to": "'1975"
        }
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    }
  }
}

Retrieve car types for given HSN/TSN

Retrieve car types for given HSN/TSN
GET/v3/car/cartypes/identifiers

Example URI

GET /v3/car/cartypes/identifiers
URI Parameters
HideShow
hsn_tsns: `0005_AOG,0005_ARM,9101_AFM`
string (required) 

list of HSN/TSN pairs.

Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 28,
      "type": "'1.3'",
      "power_kilowatt": 50,
      "power_horsepower": 68,
      "produced_from": "'1983",
      "produced_to": "'1989",
      "displacement": "1178",
      "carIdentifiers": {
        "data": {
          "id": 32169,
          "manufacturer_number_HSN": "\"4000\"",
          "model_number_TSN": "\"386\""
        }
      },
      "CarModelTransformer": {
        "data": {
          "id": 241,
          "manufacturer": "'BMW'",
          "model": "'02 Cabriolet'",
          "series": "'E10'",
          "produced_from": "'1967",
          "produced_to": "'1975"
        }
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    }
  }
}

Cards

Get all cards

Get all cards
GET/v3/cards

Returns all cards owned by an authenticated user.

Example URI

GET /v3/cards
Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 5,
      "mangopay_card_internal_id": 8494514,
      "alias": "777010XXXXXX4412",
      "expiration": 1019,
      "provider": "VISA",
      "country": "DE",
      "currency": "EUR",
      "active": true,
      "valid": "UNKNOWN",
      "default": true,
      "created_at": "2017-01-01T00:00:00+0000"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    }
  }
}

Create a new card

Create a new card
POST/v3/card

Example URI

POST /v3/card
Request
HideShow
Headers
Authorization: Bearer <access_token>
Body
{
  "mangopay_card_internal_id": 123456
}
Schema
{
  "type": "object",
  "properties": {
    "mangopay_card_internal_id": {
      "type": "number",
      "description": "(required, number, unique) the id returned from mango pay, when registering new card"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 5,
  "mangopay_card_internal_id": 8494514,
  "alias": "777010XXXXXX4412",
  "expiration": 1019,
  "provider": "VISA",
  "country": "DE",
  "currency": "EUR",
  "active": true,
  "valid": "UNKNOWN",
  "default": true,
  "created_at": "2017-01-01T00:00:00+0000"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "mangopay_card_internal_id": {
      "type": "number"
    },
    "alias": {
      "type": "string"
    },
    "expiration": {
      "type": "number"
    },
    "provider": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "currency": {
      "type": "string"
    },
    "active": {
      "type": "boolean"
    },
    "valid": {
      "type": "string"
    },
    "default": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string"
    }
  }
}

Remove a credit card

Remove a credit card
DELETE/v3/card/{id}

Example URI

DELETE /v3/card/5
URI Parameters
HideShow
id
number (required) Example: 5
Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  204

Register a card

Register a card
GET/v3/card/register

Used to get preregistration object that will be send to mango pay api

Example URI

GET /v3/card/register
Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "Id": 19592017,
    "CreationDate": 1483548733,
    "AccessKey": "1X0m87dmM2LiwFgxPLBJ",
    "PreregistrationData": "HBalUf7sKsj1NiktfVS7-_fpGvD68ghVo0hslbPVUpZLEUinGSpMiKdaE9xrYIcoS4wCy-yiraxeE65tmxOe8A",
    "CardRegistrationURL": "https://homologation-webpayment.payline.com/webpayment/getToken",
    "CardId": "null",
    "ResultCode": "null",
    "ResultMessage": "null",
    "Status": "CREATED"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "number"
        },
        "CreationDate": {
          "type": "number"
        },
        "AccessKey": {
          "type": "string"
        },
        "PreregistrationData": {
          "type": "string"
        },
        "CardRegistrationURL": {
          "type": "string"
        },
        "CardId": {
          "type": "string"
        },
        "ResultCode": {
          "type": "string"
        },
        "ResultMessage": {
          "type": "string"
        },
        "Status": {
          "type": "string"
        }
      }
    }
  }
}

Carrier Plans

Get all carrier plans with params

Get all carrier plans with params
GET/v3/carrierPlans?categoryId={categoryId}&sellerCountryCode={sellerCountryCode}&sellerPostCode={sellerPostCode}&minLength={minLength}&maxLength={maxLength}&minWidth={minWidth}&maxWidth={maxWidth}&minHeight={minHeight}&maxHeight={maxHeight}&minWeight={minWeight}&maxWeight={maxWeight}

Returns all carrier plans by an authenticated user.

Example URI

GET /v3/carrierPlans?categoryId=5&sellerCountryCode=de&sellerPostCode=10111&minLength=80&maxLength=90&minWidth=50&maxWidth=60&minHeight=40&maxHeight=50&minWeight=3&maxWeight=5
URI Parameters
HideShow
categoryId
number (required) Example: 5

article category id.

sellerCountryCode
string (required) Example: de

seller country code.

sellerPostCode
string (required) Example: 10111

seller post code.

minLength
number (required) Example: 80

article minimum length.

maxLength
number (required) Example: 90

article maximum length.

minWidth
number (required) Example: 50

article minimum width.

maxWidth
number (required) Example: 60

article maximum width.

minHeight
number (required) Example: 40

article minimum height.

maxHeight
number (required) Example: 50

article maximum height.

minWeight
number (required) Example: 3

article minimum weight.

maxWeight
number (required) Example: 5

article maximum weight.

Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 5,
      "title": "'DHL Paket XS'",
      "price": 3,
      "buyer_price": 3,
      "old_price": 5,
      "pickup_service: 'pickup_and_packaging'": "Hello, world!",
      "seller_phone_required": false,
      "buyer_phone_required": true,
      "icon": {
        "data": {
          "tiny": "\"http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png\"",
          "small": "\"http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png\"",
          "medium": "\"http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png\""
        }
      },
      "description": "Package weight shouldn't be more than 1 kg.",
      "info_link": "Link to more informations about carrier plan"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    }
  }
}

Get all carrier plans

Get all carrier plans
GET/v3/carrierPlans/all

Returns all carrier plans.

Example URI

GET /v3/carrierPlans/all
Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 5,
      "title": "'DHL Paket XS'",
      "price": 3,
      "buyer_price": 3,
      "old_price": 5,
      "pickup_service: 'pickup_and_packaging'": "Hello, world!",
      "seller_phone_required": false,
      "buyer_phone_required": true,
      "icon": {
        "data": {
          "tiny": "\"http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png\"",
          "small": "\"http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png\"",
          "medium": "\"http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png\""
        }
      },
      "description": "Package weight shouldn't be more than 1 kg.",
      "info_link": "Link to more informations about carrier plan"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json

Get all carrierPlans to change the carrier plan

Get all carrierPlans to change the carrier plan
GET/v3/arrierPlans/change-carrier-plans?categoryId={categoryId}&sellerCountryCode={sellerCountryCode}&sellerPostCode={sellerPostCode}&minLength={minLength}&maxLength={maxLength}&minWidth={minWidth}&maxWidth={maxWidth}&minHeight={minHeight}&maxHeight={maxHeight}&minWeight={minWeight}&maxWeight={maxWeight}

Returns all carrierPlans by an authenticated user.

Example URI

GET /v3/arrierPlans/change-carrier-plans?categoryId=5&sellerCountryCode=de&sellerPostCode=10111&minLength=80&maxLength=90&minWidth=50&maxWidth=60&minHeight=40&maxHeight=50&minWeight=3&maxWeight=5
URI Parameters
HideShow
categoryId
number (required) Example: 5

article category id.

sellerCountryCode
string (required) Example: de

seller country code.

sellerPostCode
string (required) Example: 10111

seller post code.

minLength
number (required) Example: 80

article minimum length.

maxLength
number (required) Example: 90

article maximum length.

minWidth
number (required) Example: 50

article minimum width.

maxWidth
number (required) Example: 60

article maximum width.

minHeight
number (required) Example: 40

article minimum height.

maxHeight
number (required) Example: 50

article maximum height.

minWeight
number (required) Example: 3

article minimum weight.

maxWeight
number (required) Example: 5

article maximum weight.

Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 5,
      "title": "'DHL Paket XS'",
      "price": 3,
      "buyer_price": 3,
      "old_price": 5,
      "pickup_service: 'pickup_and_packaging'": "Hello, world!",
      "seller_phone_required": false,
      "buyer_phone_required": true,
      "icon": {
        "data": {
          "tiny": "\"http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_50_50_0.png\"",
          "small": "\"http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_250_250_0.png\"",
          "medium": "\"http://local.gebraucht.de/uploads/thumbs/generated/default_userphoto_500_500_0.png\""
        }
      },
      "description": "Package weight shouldn't be more than 1 kg.",
      "info_link": "Link to more informations about carrier plan"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json

Get pickup time frames

Get pickup time frames
GET/v3/carrierPlans/{carrierPlanId}/pickup-timeframes?from={from}&to={to}

Returns all carrier plans by an authenticated user.

Example URI

GET /v3/carrierPlans/5/pickup-timeframes?from=2017-10-10 20:30:00&to=2017-10-15
URI Parameters
HideShow
carrierPlanId
number (required) Example: 5

carrier plan id.

from
datetime (required) Example: 2017-10-10 20:30:00

from date.

to
date (required) Example: 2017-10-15

to date.

Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "from": "1970-01-01 00:00:00",
      "to": "1970-01-01 00:00:00"
    },
    {
      "from": "2017-03-23 16:00:00",
      "to": "2017-03-23 18:00:00"
    },
    {
      "from": "2017-03-23 18:00:00",
      "to": "2017-03-23 19:00:00"
    },
    {
      "from": "2017-03-24 07:00:00",
      "to": "2017-03-24 08:00:00"
    },
    {
      "from": "2017-03-24 08:00:00",
      "to": "2017-03-24 10:00:00"
    },
    {
      "from": "2017-03-24 10:00:00",
      "to": "2017-03-24 12:00:00"
    },
    {
      "from": "2017-03-24 12:00:00",
      "to": "2017-03-24 14:00:00"
    },
    {
      "from": "2017-03-24 14:00:00",
      "to": "2017-03-24 16:00:00"
    },
    {
      "from": "2017-03-24 16:00:00",
      "to": "2017-03-24 18:00:00"
    },
    {
      "from": "2017-03-24 18:00:00",
      "to": "2017-03-24 19:00:00"
    }
  ]
}
Response  403
HideShow
Headers
Content-Type: application/json

Categories

Retreive Categories

Retreive Categories
GET/v3/categories

This request will give you a very big response, containing all of our category data and it’s relating filters as well as settings for the filter. Your application should cache this data and only reload it if neccessary. You can use the “category_version” hash from the /meta request to recognize if something changed within this data. The response of the data field is an array where every element contains one single category and its settings. The categories relate to each other based on the “parent_id” field as well as the “lft” and “rgt” nested set information (https://en.wikipedia.org/wiki/Nested_set_model). To sort the categories correctly please use the data from the “lft” / “rgt” fields.

Categorie parameters:

  • depth: level of depth within the category tree

  • title: display name of the category

  • key: identifier key for the category that is not unique overall all categories but unique within one category path

  • url_path: path if you want to link to category in the web

  • show_at_main_navigation: only applicable for the first level category navigation. Indicating if the category should be listed on a navigation that shows all main categories as entrance to search through them.

Filters parameters

The filter parameter holds an array of related filters and it’s setting options. If you work with the category and filter data you need to apply the filters of all parent categories of a category to the child category. In practice this means that the Child (category 2) of category 1 should also have the filters of it’s parent, and so on. If the child has a filter with the same value on the “url_key” parameter as it’s parent, the filter of the child should be considered and overwrite the filter of the parent.

  • value_select: Display name to show if you display the filter as option to filter search results

  • value_form: Display name to show if you display the filter as option to apply to an item within a form

  • value_details: Display name to show if you display the filter as

  • type_form: “radio” or “checkbox” => defines if the filter behaves like a radiobutton (single value) or checkbox (multiple values possible) on the item creation form.

  • type_select: “radio” or “checkbox” => defines if the filter behaves like a radiobutton (single value) or checkbox (multiple values possible) on the search filter form.

  • show_at_select: show the filter at the search filter form?

  • show_at_form: show the filter at the item creation form?

  • show_at_details: show the filter at the item details page?

  • show_at_form_if_filtersetting: If this is set, the filter should only be shown within the item creation process. The value will be a ID of a filter setting that needs to be active. (not used yet => not for MVP!)

  • show_at_head: show the filter and it’s setting on the top of the search results as “active” filter attribute if set?

  • template_select: template that should be used within the search filter forms (can be: list, list_search, grid)

  • template_form: template that should be used on the item creation process (can be: list, list_search, grid)

  • template_detail: template to use on the item details page (not used yed => not for MVP!)

  • individual_values: true/false if individual values are possible to create within the item creation process

  • min_setting_count: minimum number of settings that need to be selected within the item creation process

  • max_setting_count: maximum number of settings that need to be selected within the item creation process

  • show_at_sidebar: filter should be shown on sidebar

  • show_at_sidebar_additional: filter should be shown on sidebar but only actionable after action from user

Filter settings parameters This data represents all possible values for the filter / attribute.

  • id: unique id of the setting

  • filter_id: id of the filter the setting belongs to

  • value_key: identifier key for the setting, it is unique within the array of settings for a filter but not unique overall settings

  • value_select: display name of the setting for the search filter forms

  • value_description: description that should be displayed with the display name (not specified for select, form, detail view)

  • value_form: display name of the setting for the create item process

  • value_details: display name for the item detail pages

  • position: number to sort by ASC

  • is_individual_value: indicates if the setting is a custom one (we don’t send you custom settings on this request but it could happen if you get filter settings related to a article)

If the category has had some icon (svg and png) uploaded then they will be displayed here under the photo_icons key. if the category only has 3 icons uploaded, the array will be padded to 10 with custom + icons.

"photo_icons": {
        "data": [
          {
            "id": 5,
            "key": "oval",
            "label": "Oval",
            "svg": "https://local.gebraucht.de/uploads/assets/1/oval.svg",
            "checksum": "ef9b54cf11b72123c2fb1bd1bd75a0d7",
            "@2x": "https://local.gebraucht.de/uploads/assets/1/[email protected]",
            "@3x": "https://local.gebraucht.de/uploads/assets/1/[email protected]"
          },
          {
            "id": 2,
            "key": "wool_1",
            "label": "Wool_1",
            "svg": "https://local.gebraucht.de/uploads/assets/1/wool_1.svg",
            "checksum": "c76446537473aec9f15cb78407eaa805",
            "@2x": "https://local.gebraucht.de/uploads/assets/1/[email protected]",
            "@3x": "https://local.gebraucht.de/uploads/assets/1/[email protected]"
          },
          {
            "id": 1,
            "key": "wool",
            "label": "Wool",
            "svg": "https://local.gebraucht.de/uploads/assets/1/wool.svg",
            "checksum": "c76446537473aec9f15cb78407eaa805",
            "@2x": "https://local.gebraucht.de/uploads/assets/1/[email protected]",
            "@3x": "https://local.gebraucht.de/uploads/assets/1/[email protected]"
          },
          {
            "id": null,
            "key": "custom 4",
            "svg": "http://local.gebraucht.de/img/categories/plus.svg",
            "checksum": "a1a005fd5dc058ce017eec242854c0e4",
            "@2x": "http://local.gebraucht.de/img/categories/[email protected]",
            "@3x": "http://local.gebraucht.de/img/categories/[email protected]"
          },
          {
            "id": null,
            "key": "custom 5",
            "svg": "http://local.gebraucht.de/img/categories/plus.svg",
            "checksum": "a1a005fd5dc058ce017eec242854c0e4",
            "@2x": "http://local.gebraucht.de/img/categories/[email protected]",
            "@3x": "http://local.gebraucht.de/img/categories/[email protected]"
          },
          {
            "id": null,
            "key": "custom 6",
            "svg": "http://local.gebraucht.de/img/categories/plus.svg",
            "checksum": "a1a005fd5dc058ce017eec242854c0e4",
            "@2x": "http://local.gebraucht.de/img/categories/[email protected]",
            "@3x": "http://local.gebraucht.de/img/categories/[email protected]"
          },
          {
            "id": null,
            "key": "custom 7",
            "svg": "http://local.gebraucht.de/img/categories/plus.svg",
            "checksum": "a1a005fd5dc058ce017eec242854c0e4",
            "@2x": "http://local.gebraucht.de/img/categories/[email protected]",
            "@3x": "http://local.gebraucht.de/img/categories/[email protected]"
          },
          {
            "id": null,
            "key": "custom 8",
            "svg": "http://local.gebraucht.de/img/categories/plus.svg",
            "checksum": "a1a005fd5dc058ce017eec242854c0e4",
            "@2x": "http://local.gebraucht.de/img/categories/[email protected]",
            "@3x": "http://local.gebraucht.de/img/categories/[email protected]"
          },
          {
            "id": null,
            "key": "custom 9",
            "svg": "http://local.gebraucht.de/img/categories/plus.svg",
            "checksum": "a1a005fd5dc058ce017eec242854c0e4",
            "@2x": "http://local.gebraucht.de/img/categories/[email protected]",
            "@3x": "http://local.gebraucht.de/img/categories/[email protected]"
          },
          {
            "id": null,
            "key": "custom 10",
            "svg": "http://local.gebraucht.de/img/categories/plus.svg",
            "checksum": "a1a005fd5dc058ce017eec242854c0e4",
            "@2x": "http://local.gebraucht.de/img/categories/[email protected]",
            "@3x": "http://local.gebraucht.de/img/categories/[email protected]"
          }

        ]
      },

Example URI

GET /v3/categories
Request
HideShow
Headers
Authorization: Bearer <access_token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "parent_id": null,
      "lft": 1,
      "rgt": 3822,
      "depth": 0,
      "title": "Marktplatz",
      "key": "",
      "url_path": "",
      "required_photos": 1,
      "requires_exact_weight": false,
      "requires_exact_size": false,
      "show_at_main_navigation": false,
      "managed_logistic_option": "mlo_only_delivery",
      "transaction_type": "managed",
      "filters": {
        "data": [
          {
            "id": 30,
            "key": "paymentmethod",
            "position": 600,
            "value_select": "Zahlungsmethode",
            "value_form": "Zahlungsmethode",
            "value_details": "Zahlungsmethode",
            "required": false,
            "type_form": "radio",
            "type_select": "radio",
            "show_at_select": true,
            "show_at_form": false,
            "show_at_details": false,
            "show_at_form_if_filtersetting": "NULL",
            "show_at_head": false,
            "show_at_itemlist": false,
            "show_at_itemlist_format": null,
            "template_select": "list_search",
            "template_form": "list_search",
            "template_detail": null,
            "individual_values": false,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": [
                {
                  "id": 354,
                  "filter_id": 30,
                  "filter_key": "paymentmethod",
                  "value_key": "paypal",
                  "value_select": "Paypal",
                  "value_description": "NULL",
                  "value_form": "Paypal",
                  "value_details": "Paypal",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                }
              ]
            }
          },
          {
            "id": 3,
            "key": "zustand",
            "position": 700,
            "value_select": "Zustand",
            "value_form": "Zustand",
            "value_details": "Zustand",
            "required": true,
            "type_form": "select",
            "type_select": "checkbox",
            "show_at_select": true,
            "show_at_form": true,
            "show_at_details": true,
            "show_at_form_if_filtersetting": "NULL",
            "show_at_head": true,
            "show_at_itemlist": false,
            "show_at_itemlist_format": null,
            "template_select": "list",
            "template_form": "list",
            "template_detail": null,
            "individual_values": false,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": [
                {
                  "id": 5,
                  "filter_id": 3,
                  "filter_key": "zustand",
                  "value_key": "as-new",
                  "value_select": "Wie neu",
                  "value_description": "Der Artikel ist neuwertig und weist keinerlei Gebrauchsspuren auf.",
                  "value_form": "Wie neu",
                  "value_details": "Wie neu",
                  "position": 1,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 11,
                  "filter_id": 3,
                  "filter_key": "zustand",
                  "value_key": "very-good",
                  "value_select": "Sehr gut",
                  "value_description": "Der Artikel hat nur wenige leichte Gebrauchsspuren und ist in einem sehr gepflegten Zustand.",
                  "value_form": "Sehr gut",
                  "value_details": "Sehr gut",
                  "position": 2,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 364,
                  "filter_id": 3,
                  "filter_key": "zustand",
                  "value_key": "good",
                  "value_select": "Gut",
                  "value_description": "Der Artikel hat einige offensichtliche Gebrauchsspuren, z.B. deutliche Kratzer oder kleine Beschädigungen.",
                  "value_form": "Gut",
                  "value_details": "Gut",
                  "position": 3,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 8,
                  "filter_id": 3,
                  "filter_key": "zustand",
                  "value_key": "acceptable",
                  "value_select": "Akzeptabel",
                  "value_description": "Der Artikel hat starke Gebrauchsspuren oder sogar Schäden, wie Brüche oder mehrere tiefe Kratzer oder starke Verschmutzung.",
                  "value_form": "Akzeptabel",
                  "value_details": "Akzeptabel",
                  "position": 4,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 9,
                  "filter_id": 3,
                  "filter_key": "zustand",
                  "value_key": "broken",
                  "value_select": "Defekt",
                  "value_description": "Der Artikel erfüllt seine Funktionsweise nicht mehr.",
                  "value_form": "Defekt",
                  "value_details": "Defekt",
                  "position": 5,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                }
              ]
            }
          },
          {
            "id": 4,
            "key": "merchant",
            "position": 1000,
            "value_select": "Anbieter",
            "value_form": "Händleranzeige",
            "value_details": "Händleranzeige",
            "required": false,
            "type_form": "select",
            "type_select": "radio",
            "show_at_select": false,
            "show_at_form": false,
            "show_at_details": false,
            "show_at_form_if_filtersetting": "NULL",
            "show_at_head": false,
            "show_at_itemlist": false,
            "show_at_itemlist_format": "NULL",
            "template_select": "list",
            "template_form": "list",
            "template_detail": null,
            "individual_values": false,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": [
                {
                  "id": 12,
                  "filter_id": 4,
                  "filter_key": "merchant",
                  "value_key": "0",
                  "value_select": "Privat",
                  "value_description": "NULL",
                  "value_form": "Nein, Privatanzeige",
                  "value_details": "Nein",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 13,
                  "filter_id": 4,
                  "filter_key": "merchant",
                  "value_key": "1",
                  "value_select": "Händler",
                  "value_description": "NULL",
                  "value_form": "Ja (inkl. Impressum & Widerrufsbelehrung)",
                  "value_details": "Ja",
                  "position": 1,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                }
              ]
            }
          },
          {
            "id": 32,
            "key": "collection",
            "position": 1000,
            "value_select": "Collection",
            "value_form": "Collection",
            "value_details": "Collection",
            "required": false,
            "type_form": "checkbox",
            "type_select": "checkbox",
            "show_at_select": false,
            "show_at_form": false,
            "show_at_details": false,
            "show_at_form_if_filtersetting": "NULL",
            "show_at_head": false,
            "show_at_itemlist": false,
            "show_at_itemlist_format": null,
            "template_select": "list",
            "template_form": "list",
            "template_detail": null,
            "individual_values": false,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": [
                {
                  "id": 366,
                  "filter_id": 32,
                  "filter_key": "collection",
                  "value_key": "popular",
                  "value_select": "Beliebt",
                  "value_description": "NULL",
                  "value_form": "Beliebt",
                  "value_details": "Beliebt",
                  "position": 1000,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 367,
                  "filter_id": 32,
                  "filter_key": "collection",
                  "value_key": "recommended",
                  "value_select": "Empfohlen",
                  "value_description": "NULL",
                  "value_form": "Empfohlen",
                  "value_details": "Empfohlen",
                  "position": 1000,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 365,
                  "filter_id": 32,
                  "filter_key": "collection",
                  "value_key": "selected_by_us",
                  "value_select": "Von uns ausgewählt",
                  "value_description": "NULL",
                  "value_form": "Von uns ausgewählt",
                  "value_details": "Von uns ausgewählt",
                  "position": 1000,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                }
              ]
            }
          },
          {
            "id": 33,
            "key": "price",
            "position": 1000,
            "value_select": "Preis",
            "value_form": "Preis",
            "value_details": "Preis",
            "required": false,
            "type_form": "radio",
            "type_select": "checkbox",
            "show_at_select": false,
            "show_at_form": false,
            "show_at_details": false,
            "show_at_form_if_filtersetting": null,
            "show_at_head": false,
            "show_at_itemlist": false,
            "show_at_itemlist_format": "",
            "template_select": "list",
            "template_form": "list",
            "template_detail": "",
            "individual_values": true,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": []
            }
          },
          {
            "id": 1,
            "key": "transport",
            "position": 1000,
            "value_select": "Transport",
            "value_form": "Transport",
            "value_details": "Transport",
            "required": true,
            "type_form": "checkbox",
            "type_select": "radio",
            "show_at_select": true,
            "show_at_form": true,
            "show_at_details": true,
            "show_at_form_if_filtersetting": "NULL",
            "show_at_head": true,
            "show_at_itemlist": false,
            "show_at_itemlist_format": null,
            "template_select": "list",
            "template_form": "transport_inline",
            "template_detail": null,
            "individual_values": false,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": [
                {
                  "id": 2,
                  "filter_id": 1,
                  "filter_key": "transport",
                  "value_key": "versand",
                  "value_select": "Versand",
                  "value_description": "NULL",
                  "value_form": "Versand",
                  "value_details": "Versand",
                  "position": 1,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 1,
                  "filter_id": 1,
                  "filter_key": "transport",
                  "value_key": "abholung",
                  "value_select": "Abholung",
                  "value_description": "NULL",
                  "value_form": "Abholung",
                  "value_details": "Abholung",
                  "position": 2,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                }
              ]
            }
          }
        ]
      },
      "photo_icons": {
        "data": [
          {
            "id": 1,
            "label": "Front",
            "key": "front",
            "display_order": 1,
            "category_id": 1,
            "svg": "https://abc:[email protected]/uploads/assets/1/front.svg",
            "checksum": "abc20e44776e3d3783812bdb300b5614",
            "@2x": "https://abc:[email protected]/uploads/assets/1/[email protected]?abc20e44776e3d3783812bdb300b5614",
            "@3x": "https://abc:[email protected]/uploads/assets/1/[email protected]?abc20e44776e3d3783812bdb300b5614"
          },
          {
            "id": null,
            "label": null,
            "key": "custom1",
            "display_order": 2,
            "category_id": 1,
            "svg": "http://abc:[email protected]/img/categories/plus.svg",
            "checksum": "a1a005fd5dc058ce017eec242854c0e5",
            "@2x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5",
            "@3x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5"
          },
          {
            "id": null,
            "label": null,
            "key": "custom2",
            "display_order": 3,
            "category_id": 1,
            "svg": "http://abc:[email protected]/img/categories/plus.svg",
            "checksum": "a1a005fd5dc058ce017eec242854c0e5",
            "@2x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5",
            "@3x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5"
          },
          {
            "id": null,
            "label": null,
            "key": "custom3",
            "display_order": 4,
            "category_id": 1,
            "svg": "http://abc:[email protected]/img/categories/plus.svg",
            "checksum": "a1a005fd5dc058ce017eec242854c0e5",
            "@2x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5",
            "@3x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5"
          },
          {
            "id": null,
            "label": null,
            "key": "custom4",
            "display_order": 5,
            "category_id": 1,
            "svg": "http://abc:[email protected]/img/categories/plus.svg",
            "checksum": "a1a005fd5dc058ce017eec242854c0e5",
            "@2x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5",
            "@3x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5"
          },
          {
            "id": null,
            "label": null,
            "key": "custom5",
            "display_order": 6,
            "category_id": 1,
            "svg": "http://abc:[email protected]/img/categories/plus.svg",
            "checksum": "a1a005fd5dc058ce017eec242854c0e5",
            "@2x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5",
            "@3x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5"
          },
          {
            "id": null,
            "label": null,
            "key": "custom6",
            "display_order": 7,
            "category_id": 1,
            "svg": "http://abc:[email protected]/img/categories/plus.svg",
            "checksum": "a1a005fd5dc058ce017eec242854c0e5",
            "@2x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5",
            "@3x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5"
          },
          {
            "id": null,
            "label": null,
            "key": "custom7",
            "display_order": 8,
            "category_id": 1,
            "svg": "http://abc:[email protected]/img/categories/plus.svg",
            "checksum": "a1a005fd5dc058ce017eec242854c0e5",
            "@2x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5",
            "@3x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5"
          },
          {
            "id": null,
            "label": null,
            "key": "custom8",
            "display_order": 9,
            "category_id": 1,
            "svg": "http://abc:[email protected]/img/categories/plus.svg",
            "checksum": "a1a005fd5dc058ce017eec242854c0e5",
            "@2x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5",
            "@3x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5"
          },
          {
            "id": null,
            "label": null,
            "key": "custom9",
            "display_order": 10,
            "category_id": 1,
            "svg": "http://abc:[email protected]/img/categories/plus.svg",
            "checksum": "a1a005fd5dc058ce017eec242854c0e5",
            "@2x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5",
            "@3x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5"
          },
          {
            "id": null,
            "label": null,
            "key": "custom10",
            "display_order": 11,
            "category_id": 1,
            "svg": "http://abc:[email protected]/img/categories/plus.svg",
            "checksum": "a1a005fd5dc058ce017eec242854c0e5",
            "@2x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5",
            "@3x": "http://abc:[email protected]/img/categories/[email protected]?a1a005fd5dc058ce017eec242854c0e5"
          }
        ]
      }
    },
    {
      "id": 4,
      "parent_id": 1,
      "lft": 2,
      "rgt": 1387,
      "depth": 1,
      "title": "Elektronik & Multimedia",
      "key": "multimedia_elektronik",
      "url_path": "multimedia_elektronik",
      "required_photos": 1,
      "requires_exact_weight": false,
      "requires_exact_size": false,
      "show_at_main_navigation": true,
      "filters": {
        "data": [
          {
            "id": 28,
            "key": "marke",
            "position": 1000,
            "value_select": "Marke",
            "value_form": "Marke",
            "value_details": "Marke",
            "required": false,
            "type_form": "select",
            "type_select": "checkbox",
            "show_at_select": true,
            "show_at_form": true,
            "show_at_details": true,
            "show_at_form_if_filtersetting": "NULL",
            "show_at_head": true,
            "show_at_itemlist": true,
            "show_at_itemlist_format": null,
            "template_select": "list_search",
            "template_form": "list_search",
            "template_detail": null,
            "individual_values": false,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": [
                {
                  "id": 256,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "apple",
                  "value_select": "Apple",
                  "value_description": "NULL",
                  "value_form": "Apple",
                  "value_details": "Apple",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 284,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "behringer",
                  "value_select": "Behringer",
                  "value_description": "NULL",
                  "value_form": "Behringer",
                  "value_details": "Behringer",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 273,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "bosch",
                  "value_select": "Bosch",
                  "value_description": "NULL",
                  "value_form": "Bosch",
                  "value_details": "Bosch",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 260,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "bose",
                  "value_select": "Bose",
                  "value_description": "NULL",
                  "value_form": "Bose",
                  "value_details": "Bose",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 267,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "canon",
                  "value_select": "Canon",
                  "value_description": "NULL",
                  "value_form": "Canon",
                  "value_details": "Canon",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 282,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "canton",
                  "value_select": "Canton",
                  "value_description": "NULL",
                  "value_form": "Canton",
                  "value_details": "Canton",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 270,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "delonghi",
                  "value_select": "Delonghi",
                  "value_description": "NULL",
                  "value_form": "Delonghi",
                  "value_details": "Delonghi",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 276,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "dji",
                  "value_select": "DJI",
                  "value_description": "NULL",
                  "value_form": "DJI",
                  "value_details": "DJI",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 280,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "epson",
                  "value_select": "Epson",
                  "value_description": "NULL",
                  "value_form": "Epson",
                  "value_details": "Epson",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 269,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "gopro",
                  "value_select": "GoPro",
                  "value_description": "NULL",
                  "value_form": "GoPro",
                  "value_details": "GoPro",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 264,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "grundig",
                  "value_select": "Grundig",
                  "value_description": "NULL",
                  "value_form": "Grundig",
                  "value_details": "Grundig",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 281,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "heco",
                  "value_select": "Heco",
                  "value_description": "NULL",
                  "value_form": "Heco",
                  "value_details": "Heco",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 259,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "hp",
                  "value_select": "HP",
                  "value_description": "NULL",
                  "value_form": "HP",
                  "value_details": "HP",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 258,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "htc",
                  "value_select": "HTC",
                  "value_description": "NULL",
                  "value_form": "HTC",
                  "value_details": "HTC",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 283,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "huawei",
                  "value_select": "Huawei",
                  "value_description": "NULL",
                  "value_form": "Huawei",
                  "value_details": "Huawei",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 279,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "intel",
                  "value_select": "Intel",
                  "value_description": "NULL",
                  "value_form": "Intel",
                  "value_details": "Intel",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 271,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "jbl",
                  "value_select": "JBL",
                  "value_description": "NULL",
                  "value_form": "JBL",
                  "value_details": "JBL",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 278,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "lenovo",
                  "value_select": "Lenovo",
                  "value_description": "NULL",
                  "value_form": "Lenovo",
                  "value_details": "Lenovo",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 277,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "logitech",
                  "value_select": "Logitech",
                  "value_description": "NULL",
                  "value_form": "Logitech",
                  "value_details": "Logitech",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 274,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "makita",
                  "value_select": "Makita",
                  "value_description": "NULL",
                  "value_form": "Makita",
                  "value_details": "Makita",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 265,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "microsoft",
                  "value_select": "Microsoft",
                  "value_description": "NULL",
                  "value_form": "Microsoft",
                  "value_details": "Microsoft",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 268,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "nikon",
                  "value_select": "Nikon",
                  "value_description": "NULL",
                  "value_form": "Nikon",
                  "value_details": "Nikon",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 266,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "nintendo",
                  "value_select": "Nintendo",
                  "value_description": "NULL",
                  "value_form": "Nintendo",
                  "value_details": "Nintendo",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 263,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "philips",
                  "value_select": "Philips",
                  "value_description": "NULL",
                  "value_form": "Philips",
                  "value_details": "Philips",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 257,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "samsung",
                  "value_select": "Samsung",
                  "value_description": "NULL",
                  "value_form": "Samsung",
                  "value_details": "Samsung",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 275,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "siemens",
                  "value_select": "Siemens",
                  "value_description": "NULL",
                  "value_form": "Siemens",
                  "value_details": "Siemens",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 272,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "sonos",
                  "value_select": "Sonos",
                  "value_description": "NULL",
                  "value_form": "Sonos",
                  "value_details": "Sonos",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 262,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "sony",
                  "value_select": "Sony",
                  "value_description": "NULL",
                  "value_form": "Sony",
                  "value_details": "Sony",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 261,
                  "filter_id": 28,
                  "filter_key": "marke",
                  "value_key": "toshiba",
                  "value_select": "Toshiba",
                  "value_description": "NULL",
                  "value_form": "Toshiba",
                  "value_details": "Toshiba",
                  "position": 0,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                }
              ]
            }
          }
        ]
      },
      "photo_icons": {
        "data": []
      }
    },
    {
      "id": 12,
      "parent_id": 4,
      "lft": 3,
      "rgt": 290,
      "depth": 2,
      "title": "Smartphones & Zubehör",
      "key": "telefone-und-smartphones",
      "url_path": "multimedia_elektronik/telefone-und-smartphones",
      "required_photos": 1,
      "requires_exact_weight": false,
      "requires_exact_size": false,
      "show_at_main_navigation": null,
      "filters": {
        "data": [
          {
            "id": 31,
            "key": "speicher",
            "position": 1000,
            "value_select": "Speicher",
            "value_form": "Speicher",
            "value_details": "Speicher",
            "required": false,
            "type_form": "select",
            "type_select": "checkbox",
            "show_at_select": true,
            "show_at_form": true,
            "show_at_details": true,
            "show_at_form_if_filtersetting": "NULL",
            "show_at_head": true,
            "show_at_itemlist": true,
            "show_at_itemlist_format": null,
            "template_select": "list",
            "template_form": "list",
            "template_detail": null,
            "individual_values": false,
            "min_setting_count": 0,
            "max_setting_count": 0,
            "settings": {
              "data": [
                {
                  "id": 355,
                  "filter_id": 31,
                  "filter_key": "speicher",
                  "value_key": "1gb",
                  "value_select": "1GB",
                  "value_description": "NULL",
                  "value_form": "1GB",
                  "value_details": "1GB",
                  "position": 1,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 356,
                  "filter_id": 31,
                  "filter_key": "speicher",
                  "value_key": "2gb",
                  "value_select": "2GB",
                  "value_description": "NULL",
                  "value_form": "2GB",
                  "value_details": "2GB",
                  "position": 2,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 357,
                  "filter_id": 31,
                  "filter_key": "speicher",
                  "value_key": "4gb",
                  "value_select": "4GB",
                  "value_description": "NULL",
                  "value_form": "4GB",
                  "value_details": "4GB",
                  "position": 4,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 358,
                  "filter_id": 31,
                  "filter_key": "speicher",
                  "value_key": "8gb",
                  "value_select": "8GB",
                  "value_description": "NULL",
                  "value_form": "8GB",
                  "value_details": "8GB",
                  "position": 8,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 359,
                  "filter_id": 31,
                  "filter_key": "speicher",
                  "value_key": "16gb",
                  "value_select": "16GB",
                  "value_description": "NULL",
                  "value_form": "16GB",
                  "value_details": "16GB",
                  "position": 16,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum": ""
                },
                {
                  "id": 360,
                  "filter_id": 31,
                  "filter_key": "speicher",
                  "value_key": "32gb",
                  "value_select": "32GB",
                  "value_description": "NULL",
                  "value_form": "32GB",
                  "value_details": "32GB",
                  "position": 32,
                  "is_individual_value": false,
                  "active_icon": null,
                  "active_checksum": "",
                  "inactive_icon": null,
                  "inactive_checksum":