openapi: 3.0.1 info: title: Basket description: | This version is deprecated. Please use version 1.0 or higher which covers all supported operations from this version and also additional functionality. The _Basket REST API_ contains resources that cover aspects of basket handling and preparation of the checkout process. A typical checkout process requires a series of REST requests, some of which are based on one another and must therefore take place in a defined sequence. This cannot be sufficiently represented by the OpenAPI documentation only. Detailed descriptions of various checkout scenarios can be found in the [Business Guide "Basket & Checkout REST API"][kb-business-guide] in the Intershop knowledge base. Please also refer to the _Order REST API_, which is used to create an order from the appropriately prepared basket and complete the checkout process. [kb-business-guide]: https://support.intershop.com/kb/2873B2 version: 0.2.0 servers: - url: "/INTERSHOP/rest/{serverGroup}/{siteName}/{appUrl}" description: Intershop ICM Server variables: serverGroup: description: The server group default: WFS siteName: description: The site name default: inSPIRED-inTRONICS-Site appUrl: description: The application URL identifier enum: - rest - rest - rest - rest - rest - rest default: rest tags: - name: General x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketResource - name: Line Item x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource - name: Payment x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentRedirectResource - name: Quote description: ' ' x-origin-class: com.intershop.sellside.rest.b2b.capi.basket.v1.quote.resource.BasketQuoteItemResource paths: /baskets: get: tags: - General summary: Gets all open baskets for the current user description: Gets a list of all open baskets for the user given by the authentication token. operationId: getBaskets responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' links: itemInfo: operationId: getBasketByID parameters: BasketResourceKey: "$response.body#/elements/{$index}/itemId" description: Links to item of type BasketRO "400": description: |- Bad request possible values for header error-key: - basket.basket_user_required.error deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource.getBaskets() x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource post: tags: - General summary: Creates a new basket. description: |- The request creates a new basket. The client gets a link to the new cart.The server will return the headers `authentication-token` and `Location`. These are required for anonymous users, who have not logged in yet, by providing their credentials. In this case the token has any subsequent request to the basket,because a basket can only be accessed by that user who created it. Registered users, that have been logged in before basket creation are not required to sendthe token with subsequent requests. operationId: createBasket responses: "201": description: Created deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource.createBasket() x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource /baskets/{BasketResourceKey}: get: tags: - General summary: |- Returns the basket's summary. Alternatively you may use the URL `/baskets/-` to get the active basket. description: "Get baskets summary, containing\n - Customer related basket information,\ \ like taxation ID, external order reference ID\n - Shipping buckets with\ \ line item references\n - Invoice-to address\n - Promotions applied to the\ \ basket\n - Payment methods applied to the basket\n - Sales and shipping\ \ taxes\n - Surcharges\n - Promotional discounts\n - Basket totals\n - Recurrence\ \ information\n - Document number (is currently only set if basket is in status\ \ waiting for approval after submitting)\n - Recurring Order Document number\ \ (is only set when Basket is recurring)\n - Affiliate information\n \n In\ \ case of basket not found or other error, a status code 400 is returned as\ \ a result.\n \n Depending on the flag `isMultipleShippmentSupported` the\ \ get request returns the availableshipping methods at the basket level or\ \ at the line item level:\n - `isMultipleShippmentSupported = true`: the\ \ shipping methods are available at the line item level and not at the basket\ \ level\n - `isMultipleShippmentSupported = false`: the shipping methods are\ \ available at the basket level and not at the line item level" operationId: getBasketByID parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/BasketRO' text/xml: schema: $ref: '#/components/schemas/BasketRO' "400": description: Bad request "401": description: Unauthorized "403": description: |- FORBIDDEN Requires authentication with user having assigned the following permissions: - Purchase (APP_B2B_PURCHASE, only in B2B applications) deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketRO com.intershop.sellside.rest.common.capi.resource.basket.BasketResource.getBasketByID() x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketResource put: tags: - General summary: "Sets / updates basket related data, marks the basket as recurrent\ \ and sets recurrence information" description: "Sets following basket related data:\n - commonShipToAddress\n\ \ \n If a complete address is specified, this address is set after validation\ \ successfully finished. Alternatively, a URN of an existing address (e.g.,\ \ of an address of a registered customer or a store address) may be passed\ \ to use this address if possible. Note that an existing address may only\ \ be used if it is marked as an invoice-to address.\n - invoiceToAddress\n\ \ \n If a complete address is specified, this address is set after validation\ \ successfully finished. Alternatively, a URN of an existing address (e.g.,\ \ of an address of a registered customer or a store address) may be passed\ \ to use this address if possible. Note that an existing address may only\ \ be used if it is marked as a ship-to address.\n - commonShippingMethod\n\ \ - promotionCode\n \n If the specified promotion code is valid, it is applied\ \ to the basket.If the promotion code is not valid, then a validation result\ \ is returned.\n - department\n \n Option to set the buyer's department at\ \ the basket in case of unregistered checkout.\n - taxationID\n \n Option\ \ to set buyer's taxation ID at the basket in case of unregistered checkout.\n\ \ - taxExempt\n - purchaseCurrency\n - dynamicMessages\n - externalOrderReferenceID\n\ \ \n Option to set a buyer specific order reference ID at the basket.\n -\ \ owningUser\n \n Assigns the basket to another user. It is intended to be\ \ used to transfer the basket of an anonymous user to a registered user, when\ \ the anonymous user logs-in during the checkout. In order to change the owner\ \ a valid authentication token of the new user has to be applied.After changing\ \ the owner, the current user has no access to this basket anymore!\n - multipleShippmentsSupported\n\ \ - recurrence (required fields: StartDate, Recurrence Interval; optional\ \ fields: EndDate, Number of repetitions)\n \n The recurrence Interval is\ \ defined as Java period Object, that supports ISO 8601. It allows numerous\ \ possibilities to set the interval.\n The string always starts with a 'P'\ \ for period. The interval can contain a number of years (Y), months (M) weeks\ \ (W) or Days (D) or any combination of them.\n The number is placed in front\ \ of the unit. Weeks are transformed to days by multiplying with 7 -> (P4W\ \ = P28D).\n \n \nNOTE: \n By default the subscriptions feature is disabled\ \ for the channel. " operationId: editBasketByID parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/BasketRO' text/xml: schema: $ref: '#/components/schemas/BasketRO' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/BasketRO' text/xml: schema: $ref: '#/components/schemas/BasketRO' "400": description: "Bad request \n Possible values for header 'error-key:\n -\ \ basket.addreess_not_found_error\n - basket.basket_id_required.error\n\ \ - basket.invalid_address.error\n - basket.store_addresses_not_allowed.error\n\ \ - customer.address.missing_fields.error\n - basket.recurring_not_allowed.error\n\ \ - basket.cost_center.no_customer.error\n - basket.cost_center.invalid_customer.error\n\ \ - basket.cost_center.not_found.error\n - basket.affiliate.invalid.error\n\ \ - basket.promotioncode.invalid.error.{xxx}\n \n Possible messages for\ \ missing attributes:\n - interval\n - startDate" "401": description: Unauthorized "404": description: |- Not found possible values for header 'error-key': - basket.basket_not_found.error "501": description: |- Not implemented (if the recurring order feature is disabled), possible values for header 'error-key': - error.recurring_orders.disabled "503": description: Service unavailable (if Microservice is not available and/or cannot be discovered) deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketRO com.intershop.sellside.rest.common.capi.resource.basket.BasketResource.editBasketByID(com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketResource options: tags: - General summary: Returns all available options for the given basket description: |- Returns the following available options for the given basket: - common shipping methods Depending on the flag `isMultipleShippmentSupported` the option request returnsall available shipping methods for the whole basket or the option request returns nothing: - `isMultipleShippmentSupported = true`: There are no shipping methods for the whole basket availablebecause the shipping methods are only available at the line item level - `isMultipleShippmentSupported = false`: The option request returns all available shipping methodsfor the whole basket (shipping methods on basket level) operationId: getBasketOptions parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/BasketOptionsRO' text/xml: schema: $ref: '#/components/schemas/BasketOptionsRO' "404": description: Not found "401": description: Unauthorized "403": description: |- FORBIDDEN Requires authentication with user having assigned the following permissions: - Purchase (APP_B2B_PURCHASE, only in B2B applications) deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketOptionsRO com.intershop.sellside.rest.common.capi.resource.basket.BasketResource.getBasketOptions() x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketResource /baskets/{BasketResourceKey}/costobjects: get: tags: - Cost Object summary: (Deprecated) Returns the cost objects assigned to the selected basket description: |- This operation is deprecated. The Cost Object feature is no longer supported. ResourceCollectionRO contains elements of type LinkRO operationId: getBasketCostObjectAssignments parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' links: itemInfo: operationId: getBasketCostObjectAssignment parameters: BasketCostObjectAssignmentKey: "$response.body#/elements/{$index}/itemId" description: Links to item of type CostObjectAssignmentRO "401": description: Unauthorized "403": description: |- FORBIDDEN Requires authentication with a user who has been assigned the following permissions: - View Cost Object (APP_B2B_VIEW_COSTOBJECT) deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.BasketCostObjectAssignmentListResource.getBasketCostObjectAssignments() x-origin-class: com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.BasketCostObjectAssignmentListResource post: tags: - Cost Object summary: (Deprecated) Assigns a cost object to the basket description: This operation is deprecated. The Cost Object feature is no longer supported. operationId: createCostObjectAssignment parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/CostObjectAssignmentRO' text/xml: schema: $ref: '#/components/schemas/CostObjectAssignmentRO' responses: "201": description: Created "401": description: Unauthorized "404": description: Not found "403": description: |- FORBIDDEN Requires authentication with a user who has been assigned the following permissions: - Assign Cost Object To Basket (APP_B2B_ASSIGN_COSTOBJECT_TO_BASKET) "400": description: |- Bad request possible values for header error-key: - basket.cost_object.missing_body.error - basket.cost_object.missing_attributes.error - basket.cost_object.invalid_attributes.error - basket.cost_object.already_set.error deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.BasketCostObjectAssignmentListResource.createCostObjectAssignment(com.intershop.application.storefront.rest.b2b.capi.costobject.resourceobject.CostObjectAssignmentRO) x-origin-class: com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.BasketCostObjectAssignmentListResource /baskets/{BasketResourceKey}/costobjects/{BasketCostObjectAssignmentKey}: get: tags: - Cost Object summary: (Deprecated) Returns a specific cost object assigned to the selected basket description: This operation is deprecated. The Cost Object feature is no longer supported. operationId: getBasketCostObjectAssignment parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource - name: BasketCostObjectAssignmentKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.BasketCostObjectAssignmentListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/CostObjectAssignmentRO' text/xml: schema: $ref: '#/components/schemas/CostObjectAssignmentRO' "401": description: Unauthorized "404": description: Not found "403": description: |- FORBIDDEN Requires authentication with a user who has been assigned the following permissions: - View Cost Object (APP_B2B_VIEW_COSTOBJECT) deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.application.storefront.rest.b2b.capi.costobject.resourceobject.CostObjectAssignmentRO com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.BasketCostObjectAssignmentItemResource.getBasketCostObjectAssignment() x-origin-class: com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.BasketCostObjectAssignmentItemResource delete: tags: - Cost Object summary: (Deprecated) Removes a cost object from the basket description: This operation is deprecated beacuse the Cost Object feature is no longer supported. operationId: deleteCostObjectAssignment parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource - name: BasketCostObjectAssignmentKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.BasketCostObjectAssignmentListResource responses: "204": description: No content "401": description: Unauthorized "404": description: Not found "403": description: |- FORBIDDEN Requires authentication with a user who has been assigned the following permissions: - Delete Cost Object (APP_B2B_DELETE_COSTOBJECT) deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.BasketCostObjectAssignmentItemResource.deleteCostObjectAssignment() x-origin-class: com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.BasketCostObjectAssignmentItemResource /baskets/{BasketResourceKey}/items: get: tags: - Line Item summary: Gets all line items contained in the given basket. description: |- Gets a collection of all line items contained in the basket. The line items are provided as simple list without any structuring according to shipping buckets the line items are assigned to. If the basket is not found a status code 404 is returned, otherwise - status code 200. operationId: getBasketContent parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AbstractResourceObject' text/xml: schema: $ref: '#/components/schemas/AbstractResourceObject' "404": description: Not found "401": description: Unauthorized "400": description: |- Bad request possible values for header error-key: - basket.basket_id_required.error "403": description: |- FORBIDDEN Requires authentication with user having assigned the following permissions: - Purchase (APP_B2B_PURCHASE, only in B2B applications) deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemListResource.getBasketContent() x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemListResource post: tags: - Line Item summary: Adds a list of items or line items of a quote to an existing basket description: |- Adds a list of items to the basket.The items are either specified in the request body, or come from quote that will be specified with the quote ID. If a quote contains invalid products (delete, offline etc.) then all available products from the quote are added to the basket. If the quote contains no valid products at all an error occurs (400 - quote.no_valid_items.error). For every item `sku` and `quantity` has to be specified. For gift certificates additional information are required. That is recipient email, recipient name, sender email, sender name and greeting message. If basket is not found, a status code 404 is returned as a response. If any error occurs when adding products to the basket, then a status code 400 is returned. operationId: addItemsToBasket parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/ExtendedLineItemCollectionRO' text/xml: schema: $ref: '#/components/schemas/ExtendedLineItemCollectionRO' responses: "201": description: Created "401": description: Unauthorized "403": description: "FORBIDDEN possible values for header error-key:\n - quote.expired.error\n\ \ - quote.rejected.error\n \n Requires authentication with user having\ \ assigned the following permissions:\n - Purchase (APP_B2B_PURCHASE,\ \ only in B2B applications)" "404": description: |- Not found possible values for header error-key: - basket.basket_not_found.error - basket.product.not_found.error "400": description: |- Bad request possible values for header error-key: - basket.basket_id_required.error - basket.gift.message.to_required.error - basket.gift.message.from_required.error - basket.gift.message.message_required.error - basket.product.add_to_basket_unsuccessful.error - basket.product.not_found.error - basket.product.sku_required.error - basket.product.quantity_invalid.error - quote.no_valid_items.error deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemListResource.addItemsToBasket(com.intershop.sellside.rest.common.capi.resourceobject.basket.ExtendedLineItemCollectionRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemListResource /baskets/{BasketResourceKey}/items/{BasketLineKey}: get: tags: - Line Item summary: Get the specified line item from basket. description: |- Gets the line item with the specified ID. Status code 404 is returned, if basket or basket item could not be found. operationId: getItemFromBasketByID parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource - name: BasketLineKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AbstractResourceObject' text/xml: schema: $ref: '#/components/schemas/AbstractResourceObject' "400": description: |- Bad request possible values for header error-key: - basket.basket_id_required.error - basket.lineitem.id_required.error "404": description: |- Not found possible values for header error-key: - basket.basket_not_found.error - basket.lineitem.not_found.error "401": description: Unauthorized "403": description: |- FORBIDDEN Requires authentication with user having assigned the following permissions: - Purchase (APP_B2B_PURCHASE, only in B2B applications) deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource.getItemFromBasketByID() x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource put: tags: - Line Item summary: Sets line item related data description: |- Sets following line item related data: - Quantity - Product variation option - Ship-to address - Shipping method - Gift certificate data If basket or basket line item is not found then a status code 404 is returned as a result. Depending on the flag `MultipleShipmentsSupported` the shipping methods and addresses can be set at the line item level: - `MultipleShipmentsSupported = true`: the shipping methods and addresses can be set on line item level (not at basket level) - `MultipleShipmentsSupported = false`: the shipping methods and addresses cannot be set on line item level (only at basket level) operationId: updateItemsFromBasket parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource - name: BasketLineKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/BasketLineItemRO' text/xml: schema: $ref: '#/components/schemas/BasketLineItemRO' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AbstractResourceObject' text/xml: schema: $ref: '#/components/schemas/AbstractResourceObject' "401": description: Unauthorized "403": description: |- FORBIDDEN Requires authentication with user having assigned the following permissions: - Purchase (APP_B2B_PURCHASE, only in B2B applications) "404": description: |- Not found possible values for header error-key: - basket.basket_not_found.error - basket.lineitem.not_found.error - basket.product.not_found.error - basket.warranty.not_found.error "400": description: |- Bad request possible values for header error-key: - basket.basket_id_required.error - basket.gift.message.to_required.error - basket.gift.message.from_required.error - basket.gift.message.message_required.error - basket.lineitem.id_required.error - basket.product.sku_required.error - basket.product.variation.update_not_successful.error - basket.product.update_quantity.error - basket.invalid_address.error deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource.updateItemsFromBasket(com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketLineItemRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource delete: tags: - Line Item summary: Removes the specified line item from basket. description: |- Removes the line item with the given ID from the basket. The result basket's summary. Status code 404 is returned if the basket or the line item could not be found. operationId: removeItemFromBasket parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource - name: BasketLineKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemListResource responses: "303": description: See other content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' "400": description: |- Bad request possible values for header error-key: - basket.lineitem.id_required.error - basket.basket_id_required.error "404": description: |- Not found possible values for header error-key: - basket.basket_not_found.error "401": description: Unauthorized "403": description: |- FORBIDDEN Requires authentication with user having assigned the following permissions: - Purchase (APP_B2B_PURCHASE, only in B2B applications) deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource.removeItemFromBasket() x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource options: tags: - Line Item summary: Returns all available options for the given line item description: |- Returns the following available options for the given basket line item: - Eligible shipping methods - Warranties - Gift wraps - Gift messages - Product variation options operationId: getBasketLineItemOptions parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource - name: BasketLineKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/BasketLineItemRO' text/xml: schema: $ref: '#/components/schemas/BasketLineItemRO' "403": description: |- FORBIDDEN Requires authentication with user having assigned the following permissions: - Purchase (APP_B2B_PURCHASE, only in B2B applications) deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketLineItemOptionsRO com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource.getBasketLineItemOptions() x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource /baskets/{BasketResourceKey}/items/{BasketLineKey}/sublineitems: get: tags: - Line Item summary: Get basket subline items operationId: getSubLineItemsFromBasketByID parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource - name: BasketLineKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemListResource responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/AbstractResourceObject' text/xml: schema: $ref: '#/components/schemas/AbstractResourceObject' deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource.getSubLineItemsFromBasketByID() x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource /baskets/{BasketResourceKey}/items/{BasketLineKey}/sublineitems/{subLineItemName}: get: tags: - Line Item summary: Get the sub-line type of a specific basket item. description: "Get the sub-line type of a specific basket item. Valid types are\ \ warranty, gift wrap and gift message. If basket or basket item, or sub-line\ \ type is not found then a status code 404 is returned as a result." operationId: getSublineItem parameters: - name: subLineItemName in: path required: true schema: type: string - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource - name: BasketLineKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/BasketDependentLineItemRO' text/xml: schema: $ref: '#/components/schemas/BasketDependentLineItemRO' "401": description: Unauthorized "403": description: |- FORBIDDEN Requires authentication with user having assigned the following permissions: - Purchase (APP_B2B_PURCHASE, only in B2B applications) "400": description: |- Bad request possible values for header error-key: - basket.basket_id_required.error - basket.lineitem.id_required.error - basket.item.sublinetype.missing_fields.error "404": description: |- Not found possible values for header error-key: - basket.basket_not_found.error - basket.item.unknown_sublinetype.error - basket.lineitem.not_found.error deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketDependentLineItemRO com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource.getSublineItem(java.lang.String) x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource put: tags: - Line Item summary: Modify the sublinetype of a specific basket item description: "Modify the sublinetype of a specific basket item. Valid types\ \ are warranty, giftwrap and giftmessage. If basket or basket item, or subline\ \ type is not found then a status code 404 is returned as a result. If product\ \ sku is not provided a status code 400 is returned as a result." operationId: updateSublineItem parameters: - name: subLineItemName in: path required: true schema: type: string - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource - name: BasketLineKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemListResource requestBody: content: '*/*': schema: $ref: '#/components/schemas/BasketDependentLineItemRO' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AbstractResourceObject' text/xml: schema: $ref: '#/components/schemas/AbstractResourceObject' "401": description: Unauthorized "403": description: |- FORBIDDEN Requires authentication with user having assigned the following permissions: - Purchase (APP_B2B_PURCHASE, only in B2B applications) "404": description: |- Not found possible values for header error-key: - basket.basket_id_required.error - basket.lineitem.not_found.error - basket.lineitem.subline_type_required.error - basket.basket_not_found.error "400": description: "Bad request possible values for header error-key:\n - basket.basket_sku_required.error\n\ \ - basket.lineitem.id_required.error\n - basket.product.sku_required.error\n\ \ - basket.product.not_found.error\n - basket.gift.message.from_required.error\n\ \ - basket.gift.message.to_required.error\n - basket.gift.message.message_required.error\ \ \n - basket.lineitem.product.no_applicable.error\n - basket.basket_id_required.error" deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: "public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject\ \ com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource.updateSublineItem(java.lang.String,com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketDependentLineItemRO)" x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource delete: tags: - Line Item summary: Delete the sublinetype of a specific basket item description: "Delete the sublinetype of a specific basket item. Valid types\ \ are warranty, giftwrap and giftmessage.If basket or basket item, or subline\ \ type is not found then a status code 404 is returned as a result." operationId: removeSublineItem parameters: - name: subLineItemName in: path required: true schema: type: string - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource - name: BasketLineKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemListResource responses: "303": description: See other content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' "401": description: Unauthorized "403": description: |- FORBIDDEN Requires authentication with user having assigned the following permissions: - Purchase (APP_B2B_PURCHASE, only in B2B applications) "400": description: |- Bad request possible values for header error-key: - basket.basket_id_required.error - basket.lineitem.id_required.error "404": description: |- Not found possible values for header error-key: - basket.basket_not_found.error - basket.lineitem.id_required.error - basket.lineitem.subline_type_required.error - basket.lineitem.id_required.error - basket.lineitem.not_found.error deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource.removeSublineItem(java.lang.String) x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource /baskets/{BasketResourceKey}/payments: get: tags: - Payment summary: Returns a list with all selected payments for the basket description: Returns a list of links of all selected payment methods for the basket operationId: getBasketPayments parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' links: itemInfo: operationId: getBasketPayment parameters: BasketPaymentKey: "$response.body#/elements/{$index}/itemId" description: Links to item of type PaymentRO "401": description: Unauthorized "403": description: |- FORBIDDEN Requires authentication with user having assigned the following permissions: - Purchase (APP_B2B_PURCHASE, only in B2B applications) "404": description: Not found deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentResource.getBasketPayments() x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentResource post: tags: - Payment summary: Adds a payment method to the basket description: Adds a payment method to the basket. If the user is logged in a registered payment method can be referenced via ID (for payments that have been created with POST /customers/-/payments) operationId: addPaymentToBasket parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentRO' text/xml: schema: $ref: '#/components/schemas/PaymentRO' responses: "201": description: Created "401": description: Unauthorized "403": description: |- FORBIDDEN Requires authentication with user having assigned the following permissions: - Purchase (APP_B2B_PURCHASE, only in B2B applications) "404": description: |- Not found possible values for header error-key: - basket.basket_not_found.error "400": description: |- Bad request possible values for header error-key: - shopping_cart.payment.paymentdata.error (e.g., wrong giftcard number) - shopping_cart.payment.missing_fields.error - shopping_cart.payment.invalid_fields.error - shopping_cart.payment.name.error (Payment method not found) - shopping_cart.payment.dublicate.error - shopping_cart.payment.available.error (also thrown if basket contains NO items) deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentResource.addPaymentToBasket(com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentResource options: tags: - Payment summary: Returns all available payment methods and their parameters available for this basket description: "Returns all available payment methods and their parameters, which\ \ are available for this basket" operationId: getBasketPaymentOptions parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PaymentOptionsRO' text/xml: schema: $ref: '#/components/schemas/PaymentOptionsRO' "401": description: Unauthorized "403": description: |- FORBIDDEN Requires authentication with user having assigned the following permissions: - Purchase (APP_B2B_PURCHASE, only in B2B applications) deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentOptionsRO com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentResource.getBasketPaymentOptions() x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentResource /baskets/{BasketResourceKey}/payments/{BasketPaymentKey}: get: tags: - Payment summary: 'Returns details of the payment method ' description: Returns detailed information of the payment method operationId: getBasketPayment parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource - name: BasketPaymentKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PaymentRO' text/xml: schema: $ref: '#/components/schemas/PaymentRO' "401": description: Unauthorized "403": description: |- FORBIDDEN Requires authentication with user having assigned the following permissions: - Purchase (APP_B2B_PURCHASE, only in B2B applications) "404": description: Not found deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentItemResource.getBasketPayment() x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentItemResource delete: tags: - Payment summary: Removes selected payment method from basket payments. description: Removes selected payment method from basket payments. operationId: removePaymentFromBasket parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource - name: BasketPaymentKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentResource responses: "303": description: See other(link to basket) content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' "401": description: Unauthorized "403": description: |- FORBIDDEN Requires authentication with user having assigned the following permissions: - Purchase (APP_B2B_PURCHASE, only in B2B applications) "404": description: Not found deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentItemResource.removePaymentFromBasket() x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentItemResource /baskets/{BasketResourceKey}/payments/{BasketPaymentKey}/redirect: put: tags: - Payment summary: REST client delivers the return URLs to the system description: "The REST client sends the return URLs to the system, so that the\ \ redirect URL for the payment service provider can be created. This redirect\ \ URL will be send as response to the REST client so that the client can process\ \ the redirect action. After that, the user will be redirected back to his\ \ REST client based on the return URLs." operationId: createPaymentRedirectURL parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource - name: BasketPaymentKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentResource requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentRedirectRO' text/xml: schema: $ref: '#/components/schemas/PaymentRedirectRO' responses: "201": description: Created "400": description: Bad request "401": description: Unauthorized "403": description: |- FORBIDDEN Requires authentication with user having assigned the following permissions: - Purchase (APP_B2B_PURCHASE, only in B2B applications) "404": description: Not found deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentRedirectResource.createRedirectURL(com.intershop.sellside.rest.common.capi.resource.basket.PaymentRedirectRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentRedirectResource post: tags: - Payment summary: "Transfer payment transaction information from the payment service\ \ provider, via the REST client to the shop system to activate there the payment\ \ transaction" description: |- If the user has processed his payment transaction successfully at the payment providers system, he will be redirected back to his REST client. This return redirect contains various payment transaction attributes which must be transferred from the REST client back to the shop system to process the payment transaction. The redirect POST requests transfers this data from the REST client into the shop system so that the payment transaction can be activated there. For instance: - transaction ID - transaction status - and so on operationId: addPaymentRedirectResponseData parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource - name: BasketPaymentKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentResource requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentRedirectResponseRO' text/xml: schema: $ref: '#/components/schemas/PaymentRedirectResponseRO' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PaymentRO' text/xml: schema: $ref: '#/components/schemas/PaymentRO' "400": description: Bad request "401": description: Unauthorized "403": description: |- FORBIDDEN Requires authentication with user having assigned the following permissions: - Purchase (APP_B2B_PURCHASE, only in B2B applications) "404": description: Not found deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentRedirectResource.addRedirectResponseData(com.intershop.sellside.rest.common.capi.resource.basket.PaymentRedirectResponseRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentRedirectResource components: schemas: AbstractResourceObject: title: Object type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true ResourceCollectionRO: type: object properties: pageable: type: string description: The pageable ID total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/AbstractResourceObject' type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: The keys to sort for xml: name: sortKey name: type: string description: The name of an element xml: attribute: true description: A list of ResourceObjects xml: name: ResourceCollection LinkRO: title: Link type: object properties: name: type: string description: The name of the returned element xml: attribute: true type: type: string description: "This is a constant: **Link**" readOnly: true example: Link xml: attribute: true attributes: type: array description: The list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' uri: type: string description: The URI relation: type: string description: The relation of the link externalDocs: description: Link Relations (www.iana.org) url: http://www.iana.org/assignments/link-relations/link-relations.xml enum: - about - alternate - appendix - archives - author - bookmark - canonical - chapter - collection - contents - copyright - create-form - current - describedby - describes - disclosure - duplicate - edit - edit-form - edit-media - enclosure - first - glossary - help - hosts - hub - icon - index - item - last - latest-version - license - lrdd - monitor - monitor-group - next - next-archive - nofollow - noreferrer - payment - predecessor-version - prefetch - prev - preview - previous - prev-archive - privacy-policy - profile - related - replies - search - section - self - service - start - stylesheet - subsection - successor-version - tag - terms-of-service - type - up - version-history - via - working-copy - working-copy-of title: type: string description: The title of the link description: type: string description: The description of the link itemId: type: string description: The ID of the linked item attribute: $ref: '#/components/schemas/ResourceAttribute' description: A Link pointing to a resource xml: name: Link ResourceAttribute: title: Attribute type: object properties: name: type: string description: The attribute's name xml: attribute: true type: type: string description: "This is a constant: **ResourceAttribute**" example: ResourceAttribute xml: attribute: true value: type: object description: The attribute's value. description: An attribute xml: name: ResourceAttribute ResourceCollectionROLinkRO: title: Link List type: object properties: pageable: type: string description: The pageable ID. total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/LinkRO' type: type: string description: "This is a constant: **ResourceCollection**" example: ResourceCollection xml: attribute: true sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: The keys to sort for xml: name: sortKey name: type: string description: The name of the returned element xml: attribute: true description: A list of links xml: name: ResourceCollection AddressRO: title: Address type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: Address xml: attribute: true urn: type: string description: the URN representation of this address example: urn:address:customer:1234567890:0987654321 id: type: string description: The ID of the returned element example: vagKAB17gg4AAAFGSkFqQASI externalId: type: string description: The ID uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system readOnly: true example: "000123456" externalUrn: type: string description: The URN uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system readOnly: true example: urn:address:MSDynamics365:MyCorp:000123456 addressName: type: string description: The name of the address example: customeraddr-ABCDEFGPRMuMCscyXgSRVU title: type: string description: "The (personal) title of the contact person, like 'Mr.' or\ \ 'Ms.'" example: Mrs. aristocraticTitle: type: string description: "the aristocratic title of the contact person, like Lord\ \ or Lady" jobTitle: type: string description: the job title of the contact person example: CEO honorific: type: string description: "the honorific title of the contact person that denotes the\ \ honored person's occupation, like Captain, Coach, Officer,\ \ Reverend or the academic title, like PhD" firstName: type: string description: The (first) given name of the contact person example: Patricia secondName: type: string description: the second given name of the contact person example: Luise lastName: type: string description: The last name of the contact person example: Miller secondLastName: type: string description: the second last name of the contact person companyName1: type: string description: the company name example: PMiller ltd. companyName2: type: string description: The second company name addressLine1: type: string description: the first address line example: Berliner Str. 20 addressLine2: type: string description: the second address line example: 1st Floor addressLine3: type: string description: The third address line example: Second door on the right postBox: type: string description: the post-office box example: PO Box 42 mainDivision: type: string description: "the main division of the country, e. g. a state or province" example: AL mainDivisionName: type: string description: The localized display name of the main division example: Alabama subDivision: type: string description: The sub division code of the country. example: GB-PKN subDivisionName: type: string description: The localized display name of the sub division example: Perth and Kinross postalCode: type: string description: The postal code example: "14482" email: type: string description: the e-mail address of the contact person example: pmiller@intershop.de phoneMobile: type: string description: The number of the contact person's cell phone example: +49364112677 phoneHome: type: string description: The phone number of the house or apartment where the contact person lives example: "049364112677" phoneBusiness: type: string description: The phone number of the contact person's company example: "049364112699" phoneBusinessDirect: type: string description: the business phone number of the contact person that allows an outside caller to connect directly to the contact person without any help of an attendant or operator example: "049364112659" country: type: string description: The display name of the country in the current locale example: Germany countryCode: type: string description: The country code example: DE city: type: string description: The name of the city example: Potsdam fax: type: string description: the fax number example: "049364112643" usage: type: object properties: empty: type: boolean description: " Returns usage information for the address. Every bit in the\ \ returned set marks a specific usage type, like ship-from or invoice-to\ \ address. If a bit is set, the address may be used for the specific purpose\ \ mapped to this bit. Further bits may be used for custom types. Default\ \ usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to" description: This resource holds the details of an address. xml: name: Address AppliedRebateRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: AppliedRebate xml: attribute: true rebateType: type: string description: the type of the applied rebate example: OrderValueOffDiscount description: type: string description: The description of the applied rebate example: "For orders over 200 USD, a 10 USD Order discount is guaranteed\ \ for the Promo Code 'INTERSHOP'." code: type: string description: the code of the applied rebate example: INTERSHOP amount: $ref: '#/components/schemas/MoneyRO' xml: name: AppliedRebate AppliedTaxRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: AppliedTax xml: attribute: true rate: type: number description: "the tax rate, 100 = 100%" example: 19 amount: $ref: '#/components/schemas/MoneyRO' description: the taxes applied to the surcharge amount as collection of AppliedTaxRO xml: name: AppliedTax BasketRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: Basket xml: attribute: true id: type: string description: The id of the basket example: zP8KAB17ceUAAAFGntJqQASH purchaseCurrency: type: string description: The purchase currency of the basket example: USD externalOrderReferenceID: type: string taxationID: type: string description: the taxation ID associated with the basket example: "99999999999" taxExempt: type: boolean description: is the basket tax exempt? example: false department: type: string description: the buyers department in case of unregistered checkout example: Sales costCenterID: type: string description: The cost Center ID of the basket example: "511288" newOwnerAuthenticationToken: type: string documentNumber: type: string description: the document number of the basket example: "0000042" recurringOrderDocumentNo: type: string description: "the recurring order document number, if basket is configured\ \ as recurring" example: "0000009" dynamicMessages: type: array items: type: string invoiceToAddress: $ref: '#/components/schemas/AddressRO' commonShipToAddress: $ref: '#/components/schemas/AddressRO' commonShippingMethod: $ref: '#/components/schemas/ShippingMethodRO' paymentMethods: type: array description: The Payment methods for this basket xml: wrapped: true items: $ref: '#/components/schemas/PaymentMethodRO' promotions: type: array description: The Promotions for this basket xml: wrapped: true items: $ref: '#/components/schemas/PromotionLinkRO' valueRebates: type: array description: The Applied Rebates for this basket xml: wrapped: true items: $ref: '#/components/schemas/AppliedRebateRO' shippingRebates: type: array description: The Applied Shipping Rebates for this basket xml: wrapped: true items: $ref: '#/components/schemas/AppliedRebateRO' itemSurchargeTotalsByType: type: array description: The Item Surcharge Totals by type for this basket xml: wrapped: true items: $ref: '#/components/schemas/SurchargeRO' bucketSurchargeTotalsByType: type: array description: The Bucket Surcharge Totals by type for this basket xml: wrapped: true items: $ref: '#/components/schemas/SurchargeRO' salesTaxTotalsByTaxRate: type: array description: The Sales Tax Totals by tax rate for this basket xml: wrapped: true items: $ref: '#/components/schemas/AppliedTaxRO' shippingTaxTotalsByTaxRate: type: array description: The Shipping Tax Totals by tax rate for this basket xml: wrapped: true items: $ref: '#/components/schemas/AppliedTaxRO' recurrence: $ref: '#/components/schemas/RecurrenceRO' shippingBuckets: type: array description: The Shipping Buckets in this basket xml: wrapped: true items: $ref: '#/components/schemas/BasketShippingBucketRO' affiliatePartnerID: type: string description: The AffiliatePartnerID for this basket affiliateProgramID: type: string description: The AffiliateProgramID for this basket multipleShippmentsSupported: type: boolean description: "true, if multiple shipments are supported" example: true totals: $ref: '#/components/schemas/BasketTotalsRO' xml: name: Basket BasketShippingBucketRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: BasketShippingBucket xml: attribute: true shipToAddress: $ref: '#/components/schemas/AddressRO' shippingMethod: $ref: '#/components/schemas/BasketShippingMethodRO' packSlipMessage: type: string description: the pack slip message of the bucket example: Your order is here! shippingInstructions: type: string description: the shipping instrucations of the bucket example: Keep away from water bucketSurcharges: type: array description: the surcharges of the bucket as SurchargeRO xml: wrapped: true items: $ref: '#/components/schemas/SurchargeRO' shippingRebates: type: array description: the shipping rebates of the bucket as AppliedRebateRO xml: wrapped: true items: $ref: '#/components/schemas/AppliedRebateRO' lineItems: type: array description: the line items of the bucket as Collection of LinkROs xml: wrapped: true items: $ref: '#/components/schemas/LinkRO' description: The Shipping Buckets in this basket xml: name: BasketShippingBucket BasketShippingMethodRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: BasketShippingMethod xml: attribute: true id: type: string description: The id of the returned element example: STD_GROUND shippingTimeMin: type: integer description: The minimum shipping time in days format: int32 example: 3 shippingTimeMax: type: integer description: The maximum shipping time in days format: int32 example: 7 description: the shippingMethod of the bucket as ShippingMethodRO xml: name: BasketShippingMethod BasketTotalsRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: BasketTotals xml: attribute: true itemTotal: $ref: '#/components/schemas/MoneyRO' itemRebatesTotal: $ref: '#/components/schemas/MoneyRO' shippingTotal: $ref: '#/components/schemas/MoneyRO' itemShippingRebatesTotal: $ref: '#/components/schemas/MoneyRO' bucketShippingRebatesTotal: $ref: '#/components/schemas/MoneyRO' basketValueRebatesTotal: $ref: '#/components/schemas/MoneyRO' basketShippingRebatesTotal: $ref: '#/components/schemas/MoneyRO' paymentCostsTotal: $ref: '#/components/schemas/MoneyRO' taxTotal: $ref: '#/components/schemas/MoneyRO' dutiesAndSurchargesTotal: $ref: '#/components/schemas/MoneyRO' basketTotal: $ref: '#/components/schemas/MoneyRO' basketTotalMinusLimitedTender: $ref: '#/components/schemas/MoneyRO' limitedTenderTotal: $ref: '#/components/schemas/MoneyRO' description: The totals for this basket xml: name: BasketTotals CreditCardRO: type: object xml: name: CreditCard allOf: - $ref: '#/components/schemas/PaymentMethodRO' - type: object properties: creditCardNumber: type: string creditCardExpiryMonth: type: string creditCardExpiryYear: type: string creditCardType: type: string creditCardSecurityCode: type: string id: type: string DebitTransferAccountRO: type: object xml: name: DebitTransferAccount allOf: - $ref: '#/components/schemas/PaymentMethodRO' - type: object properties: accountHolder: type: string accountNumber: type: string bankCode: type: string directDebitInputFieldUUID: type: string dummyID: type: string id: type: string GiftCertificatePaymentMethodRO: type: object xml: name: GiftCertificate allOf: - $ref: '#/components/schemas/PaymentMethodRO' - type: object properties: number: type: string id: type: string appliedAmount: $ref: '#/components/schemas/MoneyRO' MoneyRO: title: Money type: object properties: type: type: string description: "This is a constant: **Money**" readOnly: true example: Money xml: attribute: true value: type: number description: The monetary value. example: 10.99 currencyMnemonic: type: string deprecated: true currency: type: string description: Three-letter currency code (ISO 4217) of the monetary value. example: USD description: Money combines a currency and a money amount. xml: name: Money PaymentCostRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true minOrderAmount: $ref: '#/components/schemas/MoneyRO' maxOrderAmount: $ref: '#/components/schemas/MoneyRO' cost: $ref: '#/components/schemas/MoneyRO' threshold: $ref: '#/components/schemas/MoneyRO' description: the costs of this PaymentMethod as list of PaymentCostRO objects PaymentMethodRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: PaymentMethod xml: attribute: true attributes: type: array description: The list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' displayName: type: string description: the display name of the payment method example: Intershop Credit Card costs: type: array description: the costs of this PaymentMethod as list of PaymentCostRO objects items: $ref: '#/components/schemas/PaymentCostRO' uri: type: string openTender: type: boolean default: type: boolean description: is this payment method the default one? example: true attribute: $ref: '#/components/schemas/ResourceAttribute' description: The Payment methods for this basket xml: name: PaymentMethod discriminator: propertyName: type PromotionLinkRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: PromotionLink xml: attribute: true attributes: type: array description: The list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' uri: type: string relation: type: string enum: - about - alternate - appendix - archives - author - bookmark - canonical - chapter - collection - contents - copyright - create-form - current - describedby - describes - disclosure - duplicate - edit - edit-form - edit-media - enclosure - first - glossary - help - hosts - hub - icon - index - item - last - latest-version - license - lrdd - monitor - monitor-group - next - next-archive - nofollow - noreferrer - payment - predecessor-version - prefetch - prev - preview - previous - prev-archive - privacy-policy - profile - related - replies - search - section - self - service - start - stylesheet - subsection - successor-version - tag - terms-of-service - type - up - version-history - via - working-copy - working-copy-of title: type: string description: type: string itemId: type: string code: type: string description: the code of the promotion example: INTERSHOP attribute: $ref: '#/components/schemas/ResourceAttribute' description: The Promotions for this basket xml: name: PromotionLink RecurrenceRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: Recurrence xml: attribute: true startDate: type: string description: the start date of the reccurence format: date-time xml: attribute: true endDate: type: string description: the end date of the reccurence format: date-time xml: attribute: true interval: type: object properties: years: type: integer format: int32 months: type: integer format: int32 days: type: integer format: int32 zero: type: boolean negative: type: boolean chronology: type: object properties: calendarType: type: string id: type: string units: type: array items: type: object properties: dateBased: type: boolean timeBased: type: boolean durationEstimated: type: boolean duration: type: object properties: seconds: type: integer format: int64 zero: type: boolean negative: type: boolean nano: type: integer format: int32 description: the reccurence interval example: P3M repetitions: type: integer description: the number of repetitions for this reccurence format: int32 example: 42 xml: attribute: true executeMissedOrders: type: boolean xml: attribute: true description: The ReccurenceRO for this basket xml: name: Recurrence ShippingMethodRO: title: ShippingMethodRO type: object properties: name: type: string description: The name of an element example: Standard Ground type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true id: type: string description: the id of the returned element example: STD_GROUND description: type: string description: The description of the Shipping Method example: 3-7 Day Ground - Delivered to you 3-7 business days after we process your order shippingTimeMin: type: integer description: The minimum shipping time in days format: int32 example: 3 shippingTimeMax: type: integer description: The maximum shipping time in days format: int32 example: 7 description: This resource describes a shipping method that can be selected as delivery option. xml: name: ShippingMethod SurchargeRO: title: SurchargeRO type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: Surcharge xml: attribute: true amount: $ref: '#/components/schemas/MoneyRO' description: type: string description: the description of the surcharge displayName: type: string description: the display name of the surcharge taxes: type: array description: the taxes applied to the surcharge amount as collection of AppliedTaxRO xml: wrapped: true items: $ref: '#/components/schemas/AppliedTaxRO' description: This resource describes a single surcharge incurred to a shipping bucket. xml: name: Surcharge AvailableShippingMethodsRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true shippingMethods: type: array xml: wrapped: true items: $ref: '#/components/schemas/ShippingMethodRO' description: type: string xml: name: AvailableShippingMethods BasketOptionsRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true availableShippingMethods: $ref: '#/components/schemas/AvailableShippingMethodsRO' xml: name: BasketOptions CostObjectAssignmentRO: type: object properties: name: type: string description: The name of an element example: "451" type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: Project xml: name: CostObjectAssignment GenericPropertyROObject: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true key: type: string property: type: object displayName: type: string xml: name: Property PaymentRO: title: Payment type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: Payment xml: attribute: true attributes: type: array description: The list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' id: type: string description: The payment ID example: dhKsEmZRPyEAAAF2hyV6dB2n limitedTenderBalance: $ref: '#/components/schemas/MoneyRO' paymentTotalAmount: $ref: '#/components/schemas/MoneyRO' accountIdentifier: type: string description: The optional account identifier for this payment instrument readOnly: true example: DE12****7890 parameters: type: array description: The parameters for this payment xml: wrapped: true items: $ref: '#/components/schemas/GenericPropertyROObject' attribute: $ref: '#/components/schemas/ResourceAttribute' xml: name: Payment PaymentOptionRO: title: PaymentOption type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: PaymentOption xml: attribute: true id: type: string description: The ID of the payment option example: ISH_INVOICE displayName: type: string description: The display name of the payment option example: Invoice applicability: type: string example: Applicable restrictions: type: array description: The restrictions for this payment option xml: wrapped: true items: type: string xml: name: restriction paymentParameters: type: array description: The parameters for this payment option xml: name: parameters wrapped: true items: $ref: '#/components/schemas/GenericPropertyROObject' description: This resource holds information on a payment option. xml: name: PaymentOption PaymentOptionsForMethodRO: title: PaymentOptionsForMethod type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: PaymentOptionsForMethodRO xml: attribute: true payments: type: array description: The payments items: $ref: '#/components/schemas/PaymentOptionRO' method: type: string description: The HTTP method to use when adding this method example: POST description: This resource holds information about payment methods that can be added and the HTTP method to be used. xml: name: PaymentOptionsForMethodRO PaymentOptionsRO: title: PaymentOptions type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: PaymentOptions xml: attribute: true methods: type: array description: The payment methods that can be added via HTTP items: $ref: '#/components/schemas/PaymentOptionsForMethodRO' description: This resource holds one or more PaymentOptionsForMethodRO. xml: name: PaymentOptions PaymentRedirectResponseRO: title: PaymentRedirectResponse type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true example: PaymentRedirectResponse xml: attribute: true attributes: type: array description: The list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' id: type: string example: The ID parameters: type: array description: The parameters for this redirect response xml: wrapped: true items: $ref: '#/components/schemas/GenericPropertyROObject' attribute: $ref: '#/components/schemas/ResourceAttribute' xml: name: PaymentRedirectResponse PaymentRedirectRO: title: PaymentRedirect type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true example: PaymentRedirect xml: attribute: true successURL: type: string description: The URL to return to when succeeded failURL: type: string description: The URL to return to when failed cancelURL: type: string description: The URL to return to when canceled xml: name: PaymentRedirect BasketLineItemRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true sku: type: string quantity: $ref: '#/components/schemas/QuantityRO' shipToAddress: $ref: '#/components/schemas/AddressRO' shippingMethod: $ref: '#/components/schemas/ShippingMethodRO' totals: $ref: '#/components/schemas/BasketLineItemTotalsRO' salesTaxes: type: array xml: wrapped: true items: $ref: '#/components/schemas/AppliedTaxRO' shippingTaxes: type: array xml: wrapped: true items: $ref: '#/components/schemas/AppliedTaxRO' itemSurcharges: type: array xml: wrapped: true items: $ref: '#/components/schemas/SurchargeRO' itemImportSurcharges: type: array xml: wrapped: true items: $ref: '#/components/schemas/SurchargeRO' valueRebates: type: array xml: wrapped: true items: $ref: '#/components/schemas/AppliedRebateRO' shippingRebates: type: array xml: wrapped: true items: $ref: '#/components/schemas/AppliedRebateRO' product: $ref: '#/components/schemas/LinkRO' warranty: $ref: '#/components/schemas/LinkRO' giftMessage: $ref: '#/components/schemas/LinkRO' thumbnail: $ref: '#/components/schemas/LinkRO' price: $ref: '#/components/schemas/MoneyRO' singleBasePrice: $ref: '#/components/schemas/MoneyRO' id: type: string position: type: integer format: int32 isHiddenGift: type: boolean isFreeGift: type: boolean inStock: type: boolean senderName: type: string senderEmail: type: string recipientName: type: string recipientEmail: type: string greetingMessage: type: string availability: type: boolean variationProduct: type: boolean bundleProduct: type: boolean giftwrap: $ref: '#/components/schemas/LinkRO' xml: name: BasketLineItem BasketLineItemTotalsRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true total: $ref: '#/components/schemas/MoneyRO' valueRebatesTotal: $ref: '#/components/schemas/MoneyRO' shippingTotal: $ref: '#/components/schemas/MoneyRO' shippingRebatesTotal: $ref: '#/components/schemas/MoneyRO' giftingTotal: $ref: '#/components/schemas/MoneyRO' salesTaxTotal: $ref: '#/components/schemas/MoneyRO' shippingTaxTotal: $ref: '#/components/schemas/MoneyRO' xml: name: BasketLineItemTotals ExtendedLineItemCollectionRO: type: object properties: pageable: type: string description: The pageable ID total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/BasketLineItemRO' type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: The keys to sort for xml: name: sortKey quoteID: type: string name: type: string description: The name of an element xml: attribute: true xml: name: LineItems QuantityRO: title: Quantity type: object properties: type: type: string description: "This is a constant: **Quantity**" readOnly: true example: Quantity xml: attribute: true value: type: number description: The quantity's value example: 10.99 unit: type: string description: The quantity's ISO unit code. example: PIEC description: Quantity combines a quantity value and the ISO unit code the value is defined in. xml: name: Quantity ApplicableGiftMessagesRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true giftMessages: type: array xml: wrapped: true items: $ref: '#/components/schemas/LinkRO' description: type: string xml: name: ApplicableGiftMessagesRO ApplicableGiftWrapsRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true giftWraps: type: array xml: wrapped: true items: $ref: '#/components/schemas/LinkRO' description: type: string xml: name: ApplicableGiftWrapsRO AvailableProductVariationsRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true variations: type: array xml: wrapped: true items: $ref: '#/components/schemas/LinkRO' description: type: string xml: name: AvailableProductVariationsRO AvailableWarrantiesRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true warranties: type: array xml: wrapped: true items: $ref: '#/components/schemas/LinkRO' description: type: string xml: name: AvailableWarrantiesRO BasketLineItemOptionsRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true availableWarranties: $ref: '#/components/schemas/AvailableWarrantiesRO' availableVariations: $ref: '#/components/schemas/AvailableProductVariationsRO' applicableGiftMessages: $ref: '#/components/schemas/ApplicableGiftMessagesRO' applicableGiftWraps: $ref: '#/components/schemas/ApplicableGiftWrapsRO' eligibleShippingMethods: $ref: '#/components/schemas/EligibleShippingMethodsRO' xml: name: BasketLineItemOptions EligibleShippingMethodsRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true shippingMethods: type: array xml: wrapped: true items: $ref: '#/components/schemas/ShippingMethodRO' description: type: string xml: name: EligibleShippingMethodsRO BasketDependentLineItemRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true sku: type: string price: $ref: '#/components/schemas/MoneyRO' displayName: type: string id: type: string subType: type: string enum: - WARRANTY - GIFTWRAP - GIFTMESSAGE image: type: string to: type: string from: type: string message: type: string xml: name: BasketDependentLineItem responses: "200": description: OK "201": description: Created "202": description: Accepted "204": description: No Content "205": description: Reset Content "206": description: Partial Content "301": description: Moved Permanently "302": description: Found "303": description: See Other "304": description: Not Modified "305": description: Use Proxy "307": description: Temporary Redirect "400": description: Bad Request "401": description: Unauthorized "402": description: Payment Required "403": description: Forbidden "404": description: Not Found "405": description: Method Not Allowed "406": description: Not Acceptable "407": description: Proxy Authentication Required "408": description: Request Timeout "409": description: Conflict "410": description: Gone "411": description: Length Required "412": description: Precondition Failed "413": description: Request Entity Too Large "414": description: Request-URI Too Long "415": description: Unsupported Media Type "416": description: Requested Range Not Satisfiable "417": description: Expectation Failed "428": description: Precondition Required "429": description: Too Many Requests "431": description: Request Header Fields Too Large "500": description: Internal Server Error "501": description: Not Implemented "502": description: Bad Gateway "503": description: Service Unavailable "504": description: Gateway Timeout "505": description: HTTP Version Not Supported "511": description: Network Authentication Required parameters: loc: name: loc in: path description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using a\ \ underscore, e. g. ```en_US```." required: false style: matrix schema: type: string description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using\ \ a underscore, e. g. ```en_US```." default: en_US examples: en_US: description: English (United States) value: en_US fr_FR: description: French (France) value: fr_FR de_DE: description: German (Germany) value: de_DE x-matrixParamPath: / cur: name: cur in: path description: "The currency code (submitted as optional matrix parameter ```;cur=```).\ \ If omitted, the site's or user's default currency is used." required: false style: matrix schema: type: string description: "The currency code (submitted as optional matrix parameter ```;cur=```).\ \ If omitted, the site's or user's default currency is used." default: USD examples: FJD: description: Fiji Dollar value: FJD STD: description: São Tomé / Príncipe Dobra value: STD MXN: description: Mexican Peso value: MXN SCR: description: Seychelles Rupee value: SCR LVL: description: Latvian Lats value: LVL CDF: description: Congolese Franc value: CDF GTQ: description: Guatemalan Quetzal value: GTQ BBD: description: Barbados Dollar value: BBD CLP: description: Chilean Peso value: CLP UGX: description: Ugandan Shilling value: UGX HNL: description: Honduran Lempira value: HNL ZAR: description: South African Rand value: ZAR TND: description: Tunisian Dinar value: TND SLL: description: Sierra Leonean Leone value: SLL BSD: description: Bahamian Dollar value: BSD SDG: description: Sudanese Pound value: SDG IQD: description: Iraqi Dinar value: IQD GMD: description: Gambian Dalasi value: GMD CUP: description: Cuban Peso value: CUP TWD: description: New Taiwan Dollar value: TWD RSD: description: Serbian Dinar value: RSD ZRZ: description: Zaire value: ZRZ DOP: description: Dominican Peso value: DOP KMF: description: Comoro Franc value: KMF MYR: description: Malaysian Ringgit value: MYR FKP: description: Falkland Islands Pound value: FKP XOF: description: CFA Franc BCEAO value: XOF GEL: description: Lari value: GEL UYU: description: Uruguayan Peso value: UYU MAD: description: Moroccan Dirham value: MAD CVE: description: Cape Verde Escudo value: CVE TOP: description: Tongan Pa'anga value: TOP PGK: description: Papua New Guinean Kina value: PGK OMR: description: Omani Rial value: OMR AZN: description: Azerbaijanian Manat value: AZN SEK: description: Swedish Krona value: SEK KES: description: Kenyan Shilling value: KES UAH: description: Ukrainian Hryvnia value: UAH BTN: description: Ngultrum value: BTN GNF: description: Guinea Franc value: GNF MZN: description: Mozambican Metical value: MZN ERN: description: Nakfa value: ERN SVC: description: Salvadoran Colón value: SVC ARS: description: Argentine Peso value: ARS QAR: description: Qatari Riyal value: QAR NLG: description: Dutch Guilder value: NLG IRR: description: Iranian Rial value: IRR MRO: description: Mauritanian Ouguiya value: MRO XPF: description: CFP Franc value: XPF UZS: description: Uzbekistani Som value: UZS THB: description: Thai Baht value: THB CNY: description: Yuan Renminbi value: CNY BDT: description: Bangladeshi Taka value: BDT LYD: description: Libyan Dinar value: LYD BMD: description: Bermudian Dollar value: BMD PHP: description: Philippine Peso value: PHP KWD: description: Kuwaiti Dinar value: KWD RUB: description: Russian Ruble value: RUB PYG: description: Paraguayan Guarani value: PYG JMD: description: Jamaican Dollar value: JMD ISK: description: Iceland Krona value: ISK GWP: description: Guinea Peso value: GWP BEF: description: Belgian Franc value: BEF ESP: description: Spanish Peseta value: ESP COP: description: Colombian Peso value: COP USD: description: US Dollar value: USD MKD: description: Denar value: MKD DZD: description: Algerian Dinar value: DZD PAB: description: Panamanian Balboa value: PAB SGD: description: Singapore Dollar value: SGD ETB: description: Ethiopian Birr value: ETB VUV: description: Vanuatu Vatu value: VUV VEF: description: Venezuelan Bolivar Fuerte value: VEF SOS: description: Somali Shilling value: SOS KGS: description: Som value: KGS LAK: description: Lao Kip value: LAK ZMK: description: Zambian Kwacha value: ZMK BND: description: Brunei Dollar value: BND XAF: description: CFA Franc BEAC value: XAF LRD: description: Liberian Dollar value: LRD ITL: description: Italian Lira value: ITL HRK: description: Croatian Kuna value: HRK CHF: description: Swiss Franc value: CHF ATS: description: Austrian Schilling value: ATS DJF: description: Djibouti Franc value: DJF ALL: description: Albanian Lek value: ALL MTL: description: Maltese Lira value: MTL TZS: description: Tanzanian Shilling value: TZS VND: description: Vietnamese Dong value: VND AUD: description: Australian Dollar value: AUD ILS: description: New Israeli Sheqel value: ILS KPW: description: North Korean Won value: KPW GYD: description: Guyanese Dollar value: GYD GHS: description: Ghanaian Cedi value: GHS MDL: description: Moldovan Leu value: MDL KHR: description: Cambodian Riel value: KHR BOB: description: Boliviano value: BOB IDR: description: Indonesian Rupiah value: IDR KYD: description: Cayman Islands Dollar value: KYD AMD: description: Armenian Dram value: AMD TRY: description: Turkish Lira value: TRY SHP: description: Saint Helena Pound value: SHP BWP: description: Botswana Pula value: BWP LBP: description: Lebanese Pound value: LBP CYP: description: Cyprus Pound value: CYP TJS: description: Tajikistani Somoni value: TJS JOD: description: Jordanian Dinar value: JOD RWF: description: Rwanda Franc value: RWF HKD: description: Hong Kong Dollar value: HKD AED: description: United Arab Emirates Dirham value: AED EUR: description: Euro value: EUR LSL: description: Lesotho Loti value: LSL DKK: description: Danish Krone value: DKK CAD: description: Canadian Dollar value: CAD BGN: description: Bulgarian Lev value: BGN MMK: description: Kyat value: MMK EEK: description: Estonian Kroon value: EEK SYP: description: Syrian Pound value: SYP NOK: description: Norwegian Krone value: NOK MUR: description: Mauritian Rupee value: MUR ZWL: description: Zimbabwean Dollar value: ZWL GIP: description: Gibraltar Pound value: GIP RON: description: Romanian New Leu value: RON LKR: description: Sri Lankan Rupee value: LKR NGN: description: Nigerian Naira value: NGN IEP: description: Irish Pound value: IEP CZK: description: Czech Koruna value: CZK CRC: description: Costa Rican Colon value: CRC PKR: description: Pakistani Rupee value: PKR XCD: description: East Carribean Dollar value: XCD GRD: description: Greek Drachma value: GRD HTG: description: Haitian Gourde value: HTG ANG: description: Netherlands Antillian Guilder value: ANG SIT: description: Slovenian Tolar value: SIT BHD: description: Bahraini Dinar value: BHD PTE: description: Portuguese Escudo value: PTE BPP: description: Bonus Point Price value: BPP SZL: description: Swazi Lilangeni value: SZL SRD: description: Surinam Dollar value: SRD KZT: description: Kazakhstani Tenge value: KZT TTD: description: Trinidad and Tobago Dollar value: TTD SAR: description: Saudi Riyal value: SAR LTL: description: Lithuanian Litas value: LTL YER: description: Yemeni Rial value: YER MVR: description: Maldivian Rufiyaa value: MVR BPV: description: Bonus Point Value value: BPV AFN: description: Afghani value: AFN INR: description: Indian Rupee value: INR NPR: description: Nepalese Rupee value: NPR KRW: description: South Korean Won value: KRW AWG: description: Aruban Florin value: AWG MNT: description: Mongolian Tugrik value: MNT JPY: description: Japanese Yen value: JPY PLN: description: Polish Złoty value: PLN AOA: description: Angolan Kwanza value: AOA SBD: description: Solomon Islands Dollar value: SBD GBP: description: Pound Sterling value: GBP HUF: description: Hungarian Forint value: HUF BYR: description: Belarussian Ruble value: BYR LUF: description: Luxembourgian Franc value: LUF BIF: description: Burundi Franc value: BIF MWK: description: Malawian Kwacha value: MWK MGA: description: Malagasy Ariary value: MGA FIM: description: Finnish Mark value: FIM DEM: description: Deutsche Mark value: DEM BZD: description: Belize Dollar value: BZD BAM: description: Convertible Marks value: BAM MOP: description: Macanese Pataca value: MOP EGP: description: Egyptian Pound value: EGP NAD: description: Namibian Dollar value: NAD SKK: description: Slovakian Krona value: SKK NIO: description: Cordoba Oro value: NIO PEN: description: Peruvian Nuevo Sol value: PEN WST: description: Samoan Tala value: WST NZD: description: New Zealand Dollar value: NZD TMT: description: Turkmenistani Manat value: TMT FRF: description: French Franc value: FRF BRL: description: Brazilian Real value: BRL x-matrixParamPath: / regionals: name: regionals in: path required: false style: matrix schema: type: object properties: loc: type: string description: The locale ID example: en_US cur: type: string description: The currency code example: EUR x-matrixParamPath: / pgid: name: pgid in: path description: "The personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 spgid: name: spgid in: path description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 securitySchemes: basicAuth: type: http description: "Basic access authentication. In basic authentication, a request\ \ contains a header field in the form of authorization: ```Basic ```,\ \ where credentials is the Base64 encoding of ID and password joined by a\ \ single colon :." scheme: basic authToken: type: apiKey description: User authentication token to authenticate the request. The token is a string generated by the ICM server in the same header in every response of an REST endpoint. name: authentication-token in: header bearerAuth: type: http description: "Bearer token authentication. A request contains a header field\ \ in the form of authorization: ```Bearer ```, where is a string\ \ generated by an authentication service in response to a login request." scheme: bearer bearerFormat: JWT x-apiID: basket_v010 x-origin-class: "com.intershop.component.rest.capi.resource.RootResource,com.intershop.sellside.rest.common.capi.resource.basket.BasketResource,com.intershop.sellside.rest.common.capi.resource.basket.BasketResource,com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.BasketCostObjectAssignmentItemResource,com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.BasketCostObjectAssignmentItemResource,com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentRedirectResource,com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentRedirectResource,com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentRedirectResource,com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource,com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource"