URI /customers/<customer-id> Http Method GET Short Description Retrieves and returns details about a customer to the client. Query Parameters Example Requests B2C: /customers/k0gKDgAhjjkAAAFb1lFRYKTC B2B: /customers/F3MKDgAhh2MAAAFbMVlRYKTC;UserID=sA4KDgAhXV0AAAFb9FhRYKTC HTTP Status Codes 200 OK 401
A28246 • 23-Jun-2020 • References
URI /orders/<order-id>/documents/<document-id> Http Method GET Short Description Provides an information for a given order document. Query Parameters none Example Requests /orders/y.UKDACPMIQAAAFYFlQGqAA1/documents/k%3D10461170bff6fdf19839458e596bb7ddeae8eddbfb8b797e2f1073935c90614e4bb4be53975de524
2P8197 • 04-Oct-2021 • References
URI /orders/<order-id>/documents/ Http Method GET Short Description Returns a list of links to order's documents resources Query Parameters none Example Requests /orders/y.UKDACPMIQAAAFYFlQGqAA1/documents/ HTTP Status Codes 200 OK 403 Forbidden Description List links to all order's documents resources
28K198 • 04-Oct-2021 • References
URI /orders/<order-id>/return Http Method GET Short Description Provides an information about return reasons for given order Query Parameters none Example Requests /orders/y.UKDACPMIQAAAFYFlQGqAA1/return HTTP Status Codes 200 OK 400 Unauthorized 401 Bad Request 404 Not found Description Provides an
281U96 • 22-Jun-2020 • References
URI servlets/services/reservation/<resvId> Http Method GET Short Description Used to get a stock reservation. Usually called to check the validity of a stock reservation. Example Requests URL http://10.17.0.245:8080/servlets/services/reservation/117 Example Requests No Content HTTP Status Codes 200
A27786 • 31-May-2022 • References • IOM 3.0, IOM 3.1, IOM 3.2, IOM 3.3, IOM 3.4, IOM 3.5, IOM 3.6, IOM 3.7, IOM 4.0, IOM 4.1, IOM 4.2, IOM 4.3
URI servlets/services/rma Http Method POST Short Description Create a return announcement for one or more shipped products from an order. Query Parameters no HTTP Status Codes 201 Created 400 Bad Request 401 Unauthorized 404 Not Found 500 Internal Server Error Description Create Return Announcement
2Q7784 • 26-Apr-2022 • References • IOM 3.0, IOM 3.1, IOM 3.2, IOM 3.3, IOM 3.4, IOM 3.5, IOM 3.6, IOM 3.7, IOM 4.0, IOM 4.1, IOM 4.2, IOM 4.3, IOM 4.4, IOM 4.5, IOM 4.6, IOM 4.7, IOM 5.0
Name ISPAGELETASSIGNMENT Short Description directly renders a component based on an assignment Table of Contents Introduction Syntax Example Attributes PageletAssignment Product Version 7.7 Product To Version Status New Labels Introduction Pagelets derived from a pagelet definition with the page flag
27759N • 04-Feb-2020 • References • ICM 7.10, ICM 11
Name ISCREATEPLACEHOLDERRENDEREVENTS Short Description Creates the necessary render events for pagelets that are assigned to placeholders (in case they are not rendered with <ISSlot> ). Table of Contents Introduction Syntax Example Attributes RenderContextID PageletAssignment Slot ComponentHierarchyKey
2775E8 • 04-Feb-2020 • References • ICM 7.10, ICM 11
URI servlets/services/reservation/<resvId> Http Method PUT Short Description Update a stock reservation. Example Requests URL http://10.17.0.245:8080/servlets/services/reservation/130 Example Requests { "lifetime": 60, "items": [ { "id": "First-Test", "qty": 7 } ] } HTTP Status Codes 201 Created Stock
2729Y4 • 31-May-2022 • References • IOM 3.0, IOM 3.1, IOM 3.2, IOM 3.3, IOM 3.4, IOM 3.5, IOM 3.6, IOM 3.7, IOM 4.0, IOM 4.1, IOM 4.2, IOM 4.3
Name ISSETCANONICALLINK Short Description calculates a canonical link and puts it in the pipeline dictionary Table of Contents Introduction Syntax Example Attributes action parameters name scope protocol Product Version 7.4 Product To Version Status New Labels Introduction This custom tag calculates
2Y6289 • 04-Feb-2020 • References • ICM 7.10, ICM 11
Name encodeValue() Short Description encodes characters for a target document type Table of Contents Introduction Syntax Example Parameters value encoding Product Version 7.5 Product To Version Status New Labels Introduction This function can be used to encode the result of an ISML expression. The value
26002A • 04-Feb-2020 • References • ICM 7.10, ICM 11
URI /customers/<customer-id>/tokens Http Method POST Short Description Create a new authentication token to access, e.g., the WebShop REST API as another user. Query Parameters none Example Requests /ContactCenter/-/customers/0BkKDgAN9pYAAAFFK9Qj6MxN/tokens HTTP Status Codes 201 Created 401 If the user
2A5883 • 23-Jun-2020 • References
URI /channels/<channelID>/applications/<applicationURLID> Http Method GET Short Description Get detail information on an application, including the REST API's URI Query Parameters Example Requests /channels/PrimeTech-PrimeTechSpecials/applications/b2c-web-shop HTTP Status Codes 200 OK 401 if the user
T25882 • 23-Jun-2020 • References
URI /channels/<channelID>/applications Http Method GET Short Description Returns a channel's applications Query Parameters type=<applicationTypeID> (optional) Example Requests /channels/<channelID>/applications?type=intershop.B2CWebShop HTTP Status Codes 200 OK 401 if the user is not authenticated 404
2588A1 • 23-Jun-2020 • References
URI /users/- Http Method GET Short Description CC Login / Gets the profile details of a currently authenticated user (Account Representative) Query Parameters Example Requests /users/- HTTP Status Codes 200 OK 400 Bad Request possible values for "error-key": 401 Unauthorized 403 Forbidden organization
M25763 • 23-Jun-2020 • References
URI /channels/<channelID>/promotions/<promotionID>/codes Http Method POST Short Description Creates a new promotion code for an existing promotion. Query Parameters Example Requests /channels/PrimeTech-PrimeTechSpecials/promotions/CC_20EUR_OrderDiscount/codes HTTP Status Codes 200 Description Creates
25761F • 23-Jun-2020 • References
URI /channels/<channelID> Http Method GET Short Description Returns a channel's detail information Query Parameters Example Requests /channels/PrimeTech-PrimeTechSpecials Headers: Authorization=... or authentication-token=... UserOrganization =PrimeTech HTTP Status Codes 200 404 if the channel cannot
25B760 • 23-Jun-2020 • References
URI /channels Http Method GET Short Description Returns the current organization's sales channels to the client Query Parameters Example Requests /channels Headers: Authorization=... or authentication-token=... UserOrganization =PrimeTech HTTP Status Codes 200 OK 400 Bad Request Possible value for header
25K759 • 23-Jun-2020 • References
URI /customers Http Method GET Short Description Retrieves a fixed maximum number of customers based on the query parameters given Query Parameters Defined query fields: SingleSearchField -Search for Last Name, EMail & Customer Number CustomerNo - Customer number FirstName - First name LastName - Last
2X5757 • 23-Jun-2020 • References
URI /channels/<channelID>/promotions/<promotionID> Http Method GET Short Description Returns information on a single promotion Query Parameters Example Requests /channels/PrimeTech-PrimeTechSpecials/promotions/CC_20EUR_OrderDiscount HTTP Status Codes 200 OK 404 Not found Description Get information
257F56 • 23-Jun-2020 • References
Showing 1721-1740 of 5345
Home
Knowledge Base
Product Releases
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to supportadmin@intershop.de if you experience login issues,
or if you want to register as customer.