/api

Single entry point for accessing the Content API, protected by a JWT ID token.

get

Response might contain following rels:

  • self - Self relation of the resource
  • articles - Here, one can find the article search resource
  • article-by-id - If one has an article ID, one can choose this relation to go to the article detail resource
  • business-shops - Relation for the BusinessShops resource

/api/articles

Collection resource for articles. You can (amongst other things) specify search queries to refine the collection. You can also handle specific articles.

get

Searches for articles.
To search and filter for specific articles, use query parameters.

Response:
A collection of articles matching the specified query parameters. Also contains facet information including links for each bucket by applying the corresponding filter. If a facet only has one bucket, the link is not returned.

Response might contain following rels:

  • self - Self relation of the resource.
  • next - links to the next slice of articles, if there is one.
  • prev - links to the previous slice of articles, if there is one. Keep in mind that the offset can not go under 0.
  • first - links to the first slice of the collection.
  • last - links to the last slice, if the last slice is within the limits.

The hit members of the collection might contain the following rels:

  • details - links to the article detail resource.
  • business-shop - The BusinessShop where the hit comes from.

The facet and bucket members of the collection might contain the following rels:

  • apply-filter Links to the same search resource, with the applied filter. Facets and buckets will reflect the options available for further narrowing down the current search result, hence there will only be buckets for values actually present in the current search result.
get

Detailed view of one article. Response might contain following rels:

/api/business-shops

Collection resource for BusinessShops. You can (among others) get a collection of all booked BusinessShops. Also you can see specific ones.

get

Returns a list of all available BusinessShops with a link to the detailed meta information. Response might contain following rels:

  • self - Self relation of the resource
  • next - links to the next page, if there is one.
  • prev - links to the previous page, if there is one. Keep in mind, that the offset can not go under 0.
  • first - links to the previous page of the collection.
  • last - links to the last page, if the last page is in the limits.

Delivers information about the BusinessShop specified via {businessShopId}-parameter.

get

Return all information about the desired BusinessShop, including the URL to the BusinessShop logo.

Response might contain following rels:

  • self - Self relation of the resource.

/api/return-policies/{policyId}

Return policies are referenced by articles.

get

Response might contain following rels:

  • self - Self relation of the resource.

/api/shipping-costs/{shippingCostsId}

Shipping costs are referenced by articles. All articles which link to the same shipping cost are applied to its scale. The same shipping cost is only paid once.

get

Response might contain following rels:

  • self - Self relation of the resource.

/api/minimum-order-values/{minimumOrderValueId}

Minimum order values are referenced by articles. All articles linking to the same minimum order value are applied to its boundary.

get

Response might contain following rels:

  • self - Self relation of the resource