ShopRpc

Get a Weclapp article by its article number.

get/api/grpc-json/v1/shop/articles/{articleNumber}

Request

  • Base URL: https://localhost:5001
  • URL: https://localhost:5001/api/grpc-json/v1/shop/articles/{articleNumber}
  • Auth: none declared

Path parameters

articleNumberstring required

Article number.

Headers

X-Sportident-Client-Idstring

Client identifier to determine the source of a request.

Response

Success

articleNumberstring

Required. Article number.

namestring

Required. Article name.

descriptionstring

Optional. Article description.

productTypestring

Optional. Product type. Currently only set for a couple of products that require special handling (e.g. 'Card', 'CardService' and 'Strap').

propertiesobject

Article properties as key-value pairs. Empty for most articles, except for cards and straps. Example for productType 'card': { cardType: "siac1", tipProductOptionName: "White", tipProductOptionFileName: "tip_siac_logo_white.png", bodyProductOptionName: "Red", bodyProductOptionFileName: "body_siac_red.png" }

selectableAsSubitemOnlyboolean

Some articles can only be selected as a sub item that is part of a sales bill of materials. These articles must not be listed as main articles in the frontend.

isAvailableboolean

The availability of articles is determined by the Weclapp custom field NEPTUNE_AVAILABILITY. Articles may or may not be available depending on the user's role (i.e. some articles are made only available for SPORTident employees or partners).

minimumQuantityinteger

Minimum quantity. Value is 1 for all articles, except for articles that can only be ordered in bulk.

hasFixedQuantityOneboolean

Some articles have a fixed quantity of one. Specifically, article 21410 "SIAC Battery Exchange" can only be ordered with quantity 1, because a card number needs to be specified for each exchanged SIAC. Same goes for the articles 10301 and 10504 (SI-Card9 and SIAC with personal number).

Changes

No recorded changes to this operation across all 1 revision of this API.