openapi: 3.0.1 info: title: Basket description: "This is Intershop ICM REST API documentation. \n\nThis reference lists\ \ the REST API for storefront development. The REST API covers features of both,\ \ the B2C (SMB - Small and Medium-sized businesses) and the B2B storefront development.\ \ \nThis reference is intended for developers who want to make use of an easy-to-use\ \ API when developing frontend solutions.\nYou can find more information at [Intershop\ \ Communications](https://www.intershop.com). Contact our Intershop experts at\ \ [Support - Intershop Communications](https://www.intershop.com/en/support) \ \ \n\n# Introduction\nThis API is documented in **OpenAPI format**.\n\n" version: 1.0.0-beta 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: - smb-responsive default: '-' tags: - name: General x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.merge.BasketMergeListResource - name: Line Item x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.attribute.LineItemAttributeItemResource - name: Payment x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource paths: /baskets: get: tags: - General summary: __BETA__ | Returns the list of active baskets for the user. description: Returns the list of active baskets for the user. A basket is active if it is in status 'OPEN'. The last modified basket is the most recent and therefore the first in the result list. If user authentication fails, a 401 error with body string 'Unauthorized' is returned. operationId: getBaskets_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. style: form explode: false schema: type: array items: type: string enum: - all - buckets - commonShipToAddress - commonShippingMethod - custom - discounts - invoiceToAddress - lineItems - payments x-supported-include-type: com.intershop.sellside.rest.basket.v1.capi.resourceobject.basket.BasketRO x-include-type-custom: com.intershop.sellside.rest.basket.v1.internal.resourceobject.CustomRO x-include-type-lineItems: BasketLineItemRO_v1 x-include-type-buckets: BasketShippingBucketRO_v1 x-include-type-discounts: BasketDiscountRO_v1 x-include-type-invoiceToAddress: AddressRO_v1 x-include-type-commonShipToAddress: AddressRO_v1 x-include-type-commonShippingMethod: BasketShippingMethodRO_v1 x-include-type-payments: PaymentRO_v1 responses: 200: description: The list of active baskets. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketListCtnrRO_v1' 401: description: If the user couldn't be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.basket.BasketListResource.getBaskets_V1(java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.basket.BasketListResource post: tags: - General summary: __BETA__ | Creates a new basket for the user. description: Creates a new basket for the user. If a basket with initial data is passed, these data will be set at the newly created basket. In case this leads to validation errors, no basket is created and error 422 together with a cause desciption is returned. If user authentication fails, a 401 error with body string 'Unauthorized' is returned. operationId: createBasket_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. style: form explode: false schema: type: array items: type: string enum: - all - buckets - commonShipToAddress - commonShippingMethod - custom - discounts - invoiceToAddress - lineItems - payments x-supported-include-type: com.intershop.sellside.rest.basket.v1.capi.resourceobject.basket.BasketRO x-include-type-custom: com.intershop.sellside.rest.basket.v1.internal.resourceobject.CustomRO x-include-type-lineItems: BasketLineItemRO_v1 x-include-type-buckets: BasketShippingBucketRO_v1 x-include-type-discounts: BasketDiscountRO_v1 x-include-type-invoiceToAddress: AddressRO_v1 x-include-type-commonShipToAddress: AddressRO_v1 x-include-type-commonShippingMethod: BasketShippingMethodRO_v1 x-include-type-payments: PaymentRO_v1 requestBody: description: The object containing the initial data to be set at the new basket. content: '*/*': schema: $ref: '#/components/schemas/BasketRO_v1' responses: 201: description: The created basket. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketCtnrRO_v1' 422: description: If the basket could not be created because of semantical errors in the initial data. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketCtnrRO_v1' 401: description: If the user couldn't be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.basket.BasketListResource.createBasket_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.basket.BasketRO,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.basket.BasketListResource /baskets/{BasketResourceKey}: get: tags: - General summary: __BETA__ | Returns the basket with the given ID. description: 'Returns the basket with the given ID for the user. If no active basket with this ID is found, a 404 error will be returned. If user authentication fails, a 401 error with body string ''Unauthorized'' is returned. Error 403 is returned, if the user does not have the required access privileges. Instead of an ID "current" may be specified to retrieve the current active basket, if there is one. ' operationId: getBasket_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. style: form explode: false schema: type: array items: type: string enum: - all - buckets - commonShipToAddress - commonShippingMethod - custom - discounts - invoiceToAddress - lineItems - payments x-supported-include-type: com.intershop.sellside.rest.basket.v1.capi.resourceobject.basket.BasketRO x-include-type-custom: com.intershop.sellside.rest.basket.v1.internal.resourceobject.CustomRO x-include-type-lineItems: BasketLineItemRO_v1 x-include-type-buckets: BasketShippingBucketRO_v1 x-include-type-discounts: BasketDiscountRO_v1 x-include-type-invoiceToAddress: AddressRO_v1 x-include-type-commonShipToAddress: AddressRO_v1 x-include-type-commonShippingMethod: BasketShippingMethodRO_v1 x-include-type-payments: PaymentRO_v1 - 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: The basket with the given ID. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketCtnrRO_v1' 404: description: If no active basket is found. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketCtnrRO_v1' 401: description: If the user could not be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string 403: description: If the user does not have the required access privileges. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.basket.BasketItemResource.getBasket_V1(java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.basket.BasketItemResource delete: tags: - General summary: __BETA__ | Deletes the basket with the given ID. description: 'Deletes the basket with the given ID. Note that the basket may not be deleted immediately, but rather later on by a scheduled job. However, after calling this method, it will no longer be accessible. If no active basket with this ID is found for the user, a 404 error will be returned. If user authentication fails, a 401 error with body string ''Unauthorized'' is returned. Error 403 is returned, if the user does not have the required access privileges. Instead of an ID "current" may be specified to delete the current active basket, if there is one. ' operationId: deleteBasket_V1 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: Information message describing success status. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketCtnrRO_v1' 404: description: If a basket with the given ID is not found in the list of user baskets. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketCtnrRO_v1' 401: description: If the user could not be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string 403: description: If the user does not have the required access privileges. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.basket.BasketItemResource.deleteBasket_V1() x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.basket.BasketItemResource patch: tags: - General summary: __BETA__ | Partially updates the basket with the given ID. description: 'Partially updates the basket with the given ID. If no active basket with this ID is found for the user, a 404 error will be returned. If user authentication fails, a 401 error with body string ''Unauthorized'' is returned. Error 403 is returned, if the user does not have the required access privileges. Instead of an ID "current" may be specified to update the current active basket, if there is one. ' operationId: updateBasket_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. style: form explode: false schema: type: array items: type: string enum: - all - buckets - commonShipToAddress - commonShippingMethod - custom - discounts - invoiceToAddress - lineItems - payments x-supported-include-type: com.intershop.sellside.rest.basket.v1.capi.resourceobject.basket.BasketRO x-include-type-custom: com.intershop.sellside.rest.basket.v1.internal.resourceobject.CustomRO x-include-type-lineItems: BasketLineItemRO_v1 x-include-type-buckets: BasketShippingBucketRO_v1 x-include-type-discounts: BasketDiscountRO_v1 x-include-type-invoiceToAddress: AddressRO_v1 x-include-type-commonShipToAddress: AddressRO_v1 x-include-type-commonShippingMethod: BasketShippingMethodRO_v1 x-include-type-payments: PaymentRO_v1 - 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: description: The object containing the data to update the basket with the given ID. content: '*/*': schema: $ref: '#/components/schemas/BasketRO_v1' responses: 200: description: The updated basket content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketCtnrRO_v1' 404: description: If a basket with the given ID is not found in the list of user baskets. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketCtnrRO_v1' 401: description: If the user could not be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string 403: description: If the user does not have the required access privileges. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.basket.BasketItemResource.updateBasket_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.basket.BasketRO,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.basket.BasketItemResource /baskets/{BasketResourceKey}/addresses: get: tags: - Address summary: __BETA__ | Returns the list of addresses that have been created at the selected basket. operationId: getAddresses_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. schema: type: string default: "" x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.address.AddressRO - name: eligibleInvoiceToAddress in: query description: Whether invoice-to addresses should be included in the response or not. schema: type: boolean - name: eligibleShipToAddress in: query description: Whether ship-to addresses should be included in the response or not. schema: type: boolean - name: eligibleShipFromAddress in: query description: Whether ship-from addresses should be included in the response or not. schema: type: boolean - name: eligibleServiceToAddress in: query description: Whether service-to addresses should be included in the response or not. schema: type: boolean - name: eligibleInstallToAddress in: query description: Whether install-to addresses should be included in the response or not. schema: type: boolean - 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: The list of addresses. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AddressListCtnrRO_v1' 401: description: If the user couldn't be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressListResource.getAddresses_V1(java.lang.String,java.lang.Boolean,java.lang.Boolean,java.lang.Boolean,java.lang.Boolean,java.lang.Boolean) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressListResource post: tags: - Address summary: __BETA__ | Adds a new address to the basket. description: If a address with initial data is passed, these data will be set at the newly created address. operationId: createAddress_V1 parameters: - name: include in: query description: Related objects which are to be included with the response. schema: type: string default: "" x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.address.AddressRO - 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: description: The objects containing the initial data for creating the address. content: '*/*': schema: $ref: '#/components/schemas/AddressRO_v1' responses: 201: description: The newly created address, if it was created successfully. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AddressListCtnrRO_v1' 422: description: A list of (semantical) error messages, if the address could not be added. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/FeedbackCtnrRO_v1' 401: description: If the user couldn't be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressListResource.createAddress_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.address.AddressRO,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressListResource /baskets/{BasketResourceKey}/addresses/{AddressKey}: get: tags: - Address summary: __BETA__ | Returns the address for the given ID. description: 'Returns the address for the given ID. If no address with this ID is found, a 404 error will be returned. ' operationId: getAddress_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. schema: type: string default: "" x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.address.AddressRO - 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: AddressKey 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.basket.v1.capi.resource.address.AddressListResource responses: 200: description: The address with the given ID. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AddressCtnrRO_v1' 404: description: If an address with the given ID is not found in the basket. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/FeedbackCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressItemResource.getAddress_V1(java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressItemResource delete: tags: - Address summary: __BETA__ | Deletes the address with the given ID from the basket. description: Deletes the address with the given ID from the basket. If no address with this ID is found, a 404 error will be returned. If for some reason the address could not be removed, a 422 error will be returned. operationId: deleteAddress_V1 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: AddressKey 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.basket.v1.capi.resource.address.AddressListResource responses: 200: description: Information message describing success status. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AddressCtnrRO_v1' 404: description: If an address with the given ID is not found in the basket. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/FeedbackCtnrRO_v1' 422: description: If the address could not be deleted. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AddressCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressItemResource.deleteAddress_V1() x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressItemResource patch: tags: - Address summary: __BETA__ | Partially updates the address with the given ID. operationId: updateAddress_V1 parameters: - name: include in: query description: Related objects which are to be included with the response. schema: type: string default: "" x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.address.AddressRO - 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: AddressKey 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.basket.v1.capi.resource.address.AddressListResource requestBody: description: The object containing the data to update the address with the given ID. content: '*/*': schema: $ref: '#/components/schemas/AddressRO_v1' responses: 200: description: The updated address. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AddressCtnrRO_v1' 404: description: If a address with the given ID is not found in the basket. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/FeedbackCtnrRO_v1' 422: description: If the address could not be updated. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AddressCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressItemResource.updateAddress_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.address.AddressRO,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressItemResource /baskets/{BasketResourceKey}/addresses/{AddressKey}/attributes: get: tags: - Address summary: __BETA__ | Returns (custom) attributes for the address. operationId: getAddressAttributes_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. schema: type: string default: "" x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO - 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: AddressKey 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.basket.v1.capi.resource.address.AddressListResource responses: 200: description: The list of attributes. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeListCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.AddressAttributeListResource.getAttributes_V1(java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.attribute.AddressAttributeListResource post: tags: - Address summary: __BETA__ | Creates a new (custom) attribute at the basket address. description: Creates a new (custom) attribute at the basket address. The name of the attribute is used as identifier for the created sub resource. If an attribute with this name already exists or if an unknown type is passed or the value does not match the type, error 422 will be returned. operationId: createAddressAttribute_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. schema: type: string default: "" x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO - 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: AddressKey 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.basket.v1.capi.resource.address.AddressListResource requestBody: description: The object containing the attribute data. content: '*/*': schema: $ref: '#/components/schemas/AttributeRO_v1' responses: 201: description: The created attribute. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeCtnrRO_v1' 422: description: If the attribute could not be created because of semantic errors in the passed data. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.AddressAttributeListResource.createAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.attribute.AddressAttributeListResource /baskets/{BasketResourceKey}/addresses/{AddressKey}/attributes/{AddressAttributeKey}: delete: tags: - Address summary: __BETA__ | Deletes the attribute from the basket address. description: Deletes the attribute from the basket address. If no attribute with this name is found, a 404 error will be returned. operationId: deleteAddressAttribute_V1 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: AddressKey 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.basket.v1.capi.resource.address.AddressListResource - name: AddressAttributeKey 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.basket.v1.capi.resource.attribute.AddressAttributeListResource responses: 200: description: Information message describing success status. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeCtnrRO_v1' 404: description: If an attribute with the given name is not found in the address. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.AddressAttributeItemResource.deleteAttribute_V1() x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.attribute.AddressAttributeItemResource patch: tags: - Address summary: __BETA__ | Updates the basket address attribute. description: Updates the basket address attribute. Note that only the value may be changed; name and type of the attribute are immutable. An error with status code 422 will be returned in case the attribute could not be updated. operationId: updateAddressAttribute_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. schema: type: string default: "" x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO - 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: AddressKey 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.basket.v1.capi.resource.address.AddressListResource - name: AddressAttributeKey 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.basket.v1.capi.resource.attribute.AddressAttributeListResource requestBody: description: The object containing the attribute data. content: '*/*': schema: $ref: '#/components/schemas/AttributeRO_v1' responses: 200: description: The updated attribute. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeCtnrRO_v1' 422: description: If the attribute could not be updated because of semantic errors in the passed data. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.AddressAttributeItemResource.updateAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.attribute.AddressAttributeItemResource /baskets/{BasketResourceKey}/attributes: get: tags: - General summary: __BETA__ | Returns (custom) attributes for the basket. operationId: getBasketAttributes_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. schema: type: string default: "" x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO - 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: The list of attributes. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeListCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.BasketAttributeListResource.getAttributes_V1(java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.attribute.BasketAttributeListResource post: tags: - General summary: __BETA__ | Creates a new (custom) attribute at the basket. description: Creates a new (custom) attribute at the basket. The name of the attribute is used as identifier for the created sub resource. If an attribute with this name already exists or if an unknown type is passed or the value does not match the type, error 422 will be returned. operationId: createBasketAttribute_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. schema: type: string default: "" x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO - 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: description: The object containing the attribute data. content: '*/*': schema: $ref: '#/components/schemas/AttributeRO_v1' responses: 201: description: The created attribute. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeCtnrRO_v1' 422: description: If the attribute could not be created because of semantic errors in the passed data. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.BasketAttributeListResource.createAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.attribute.BasketAttributeListResource /baskets/{BasketResourceKey}/attributes/{BasketAttributeKey}: delete: tags: - General summary: __BETA__ | Deletes the attribute from the basket. description: Deletes the attribute from the basket. If no attribute with this name is found, a 404 error will be returned. operationId: deleteBasketAttribute_V1 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: BasketAttributeKey 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.basket.v1.capi.resource.attribute.BasketAttributeListResource responses: 200: description: Information message describing success status. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeCtnrRO_v1' 404: description: If an attribute with the given name is not found in the basket. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.BasketAttributeItemResource.deleteAttribute_V1() x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.attribute.BasketAttributeItemResource patch: tags: - General summary: __BETA__ | Updates the basket attribute. description: Updates the basket attribute. Note that only the value may be changed; name and type of the attribute are immutable. An error with status code 422 will be returned in case the attribute could not be updated. operationId: updateBasketAttribute_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. schema: type: string default: "" x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO - 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: BasketAttributeKey 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.basket.v1.capi.resource.attribute.BasketAttributeListResource requestBody: description: The object containing the attribute data. content: '*/*': schema: $ref: '#/components/schemas/AttributeRO_v1' responses: 200: description: The updated attribute. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeCtnrRO_v1' 422: description: If the attribute could not be updated because of semantic errors in the passed data. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.BasketAttributeItemResource.updateAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.attribute.BasketAttributeItemResource /baskets/{BasketResourceKey}/buckets: get: tags: - Shipping Bucket summary: __BETA__ | Returns the list of shipping buckets for the selected basket. description: Returns the list of shipping buckets for the selected basket. Note that buckets are built dynamically and are not persisted. Bucket assignments and IDs could change if items are moved to a different bucket (by changing ship-to address or shipping method of a line item). It is therefore recommended to always retrieve the list of buckets before performing any operation on a single bucket. operationId: getShippingBuckets_V1 parameters: - name: include in: query description: Related objects which are to be included with the response. style: form explode: false schema: type: array items: type: string enum: - all - discounts - shipToAddress - shippingMethod x-supported-include-type: com.intershop.sellside.rest.basket.v1.capi.resourceobject.shipping.ShippingBucketRO x-include-type-discounts: BasketDiscountRO_v1 x-include-type-shipToAddress: AddressRO_v1 x-include-type-shippingMethod: BasketShippingMethodRO_v1 - 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: The list of shipping buckets. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketShippingBucketListCtnrRO_v1' 401: description: If the user couldn't be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.shipping.ShippingBucketListResource.getShippingBuckets_V1(java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.shipping.ShippingBucketListResource /baskets/{BasketResourceKey}/buckets/{ShippingBucketKey}: get: tags: - Shipping Bucket summary: __BETA__ | Returns the shipping bucket with the given ID. description: Returns the shipping bucket with the given ID. If no shipping bucket with this ID is found, a 404 error will be returned. Note that this could also mean that items have been added or removed from the bucket, as buckets are not persisted and IDs are determined dynamically through a hash over all items in the bucket. If such changes occur, the shipping bucket list needs to be retrieved again before working on single buckets. operationId: getShippingBucket_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. style: form explode: false schema: type: array items: type: string enum: - all - discounts - shipToAddress - shippingMethod x-supported-include-type: com.intershop.sellside.rest.basket.v1.capi.resourceobject.shipping.ShippingBucketRO x-include-type-discounts: BasketDiscountRO_v1 x-include-type-shipToAddress: AddressRO_v1 x-include-type-shippingMethod: BasketShippingMethodRO_v1 - 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: ShippingBucketKey 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.basket.v1.capi.resource.shipping.ShippingBucketListResource responses: 200: description: The shipping bucket. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketShippingBucketCtnrRO_v1' 404: description: If a shipping bucket with the given ID is not found in the basket. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketShippingBucketCtnrRO_v1' 401: description: If the user couldn't be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.shipping.ShippingBucketItemResource.getShippingBucket_V1(java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.shipping.ShippingBucketItemResource patch: tags: - Shipping Bucket summary: __BETA__ | Updates the shipping bucket with the given ID. description: Updates the shipping bucket with the given ID. If no shipping bucket with this ID is found, a 404 error will be returned. If for some reason the shipping bucket could not be updated, a 422 error will be returned. Note that manipulating the shipping bucket may cause a change in the shipping bucket ID, as IDs are determined dynamically through a hash over all items in the bucket. This means a bucket with a different ID may be returned in the response (e. g. when multiple shipping buckets are merged by changing the ship-to address or shipping method). When this happens, the whole shipping bucket list should be retrieved again before displaying it the next time (as other buckets may havebeen changed or removed as well). operationId: updateShippingBucket_V1 parameters: - name: include in: query description: Related objects which are to be included with the response. style: form explode: false schema: type: array items: type: string enum: - all - discounts - shipToAddress - shippingMethod x-supported-include-type: com.intershop.sellside.rest.basket.v1.capi.resourceobject.shipping.ShippingBucketRO x-include-type-discounts: BasketDiscountRO_v1 x-include-type-shipToAddress: AddressRO_v1 x-include-type-shippingMethod: BasketShippingMethodRO_v1 - 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: ShippingBucketKey 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.basket.v1.capi.resource.shipping.ShippingBucketListResource requestBody: description: The object containing the data to update the shipping bucket with the given ID. content: '*/*': schema: $ref: '#/components/schemas/BasketShippingBucketRO_v1' responses: 200: description: Information message describing success status. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketShippingBucketCtnrRO_v1' 404: description: If a shipping bucket with the given ID is not found in the basket. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/FeedbackCtnrRO_v1' 422: description: If the shipping bucket could not be updated. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketShippingBucketCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.shipping.ShippingBucketItemResource.updateShippingBucket_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.shipping.ShippingBucketRO,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.shipping.ShippingBucketItemResource /baskets/{BasketResourceKey}/buckets/{ShippingBucketKey}/eligible-shipping-methods: get: tags: - Shipping Method summary: __BETA__ | Returns the list of shipping methods that are eligible for the selected shipping bucket. description: Returns the list of shipping methods that are eligible for the selected shipping bucket. This will only return common shipping methods that are valid for all line items in the shipping bucket. operationId: getShippingBucketEligibleShippingMethods_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. schema: type: string default: "" x-supported-include-type: com.intershop.sellside.rest.basket.v1.capi.resourceobject.shipping.ShippingMethodRO - 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: ShippingBucketKey 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.basket.v1.capi.resource.shipping.ShippingBucketListResource responses: 200: description: The list of eligible shipping methods. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketShippingMethodListCtnrRO_v1' 401: description: If the user couldn't be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.shipping.ShippingBucketEligibleShippingMethodListResource.getEligibleShippingMethods_V1(java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.shipping.ShippingBucketEligibleShippingMethodListResource /baskets/{BasketResourceKey}/eligible-addresses: get: tags: - Address summary: __BETA__ | Returns the list of eligible addresses that can be set at the selected basket. description: Returns the list of eligible addresses that can be set as invoice-to or ship-to addresses at the selected basket. This may include addresses created at the basket or at the customer. operationId: getEligibleAddresses_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. schema: type: string default: "" x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.address.AddressRO - name: eligibleInvoiceToAddress in: query description: Whether invoice-to addresses should be included in the response or not. schema: type: boolean - name: eligibleShipToAddress in: query description: Whether ship-to addresses should be included in the response or not. schema: type: boolean - name: eligibleShipFromAddress in: query description: Whether ship-from addresses should be included in the response or not. schema: type: boolean - name: eligibleServiceToAddress in: query description: Whether service-to addresses should be included in the response or not. schema: type: boolean - name: eligibleInstallToAddress in: query description: Whether install-to addresses should be included in the response or not. schema: type: boolean - 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: The list of eligible addresses. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AddressListCtnrRO_v1' 401: description: If the user couldn't be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.address.EligibleAddressListResource.getAddresses_V1(java.lang.String,java.lang.Boolean,java.lang.Boolean,java.lang.Boolean,java.lang.Boolean,java.lang.Boolean) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.address.EligibleAddressListResource /baskets/{BasketResourceKey}/eligible-payment-methods: get: tags: - Payment summary: __BETA__ | Returns the list of payment methods that are eligible for the selected basket. description: Returns the list of payment methods that are eligible for the selected basket. If there are no eligible payment methods available, an empty list will be returned. operationId: getEligiblePaymentMethods_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. style: form explode: false schema: type: array items: type: string enum: - all - paymentInstruments x-supported-include-type: com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentMethodRO x-include-type-paymentInstruments: PaymentInstrumentRO_v1 - 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: The list of eligible payment methods. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/PaymentMethodListCtnrRO_v1' 401: description: If the user couldn't be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource.getEligiblePaymentMethods_V1(java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource /baskets/{BasketResourceKey}/eligible-shipping-methods: get: tags: - Shipping Method summary: __BETA__ | Returns the list of shipping methods that are eligible for the selected basket. description: Returns the list of shipping methods that are eligible for the selected basket. This will only return common shipping methods that are valid for all line items. If there are no common shipping methods, an empty list will be returned. operationId: getBasketEligibleShippingMethods_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. schema: type: string default: "" x-supported-include-type: com.intershop.sellside.rest.basket.v1.capi.resourceobject.shipping.ShippingMethodRO - 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: The list of eligible shipping methods. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketShippingMethodListCtnrRO_v1' 401: description: If the user couldn't be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.shipping.BasketEligibleShippingMethodListResource.getEligibleShippingMethods_V1(java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.shipping.BasketEligibleShippingMethodListResource /baskets/{BasketResourceKey}/items: get: tags: - Line Item summary: __BETA__ | Returns the list of line items for the selected basket. operationId: getLineItems_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. style: form explode: false schema: type: array items: type: string enum: - all - discounts - product - shipToAddress - shippingMethod - warranty x-supported-include-type: com.intershop.sellside.rest.basket.v1.capi.resourceobject.lineitem.LineItemRO x-include-type-discounts: BasketDiscountRO_v1 x-include-type-product: BasketProductRO_v1 x-include-type-shipToAddress: AddressRO_v1 x-include-type-shippingMethod: BasketShippingMethodRO_v1 x-include-type-warranty: BasketWarrantyRO_v1 - 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 - The list of line items. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketLineItemListCtnrRO_v1' 401: description: Unauthorized - The user could not be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemListResource.getLineItems_V1(java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemListResource post: tags: - Line Item summary: __BETA__ | Adds one or more products to the basket description: Adds one or more products to the basket. This creates new line items in the basket or, if a product already exists in the basket and merging is configured, increases the quantity of an existing line item. Note that this request may succeed partially, i. e. if three products are to be added and one fails because of semantical errors, the other two will still be added to the basket. operationId: createLineItems_V1 parameters: - name: include in: query description: Related objects which are to be included with the response style: form explode: false schema: type: array items: type: string enum: - all - discounts - product - shipToAddress - shippingMethod - warranty x-supported-include-type: com.intershop.sellside.rest.basket.v1.capi.resourceobject.lineitem.LineItemRO x-include-type-discounts: BasketDiscountRO_v1 x-include-type-product: BasketProductRO_v1 x-include-type-shipToAddress: AddressRO_v1 x-include-type-shippingMethod: BasketShippingMethodRO_v1 x-include-type-warranty: BasketWarrantyRO_v1 - 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: description: The objects containing the initial data for creating the line items content: '*/*': schema: type: array items: $ref: '#/components/schemas/BasketLineItemRO_v1' responses: 207: description: Some items could not be added.This response will be returned if there are different response codes for individual items. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketLineItemListCtnrRO_v1' 200: description: OK - The line items were successfully merged. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketLineItemListCtnrRO_v1' 201: description: Created - All line items were created successfully. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketLineItemListCtnrRO_v1' 422: description: Unprocessable Entity - No product could be added. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketLineItemListCtnrRO_v1' 401: description: Unauthorized - The user could not be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemListResource.createLineItems_V1(java.util.List,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemListResource delete: tags: - Line Item summary: __BETA__ | Deletes all line items for the selected basket description: Deletes all line items from a basket with a given basket ID. operationId: deleteLineItems_V1 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 - The basket line items were deleted. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketLineItemCtnrRO_v1' 404: description: Not found - A basket with the given ID could not be found. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketLineItemCtnrRO_v1' 422: description: Unprocessable Entity - The line item(s) could not be deleted. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketLineItemCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemListResource.deleteLineItems_V1() x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemListResource /baskets/{BasketResourceKey}/items/{BasketLineKey}: get: tags: - Line Item summary: __BETA__ | Returns the line item for the given ID. description: 'Returns the line item for the given ID. If no line item with this ID is found, a 404 error will be returned. ' operationId: getLineItem_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. style: form explode: false schema: type: array items: type: string enum: - all - discounts - product - shipToAddress - shippingMethod - warranty x-supported-include-type: com.intershop.sellside.rest.basket.v1.capi.resourceobject.lineitem.LineItemRO x-include-type-discounts: BasketDiscountRO_v1 x-include-type-product: BasketProductRO_v1 x-include-type-shipToAddress: AddressRO_v1 x-include-type-shippingMethod: BasketShippingMethodRO_v1 x-include-type-warranty: BasketWarrantyRO_v1 - 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: Information message describing success status. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketLineItemCtnrRO_v1' 404: description: If a line item with the given ID is not found in the basket. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketLineItemCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemItemResource.getLineItem_V1(java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemItemResource delete: tags: - Line Item summary: __BETA__ | Deletes the line item with the given ID from the basket. description: Deletes the line item with the given ID from the basket. If no line item with this ID is found, a 404 error will be returned. If for some reason the line item could not be removed, a 422 error will be returned. operationId: deleteLineItem_V1 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: Information message describing success status. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketLineItemCtnrRO_v1' 404: description: If a line item with the given ID is not found in the basket. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketLineItemCtnrRO_v1' 422: description: If the line item could not be deleted. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketLineItemCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemItemResource.deleteLineItem_V1() x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemItemResource patch: tags: - Line Item summary: __BETA__ | Partially updates the lineitem with the given ID. description: Partially updates the lineitem with the given ID. If no line item with this ID is found, a 404 error will be returned. If for some reason the line item could not be updated, a 422 error will be returned. operationId: updateLineItem_V1 parameters: - name: include in: query description: Related objects which are to be included with the response. style: form explode: false schema: type: array items: type: string enum: - all - discounts - product - shipToAddress - shippingMethod - warranty x-supported-include-type: com.intershop.sellside.rest.basket.v1.capi.resourceobject.lineitem.LineItemRO x-include-type-discounts: BasketDiscountRO_v1 x-include-type-product: BasketProductRO_v1 x-include-type-shipToAddress: AddressRO_v1 x-include-type-shippingMethod: BasketShippingMethodRO_v1 x-include-type-warranty: BasketWarrantyRO_v1 - 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: description: The object containing the data to update the lineitem with the given ID. content: '*/*': schema: $ref: '#/components/schemas/BasketLineItemRO_v1' responses: 200: description: Information message describing success status. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketLineItemCtnrRO_v1' 404: description: If a line item with the given ID is not found in the basket. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketLineItemCtnrRO_v1' 422: description: If the line item could not be updated. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketLineItemCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemItemResource.updateLineItem_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.lineitem.LineItemRO,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemItemResource /baskets/{BasketResourceKey}/items/{BasketLineKey}/attributes: get: tags: - Line Item summary: __BETA__ | Returns (custom) attributes for the line item. operationId: getLineItemAttributes_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. schema: type: string default: "" x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO - 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: The list of attributes. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeListCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.LineItemAttributeListResource.getAttributes_V1(java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.attribute.LineItemAttributeListResource post: tags: - Line Item summary: __BETA__ | Creates a new (custom) attribute at the line item. description: Creates a new (custom) attribute at the line item. The name of the attribute is used as identifier for the created sub resource. If an attribute with this name already exists or if an unknown type is passed or the value does not match the type, error 422 will be returned. operationId: createLineItemAttribute_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. schema: type: string default: "" x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO - 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: description: The object containing the attribute data. content: '*/*': schema: $ref: '#/components/schemas/AttributeRO_v1' responses: 201: description: The created attribute. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeCtnrRO_v1' 422: description: If the attribute could not be created because of semantic errors in the passed data. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.LineItemAttributeListResource.createAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.attribute.LineItemAttributeListResource /baskets/{BasketResourceKey}/items/{BasketLineKey}/attributes/{LineItemAttributeKey}: delete: tags: - Line Item summary: __BETA__ | Deletes the attribute from the line item. description: Deletes the attribute from the line item. If no attribute with this name is found, a 404 error will be returned. operationId: deleteLineItemAttribute_V1 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 - name: LineItemAttributeKey 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.basket.v1.capi.resource.attribute.LineItemAttributeListResource responses: 200: description: Information message describing success status. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeCtnrRO_v1' 404: description: If an attribute with the given name is not found in the line item. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.LineItemAttributeItemResource.deleteAttribute_V1() x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.attribute.LineItemAttributeItemResource patch: tags: - Line Item summary: __BETA__ | Updates the line item attribute. description: Updates the line item attribute. Note that only the value may be changed; name and type of the attribute are immutable. An error with status code 422 will be returned in case the attribute could not be updated. operationId: updateLineItemAttribute_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. schema: type: string default: "" x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO - 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 - name: LineItemAttributeKey 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.basket.v1.capi.resource.attribute.LineItemAttributeListResource requestBody: description: The object containing the attribute data. content: '*/*': schema: $ref: '#/components/schemas/AttributeRO_v1' responses: 200: description: The updated attribute. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeCtnrRO_v1' 422: description: If the attribute could not be updated because of semantic errors in the passed data. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/AttributeCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.LineItemAttributeItemResource.updateAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.attribute.LineItemAttributeItemResource /baskets/{BasketResourceKey}/items/{BasketLineKey}/eligible-shipping-methods: get: tags: - Shipping Method summary: __BETA__ | Returns the list of shipping methods that are eligible for the selected line item. description: Returns the list of shipping methods that are eligible for the selected line item. operationId: getLineItemEligibleShippingMethods_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. schema: type: string default: "" x-supported-include-type: com.intershop.sellside.rest.basket.v1.capi.resourceobject.shipping.ShippingMethodRO - 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: The list of eligible shipping methods. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketShippingMethodListCtnrRO_v1' 401: description: If the user couldn't be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.shipping.LineItemEligibleShippingMethodListResource.getEligibleShippingMethods_V1(java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.shipping.LineItemEligibleShippingMethodListResource /baskets/{BasketResourceKey}/merges: post: tags: - General summary: __BETA__ | Merge the basket with an other basket. description: 'Merge the basket (target basket) with an other basket (source basket). In that case, the source basket owner is not registered and the corresponding authentication token is not part of the payload, the source basket will be anonymized. Merge objects are the line items, recurrence information, and the affiliate informations. If the corresponding authentication token is part of the payload, the source basket will not be anonymized. In that case, the source basket owner is registered and is equals to the target basket owner, line items, addresses, recurrence information, promotion codes and affiliate informations will be merged. Generally not included in scope are the payments of the source basket. The source basket will removed after merge unless the payload of the request contains information to suppress this behavior.If no active basket with this ID is found for the user, a 404 error will be returned. If during the processing of the request a failure occurred, a 422 error with specific error cause is returned. Possible error keys are "basket.not_found.error", "basket.merge.invalid_token.error", "basket.merge.token_is_expired.error","basket.merge.source_basket_user_is_registered.error".Instead of an ID "current" may be specified to update the current active basket, if there is one. ' operationId: mergeBasket_V1 parameters: - name: include in: query description: Related objects which are to be included with the response. style: form explode: false schema: type: array items: type: string enum: - all - targetBasket x-supported-include-type: com.intershop.sellside.rest.basket.v1.capi.resourceobject.merge.BasketMergeRO x-include-type-targetBasket: BasketRO_v1 - 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: description: The object containing merge information like basket id and authentication token. content: '*/*': schema: $ref: '#/components/schemas/BasketMergeRO.v1' responses: 201: description: The merge data content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketMergeCtnrRO.v1' 404: description: If a basket with the given ID is not found in the list of user baskets. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketMergeCtnrRO.v1' 422: description: If during the processing of the request a failure occurred, a 422 error with specific error cause is returned. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketMergeCtnrRO.v1' 401: description: If the user could not be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.merge.BasketMergeListResource.mergeBasket_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.merge.BasketMergeRO,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.merge.BasketMergeListResource /baskets/{BasketResourceKey}/payment-instruments: post: tags: - Payment summary: __BETA__ | Adds a payment instrument to the basket. description: Adds a payment instrument to the basket. This creates new payment instrument in the basket. operationId: createPaymentInstrument_V1 parameters: - name: include in: query description: Related objects which are to be included with the response. style: form explode: false schema: type: array items: type: string enum: - all - paymentMethod x-supported-include-type: com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentInstrumentRO x-include-type-paymentMethod: PaymentMethodRO_v1 - 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: description: The objects containing the initial data for creating a payment instrument. content: '*/*': schema: $ref: '#/components/schemas/PaymentInstrumentRO_v1' responses: 201: description: The newly created payment instrument with the data provided. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/PaymentInstrumentCtnrRO_v1' 422: description: A list of (semantical) error messages, if the payment instrument could not be created. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/FeedbackCtnrRO_v1' 401: description: If the user couldn't be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentInstrumentListResource.createPaymentInstrument_V1(com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentInstrumentRO,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentInstrumentListResource /baskets/{BasketResourceKey}/payment-instruments/{PaymentInstrumentKey}: delete: tags: - Payment summary: __BETA__ | Deletes the payment instrument with the given ID description: This operation deletes the payment instrument with the given ID. If no payment instrument with this ID is found, a 404 error will be returned. operationId: deletePaymentInstrument_V1 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: PaymentInstrumentKey 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.basket.v1.capi.resource.payment.PaymentInstrumentListResource responses: 200: description: Information message describing success status. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/PaymentInstrumentCtnrRO_v1' 404: description: A payment instrument with the given ID was not found. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/PaymentInstrumentCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentInstrumentItemResource.deletePaymentInstrument_V1() x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentInstrumentItemResource patch: tags: - Payment summary: __BETA__ | Partially updates the payment instrument with the given ID description: This operation updates the payment instrument with the given ID partially. If no payment instrument with this ID is found, a 404 error will be returned. operationId: updatePaymentInstrument_V1 parameters: - name: include in: query description: Related objects which are to be retrieved with the response. style: form explode: false schema: type: array items: type: string enum: - all - paymentMethod x-supported-include-type: com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentInstrumentRO x-include-type-paymentMethod: PaymentMethodRO_v1 - 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: PaymentInstrumentKey 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.basket.v1.capi.resource.payment.PaymentInstrumentListResource requestBody: description: The objects containing updated data for the payment instrument. content: '*/*': schema: $ref: '#/components/schemas/PaymentInstrumentRO_v1' responses: 200: description: Information message describing success status. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/PaymentInstrumentCtnrRO_v1' 404: description: A payment instrument with the given ID was not found. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/PaymentInstrumentCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentInstrumentItemResource.updatePaymentInstrument_V1(com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentInstrumentRO,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentInstrumentItemResource /baskets/{BasketResourceKey}/payments: get: tags: - Payment summary: __BETA__ | Returns the list of payments assigned to the current basket. operationId: getPayments_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. style: form explode: false schema: type: array items: type: string enum: - all - paymentInstrument - paymentMethod x-supported-include-type: com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentRO x-include-type-paymentInstrument: PaymentInstrumentRO_v1 x-include-type-paymentMethod: PaymentMethodRO_v1 - 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: The list of payments. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/PaymentCtnrRO_v1' 401: description: If the user couldn't be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentListResource.getPayments_V1(java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentListResource post: tags: - Payment summary: __BETA__ | Creates a new payment from a given payment instrument. description: Creates a new payment in the given basket using the payment instrument from the request payload. This can be used to create payments for limited tender payment instruments (e. g. gift cards) as well as for open tender payment instruments (e. g. credit cards). However, the request will still fail with an "422 Unprocessable Entity" error when trying to create an open tender payment when there already is an open tender payment in the basket. If an open tender payment is to be replaced, use the "PUT" method on the item resource with ID "open-tender". An open tender payment can also not be created if the basket is already fully covered by limited tender payments. If a limited tender payment is to be created and an open tender payment is already present, then the latter may be removed if the limited tender fully covers the basket; in that case no further limited tender payments can be created afterwards. In general, limited tender payments always have a higher priority than open tenders. If the payment could not be created for other reasons, a "422 Unprocessable Entity" error with a specific error message will also be returned. In case that the applied payment instrument supports redirect, it is possible to append success, cancel and failure redirect URL. Otherwise it is ignored. operationId: createPayment_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. style: form explode: false schema: type: array items: type: string enum: - all - paymentInstrument - paymentMethod x-supported-include-type: com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentRO x-include-type-paymentInstrument: PaymentInstrumentRO_v1 x-include-type-paymentMethod: PaymentMethodRO_v1 - 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: description: The object containing the initial data for creating the payment. content: '*/*': schema: $ref: '#/components/schemas/PaymentRO_v1' responses: 201: description: Information message describing success status. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/PaymentCtnrRO_v1' 422: description: If the payment could not be created. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/PaymentCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentListResource.createPayment_V1(com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentRO,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentListResource /baskets/{BasketResourceKey}/payments/{BasketPaymentKey}: put: tags: - Payment summary: __BETA__ | Creates (or replaces) the payment with the given ID. description: Creates (or replaces) the payment with the given ID. If the payment could not be created, a 422 error will be returned. Note that this will only work for open tender payments, i. e. where the ID is 'open-tender'. Other payments are not supported via this method and a 405 error will be returned for those. An open tender payment can only be created, if the basket is not already fully covered by limited tenders. For creating a new limited tender payment, use the POST method on the list resource. Updating or replacing an existing limited tender payment is never supported, it needs to be deleted and re-created.In case that the applied payment instrument supports redirect, it is possible to append success, cancel and failure redirect URL. Otherwise it is ignored. operationId: replacePayment_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. style: form explode: false schema: type: array items: type: string enum: - all - paymentInstrument - paymentMethod x-supported-include-type: com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentRO x-include-type-paymentInstrument: PaymentInstrumentRO_v1 x-include-type-paymentMethod: PaymentMethodRO_v1 - 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: description: The object containing the initial data for creating the payment. content: '*/*': schema: $ref: '#/components/schemas/PaymentRO_v1' responses: 201: description: Information message describing success status. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/PaymentCtnrRO_v1' 422: description: If the payment could not be created. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/PaymentCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentItemResource.replacePayment_V1(com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentRO,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentItemResource delete: tags: - Payment summary: __BETA__ | Deletes the payment with the given ID. description: Deletes the payment with the given ID. If no payment with this ID is found, a 404 error will be returned. operationId: deletePayment_V1 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: Information message describing success status. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/PaymentCtnrRO_v1' 404: description: If a payment with the given ID is not found. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/PaymentCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentItemResource.deletePayment_V1() x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentItemResource patch: tags: - Payment summary: __BETA__ | Updates the payment. description: Updates the payment. If the payment could not be updated, a 422 error will be returned. Note that this will only allow to set/update redirect data, e.g. the return URLS'. Other changes are not supported and will be ignored. operationId: updatePayment_V1 parameters: - name: include in: query description: Related objects (as a comma separated list) which are to be included with the response. style: form explode: false schema: type: array items: type: string enum: - all - paymentInstrument - paymentMethod x-supported-include-type: com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentRO x-include-type-paymentInstrument: PaymentInstrumentRO_v1 x-include-type-paymentMethod: PaymentMethodRO_v1 - 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: description: The object containing the updated redirect data for the payment. content: '*/*': schema: $ref: '#/components/schemas/PaymentRO_v1' responses: 200: description: Information message describing success status. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/PaymentCtnrRO_v1' 422: description: If the payment could not be updated. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/PaymentCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentItemResource.updatePayment_V1(com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentRO,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentItemResource /baskets/{BasketResourceKey}/promotioncodes: get: tags: - Promotion Code summary: __BETA__ | Returns the list of promotion codes that have been applied at the selected basket. operationId: getPromotionCodes_V1 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: The list of promotion codes. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/ContainerRO_v1' 401: description: If the user couldn't be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.promotion.BasketPromotionCodeListResource.getPromotionCodes_V1() x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.promotion.BasketPromotionCodeListResource post: tags: - Promotion Code summary: __BETA__ | Adds a promotion code to the basket. operationId: addPromotionCode_V1 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: description: The promotion code to add. content: '*/*': schema: $ref: '#/components/schemas/BasketPromotionCodeRO_v1' responses: 201: description: The newly added promotion code, if it was added successfully. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/ContainerRO_v1' 422: description: A list of (semantical) error messages, if the promotion code could not be added. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/FeedbackCtnrRO_v1' 401: description: If the user couldn't be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.promotion.BasketPromotionCodeListResource.addPromotionCode_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.promotion.PromotionCodeRO) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.promotion.BasketPromotionCodeListResource /baskets/{BasketResourceKey}/promotioncodes/{BasketPromotionCodeKey}: get: tags: - Promotion Code summary: __BETA__ | Returns the promotion code data for the given promotion code string. description: 'Returns the promotion code data for the given promotion code string. If no promotion code with this string is found, a 404 error will be returned. ' operationId: getPromotionCode_V1 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: BasketPromotionCodeKey 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.basket.v1.capi.resource.promotion.BasketPromotionCodeListResource responses: 200: description: The promotion code data for the given promotion code string. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/ContainerRO_v1' 404: description: If a promotion code with the given string is not found in the basket. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/FeedbackCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.promotion.BasketPromotionCodeItemResource.getPromotionCode_V1() x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.promotion.BasketPromotionCodeItemResource delete: tags: - Promotion Code summary: __BETA__ | Removes the promotion code with the given string from the basket. description: Removes the promotion code with the given string from the basket. If no address with this string is found, a 404 error will be returned. operationId: removePromotionCode_V1 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: BasketPromotionCodeKey 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.basket.v1.capi.resource.promotion.BasketPromotionCodeListResource responses: 204: description: Information message describing success status. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/ContainerRO_v1' 404: description: If an promotion code with the given ID is not found in the basket. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/FeedbackCtnrRO_v1' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.promotion.BasketPromotionCodeItemResource.removePromotionCode_V1() x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.promotion.BasketPromotionCodeItemResource /baskets/{BasketResourceKey}/validations: post: tags: - General summary: __BETA__ | Validates the basket. description: Triggers a validation of the basket and returns the validation errors. Optionally, the basket is adjusted automatically (e. g. to remove unavailable line items). operationId: validateBasket_V1 parameters: - name: include in: query description: Related objects which are to be included with the response. style: form explode: false schema: type: array items: type: string enum: - all - basket x-supported-include-type: com.intershop.sellside.rest.basket.v1.capi.resourceobject.validation.BasketValidationRO x-include-type-basket: BasketRO_v1 - 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: description: The object containing the validation parameters. content: '*/*': schema: $ref: '#/components/schemas/BasketValidationRO_v1' responses: 201: description: Returns the result of the validation. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/BasketValidationCtnrRO_v1' 422: description: Returns a list of (semantical) error messages, if the validation could not be executed. content: application/vnd.intershop.basket.v1+json: schema: $ref: '#/components/schemas/FeedbackCtnrRO_v1' 401: description: Returns an error, if the user couldn't be authenticated. content: application/vnd.intershop.basket.v1+json: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.validation.BasketValidationListResource.validateBasket_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.validation.BasketValidationRO,java.lang.String) x-origin-class: com.intershop.sellside.rest.basket.v1.capi.resource.validation.BasketValidationListResource components: schemas: ApprovalCostCenterRO_v1: type: object properties: approvers: type: array description: The cost center approvers. items: $ref: '#/components/schemas/ApprovalUserRO_v1' costCenterID: type: string description: The cost center ID. costCenterName: type: string description: The cost center name. description: A representation of a cost center approval ApprovalCustomerRO_v1: type: object properties: approvers: type: array description: The customer approvers. items: $ref: '#/components/schemas/ApprovalUserRO_v1' description: A representation of a customer approval ApprovalRO_v1: type: object properties: approvalRequired: type: boolean description: Flag indicating that this basket needs an approval. example: true costCenterApproval: $ref: '#/components/schemas/ApprovalCostCenterRO_v1' customerApproval: $ref: '#/components/schemas/ApprovalCustomerRO_v1' description: A representation of a basket approval ApprovalUserRO_v1: type: object properties: email: type: string description: The email address of the person represented by this user. example: Merkel@test.intershop.de firstName: type: string description: The given name (also known as a personal name, first name, forename) of the person represented by this user. example: Peter lastName: type: string description: The surname (also known as a family name, last name) of the person represented by this user. example: Merkel title: type: string description: The personal title, like Ms., Mr. example: Mr. description: Represents an approval user item. AttributeRO_v1: required: - name - type type: object properties: name: type: string description: The name of an element. type: type: string description: 'The type of the object. This is normally a **constant** that can be used to differentiate objects by their type. ' enum: - Boolean - Date - Decimal - Double - Integer - Long - Money - Quantity - String - Text - MultipleBoolean - MultipleDate - MultipleDecimal - MultipleDouble - MultipleInteger - MultipleLong - MultipleString value: type: object description: A representation of an attribute. discriminator: propertyName: type mapping: Boolean: '#/components/schemas/BooleanAttributeRO_v1' Date: '#/components/schemas/DateAttributeRO_v1' Decimal: '#/components/schemas/DecimalAttributeRO_v1' Double: '#/components/schemas/DoubleAttributeRO_v1' Integer: '#/components/schemas/IntegerAttributeRO_v1' Long: '#/components/schemas/LongAttributeRO_v1' Money: '#/components/schemas/MoneyAttributeRO_v1' Quantity: '#/components/schemas/QuantityAttributeRO_v1' String: '#/components/schemas/StringAttributeRO_v1' Text: '#/components/schemas/TextAttributeRO_v1' MultipleBoolean: '#/components/schemas/MultipleBooleanAttributeRO_v1' MultipleDate: '#/components/schemas/MultipleDateAttributeRO_v1' MultipleDecimal: '#/components/schemas/MultipleDecimalAttributeRO_v1' MultipleDouble: '#/components/schemas/MultipleDoubleAttributeRO_v1' MultipleInteger: '#/components/schemas/MultipleIntegerAttributeRO_v1' MultipleLong: '#/components/schemas/MultipleLongAttributeRO_v1' MultipleString: '#/components/schemas/MultipleStringAttributeRO_v1' oneOf: - $ref: '#/components/schemas/BooleanAttributeRO_v1' - $ref: '#/components/schemas/DateAttributeRO_v1' - $ref: '#/components/schemas/DecimalAttributeRO_v1' - $ref: '#/components/schemas/DoubleAttributeRO_v1' - $ref: '#/components/schemas/IntegerAttributeRO_v1' - $ref: '#/components/schemas/LongAttributeRO_v1' - $ref: '#/components/schemas/MoneyAttributeRO_v1' - $ref: '#/components/schemas/QuantityAttributeRO_v1' - $ref: '#/components/schemas/StringAttributeRO_v1' - $ref: '#/components/schemas/TextAttributeRO_v1' - $ref: '#/components/schemas/MultipleBooleanAttributeRO_v1' - $ref: '#/components/schemas/MultipleDateAttributeRO_v1' - $ref: '#/components/schemas/MultipleDecimalAttributeRO_v1' - $ref: '#/components/schemas/MultipleDoubleAttributeRO_v1' - $ref: '#/components/schemas/MultipleIntegerAttributeRO_v1' - $ref: '#/components/schemas/MultipleLongAttributeRO_v1' - $ref: '#/components/schemas/MultipleStringAttributeRO_v1' BasketDiscountsRO_v1: type: object properties: dynamicMessages: type: array description: The dynamic messages for a basket. readOnly: true items: type: string description: The dynamic messages for a basket. readOnly: true freeGiftDiscounts: type: array description: The IDs of all free gift discounts granted on the basket. readOnly: true items: type: string description: The IDs of all free gift discounts granted on the basket. readOnly: true shippingBasedDiscounts: type: array description: The IDs of all discounts granted on shipping and handling costs. readOnly: true items: type: string description: The IDs of all discounts granted on shipping and handling costs. readOnly: true valueBasedDiscounts: type: array description: The IDs of all discounts granted on the basket total. readOnly: true items: type: string description: The IDs of all discounts granted on the basket total. readOnly: true description: Provides details about the applied discounts. readOnly: true BasketListCtnrRO_v1: type: object properties: data: type: array description: The core data of the response object. items: $ref: '#/components/schemas/BasketRO_v1' errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. Included via "include" query parameter. readOnly: true description: Optionally included related data objects. Included via "include" query parameter. readOnly: true infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true BasketRO_v1: type: object properties: affiliatePartner: type: string description: The affiliate partner id of the basket. example: 4bcKAB2Ykg4AAAFbjvEYRPJ7 affiliateProgram: type: string description: The affiliate program id of the basket. example: uzMKAB2YvKAAAAFb7DUYRPJ8 approval: $ref: '#/components/schemas/ApprovalRO_v1' attributes: type: array items: $ref: '#/components/schemas/AttributeRO_v1' buckets: type: array description: The bucket ids of all shipping buckets of a basket. items: type: string description: The bucket ids of all shipping buckets of a basket. calculated: type: boolean description: The calculation state of the basket. By default the basket will always be calculated after an update. By settings this to 'false', the basket will not be calculated. Note that the calculation results of a previous calculation will still be present in this case. commonShipToAddress: type: string description: The common ship-to address URN of the basket. example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei commonShippingMethod: type: string description: The common shipping method id of the basket. example: STD_5DAY costCenter: type: string description: The cost center id of the basket. example: "511288" coveredByLimitedTenders: type: boolean description: The flag specifying whether the basket total amount is covered by limited tender payments. If this is the case, then no further limited tender payments can be created. Note that this information depends on the basket calculation (see "calculated" property). It may not be accurate if the basket is not calculated. readOnly: true customer: type: string description: The basket owner customer number. readOnly: true department: type: string description: The department name of the basket. example: SALES discounts: $ref: '#/components/schemas/BasketDiscountsRO_v1' documentNumber: type: string description: The document number of a basket. It is currently only set if basket is in status waiting for approval after submitting. readOnly: true externalOrderReference: type: string description: The external order reference id of the basket. example: "30000008899" id: type: string description: The ID of the basket. example: q2QKAEsBiyQAAAFjXFBB6G14 invoiceToAddress: type: string description: The invoice-to address URN of the basket. example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei lineItems: type: array description: The ids of all line items of a basket. items: type: string description: The ids of all line items of a basket. messageToMerchant: type: string description: Something what the buyer would like to tell the merchant. example: Is it possible to send the ordered articles before Christmas? payments: type: array description: The payments used to pay the basket. items: type: string description: The payments used to pay the basket. promotionCodes: type: array description: The promotion codes of the basket. items: type: string description: The promotion codes of the basket. purchaseCurrency: type: string description: The purchase currency of the basket. readOnly: true example: USD recurrence: $ref: '#/components/schemas/BasketRecurrenceRO_v1' recurringOrderDocumentNo: type: string description: The recurring order number. readOnly: true surcharges: $ref: '#/components/schemas/BasketSurchargesRO_v1' taxIdentificationNumber: type: string description: The tax identification number of the buyer/company. example: "11111111" totalProductQuantity: type: number description: The sum of all quantities of products in the basket. readOnly: true example: 23 totals: $ref: '#/components/schemas/BasketTotalsRO_v1' user: type: string description: The basket owner user login. readOnly: true description: A representation of a basket BasketRecurrenceRO_v1: required: - endDate - interval - repetitions - startDate type: object properties: endDate: type: string description: The end date of a recurrence. format: date-time example: 2020-05-23T13:23:45+02:00 executeMissedOrders: type: boolean description: The execute missed orders flag. example: false interval: type: object properties: years: type: integer format: int32 months: type: integer format: int32 days: type: integer format: int32 zero: type: boolean chronology: type: object properties: calendarType: type: string id: type: string negative: type: boolean units: type: array items: type: object properties: duration: type: object properties: seconds: type: integer format: int64 zero: type: boolean negative: type: boolean nano: type: integer format: int32 dateBased: type: boolean timeBased: type: boolean durationEstimated: type: boolean description: The interval of a recurrence. example: P6Y11M27D repetitions: type: integer description: The repetitions of a recurrence. format: int32 example: 24 startDate: type: string description: The start date of a recurrence. format: date-time example: 2020-05-23T13:23:45+02:00 description: Recurrence data which are associated with a basket. BasketSurchargeRO_v1: type: object properties: amount: $ref: '#/components/schemas/PriceRO_v1' name: type: string description: The name of an element. readOnly: true example: Fridge Box description: type: string description: The surcharge's localized description. readOnly: true example: Needs a fridge box for shipping. taxes: type: array description: The taxes applied to the surcharge. readOnly: true items: $ref: '#/components/schemas/TaxItemRO_v1' description: Describes a single surcharge incurred to a shipping bucket. readOnly: true BasketSurchargesRO_v1: type: object properties: bucketSurcharges: type: array description: All bucket based extra charges arising from surcharges with action type 'bucket'. readOnly: true items: $ref: '#/components/schemas/BasketSurchargeRO_v1' itemSurcharges: type: array description: All item based extra charges arising from surcharges directly specified on product or by shipping rules with action type 'item'. readOnly: true items: $ref: '#/components/schemas/BasketSurchargeRO_v1' description: Surcharges that are applied to a basket. readOnly: true BasketTotalsRO_v1: type: object properties: grandTotal: $ref: '#/components/schemas/PriceRO_v1' paymentCostsTotal: $ref: '#/components/schemas/PriceRO_v1' undiscountedItemTotal: $ref: '#/components/schemas/PriceRO_v1' undiscountedShippingTotal: $ref: '#/components/schemas/PriceRO_v1' basketShippingDiscountsTotal: $ref: '#/components/schemas/PriceRO_v1' basketValueDiscountsTotal: $ref: '#/components/schemas/PriceRO_v1' bucketShippingDiscountsTotal: $ref: '#/components/schemas/PriceRO_v1' discountTotal: $ref: '#/components/schemas/PriceRO_v1' giftingTotal: $ref: '#/components/schemas/PriceRO_v1' itemShippingDiscountsTotal: $ref: '#/components/schemas/PriceRO_v1' itemTotal: $ref: '#/components/schemas/PriceRO_v1' itemValueDiscountsTotal: $ref: '#/components/schemas/PriceRO_v1' salesTaxTotalsByTaxRate: type: array description: All sales taxes applied to the basket, accumulated by their tax rates. readOnly: true items: $ref: '#/components/schemas/TaxItemRO_v1' shippingDiscountsTotal: $ref: '#/components/schemas/PriceRO_v1' shippingTaxTotalsByTaxRate: type: array description: All shipping taxes applied to the basket, accumulated by their tax rates. readOnly: true items: $ref: '#/components/schemas/TaxItemRO_v1' shippingTotal: $ref: '#/components/schemas/PriceRO_v1' surchargeTotal: $ref: '#/components/schemas/PriceRO_v1' taxTotalsByTaxRate: type: array description: All taxes applied to the basket, accumulated by their tax rates (includes taxes levied to sales, prices, shipping and surcharges. readOnly: true items: $ref: '#/components/schemas/TaxItemRO_v1' valueDiscountsTotal: $ref: '#/components/schemas/PriceRO_v1' description: Total price values for a basket. readOnly: true BooleanAttributeRO_v1: required: - name - type - value type: object description: A representation of a boolean attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: boolean description: The boolean attribute value. DateAttributeRO_v1: required: - name - type - value type: object description: A representation of a date/time attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: string description: The date/time attribute value. format: date-time example: 2020-05-23T13:23:45+02:00 DecimalAttributeRO_v1: required: - name - type - value type: object description: A representation of a decimal attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: number description: The decimal attribute value. DoubleAttributeRO_v1: required: - name - type - value type: object description: A representation of a double attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: number description: The double attribute value. format: double FeedbackCauseRO_v1: required: - code - message type: object properties: code: type: string description: An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). example: invoiceToAddress.address.postalcode.invalid message: type: string description: A human readable message in request's locale (server falls back to lead locale if requested local is not supported). example: The specified postal code is invalid. Valid values are numbers 10000 to 99999. parameters: type: object additionalProperties: type: object description: A map of several parameters that are used to assemble the message. description: A map of several parameters that are used to assemble the message. paths: type: array description: A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. externalDocs: url: https://github.com/json-path/JsonPath items: type: string description: A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. externalDocs: url: https://github.com/json-path/JsonPath description: A representation for the common feedback informations. FeedbackRO_v1: type: object properties: causes: type: array description: A collection of errors/infos that caused this feedback. items: $ref: '#/components/schemas/FeedbackCauseRO_v1' code: type: string description: An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). example: invoiceToAddress.address.postalcode.invalid message: type: string description: A human readable message in request's locale (server falls back to lead locale if requested local is not supported). example: The specified postal code is invalid. Valid values are numbers 10000 to 99999. parameters: type: object additionalProperties: type: object description: A map of several parameters that are used to assemble the message. description: A map of several parameters that are used to assemble the message. paths: type: array description: A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. externalDocs: url: https://github.com/json-path/JsonPath items: type: string description: A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. externalDocs: url: https://github.com/json-path/JsonPath status: type: string description: The HTTP status code, that is applicable to this problem. example: "400" description: An error or information representation regarding the current request. readOnly: true IntegerAttributeRO_v1: required: - name - type - value type: object description: A representation of an integer attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: integer description: The integer attribute value. format: int32 JurisdictionRO_v1: type: object properties: id: type: string description: The jurisdiction ID. example: CANADA level: type: string description: The level of the jurisdiction for which the tax is applied. example: COUNTRY enum: - APO - BOROUGH - CITY - COUNTRY - COUNTY - DISTRICT - FPO - LOCAL_IMPROVEMENT_DISTRICT - PARISH - PROVINCE - SPECIAL_PURPOSE_DISTRICT - STATE - TERRITORY - TOWNSHIP - TRADE_BLOCK - TRANSIT_DISTRICT description: Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country. readOnly: true LongAttributeRO_v1: required: - name - type - value type: object description: A representation of a long attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: integer description: The long attribute value. format: int64 MoneyAttributeRO_v1: required: - name - type - value type: object description: A representation of a money attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: $ref: '#/components/schemas/MoneyRO_v1' MoneyRO_v1: type: object properties: currency: type: string description: Three-letter currency code (ISO 4217) of the monetary value. example: USD value: type: number description: The monetary value. example: 10.99 description: Describes a money object. readOnly: true MultipleBooleanAttributeRO_v1: required: - name - type - value type: object description: A representation of a multiple boolean attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: array description: The multiple boolean attribute value. items: type: boolean description: The multiple boolean attribute value. MultipleDateAttributeRO_v1: required: - name - type - value type: object description: A representation of a multiple date/time attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: array description: The multiple date/time attribute value. items: type: string description: The multiple date/time attribute value. format: date-time MultipleDecimalAttributeRO_v1: required: - name - type - value type: object description: A representation of a multiple decimal attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: array description: The multiple decimal attribute value. items: type: number description: The multiple decimal attribute value. MultipleDoubleAttributeRO_v1: required: - name - type - value type: object description: A representation of a multiple double attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: array description: The multiple double attribute value. items: type: number description: The multiple double attribute value. format: double MultipleIntegerAttributeRO_v1: required: - name - type - value type: object description: A representation of a multiple integer attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: array description: The multiple integer attribute value. items: type: integer description: The multiple integer attribute value. format: int32 MultipleLongAttributeRO_v1: required: - name - type - value type: object description: A representation of a multiple long attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: array description: The multiple long attribute value. items: type: integer description: The multiple long attribute value. format: int64 MultipleStringAttributeRO_v1: required: - name - type - value type: object description: A representation of a multiple string attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: array description: The multiple string attribute value. items: type: string description: The multiple string attribute value. PriceRO_v1: type: object properties: gross: $ref: '#/components/schemas/MoneyRO_v1' net: $ref: '#/components/schemas/MoneyRO_v1' tax: $ref: '#/components/schemas/MoneyRO_v1' description: Describes a price. A price has a monetary net, gross and tax value. readOnly: true QuantityAttributeRO_v1: required: - name - type - value type: object description: A representation of a quantity attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: $ref: '#/components/schemas/QuantityRO_v1' QuantityRO_v1: required: - value type: object properties: unit: type: string description: The quantity's unit code. example: kg value: type: number description: The quantity's value. example: 10 description: A quantity of a business entity. StringAttributeRO_v1: required: - name - type - value type: object description: A representation of a string attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: string description: The string attribute value. TaxItemRO_v1: required: - effectiveTaxRate type: object properties: calculatedTax: $ref: '#/components/schemas/MoneyRO_v1' effectiveTaxRate: type: number description: The effective rate used to calculate the tax. jurisdiction: $ref: '#/components/schemas/JurisdictionRO_v1' nonTaxableAmount: $ref: '#/components/schemas/MoneyRO_v1' situs: type: string description: The situs/place of taxation. readOnly: true example: DESTINATION enum: - NULL - ADMINISTRATIVE_DESTINATION - ADMINISTRATIVE_ORIGIN - DESTINATION - ORIGIN taxableAmount: $ref: '#/components/schemas/MoneyRO_v1' description: Represents a single tax item. readOnly: true TextAttributeRO_v1: required: - name - type - value type: object description: A representation of a text attribute. allOf: - $ref: '#/components/schemas/AttributeRO_v1' - type: object properties: value: type: string description: The text attribute value. BasketCtnrRO_v1: type: object properties: data: $ref: '#/components/schemas/BasketRO_v1' errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. Included via "include" query parameter. readOnly: true description: Optionally included related data objects. Included via "include" query parameter. readOnly: true infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true AddressListCtnrRO_v1: type: object properties: data: type: array description: The core data of the response object. items: $ref: '#/components/schemas/AddressRO_v1' errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. Included via "include" query parameter. readOnly: true description: Optionally included related data objects. Included via "include" query parameter. readOnly: true infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true AddressRO_v1: type: object properties: addressLine1: type: string description: The first address line, that usual contains street and house number. example: Berliner Str. 20 addressLine2: type: string description: The second address line. addressLine3: type: string description: The third address line. aristocraticTitle: type: string description: The aristocratic title of the contact person, like 'Lord' or 'Lady'. attributes: type: array items: $ref: '#/components/schemas/AttributeRO_v1' city: type: string description: The name of the city. example: Potsdam companyName1: type: string description: The company name in case it is a business address. example: Intershop Communications AG companyName2: type: string description: The second company name country: type: string description: The localized display name of the country readOnly: true example: Germany countryCode: type: string description: The ISO 3166-1 country code example: DE customer: type: string eligibleInstallToAddress: type: boolean description: Flag indicating that the address can be used as install-to address. example: false eligibleInvoiceToAddress: type: boolean description: Flag indicating that the address can be used as invoice-to address. example: true eligibleServiceToAddress: type: boolean description: Flag indicating that the address can be used as service-to address. example: false eligibleShipFromAddress: type: boolean description: Flag indicating that the address can be used as ship-from address. example: false eligibleShipToAddress: type: boolean description: Flag indicating that the address can be used as ship-to address. example: true email: type: string description: The e-mail address of the contact person. example: patricia@test.intershop.de 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 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 example: urn:address:MSDynamics365:MyCorp:000123456 fax: type: string description: The fax number. firstName: type: string description: The given name (also known as a personal name, first name, forename, or Christian name) of the contact person example: Patricia honorific: type: string description: The honorific title of the contact person that denotes the honored person's occupation, like 'Captain', 'Reverend' or the academic title, like 'PhD'. id: type: string description: The ID that identifies the address. example: "0987654321" jobTitle: type: string description: The job title of the contact person. lastName: type: string description: The last name (also known as a family name, surname, or gentile name) of the contact person. example: Miller mainDivision: type: string description: The localized display name of the main division readOnly: true example: Alabama mainDivisionCode: type: string description: The main division code of the country, e. g. a state or province. example: Al phoneBusiness: type: string description: The phone number of the contact person's company. 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. phoneHome: type: string description: The phone number of the house or apartment where the contact person lives. example: "049364112677" phoneMobile: type: string description: The number of the contact person's cell phone. postBox: type: string description: The post-office box. postalCode: type: string description: The postal code of the city. example: "14482" secondLastName: type: string description: The second last name of the contact person. secondName: type: string description: The second given name of the contact person. subDivision: type: string description: The localized display name of the sub division. readOnly: true example: City of Westminster subDivisionCode: type: string description: The sub division code. example: "020" title: type: string description: The (personal) title of the contact person. example: Ms. urn: type: string description: The URN representation of this address. example: urn:address:customer:1234567890:0987654321 usage: type: object properties: empty: type: boolean description: 'The usage information for the address. Every bit in the returned set marks a specific usage type: [invoice-to, ship-to, ship-from, service-to, install-to]. If a bit is set, the address may be used for the specific purpose mapped to this bit. By default, all values are set to true.' description: The address FeedbackCtnrRO_v1: type: object properties: errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. description: Optionally included related data objects. infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true AddressCtnrRO_v1: type: object properties: data: $ref: '#/components/schemas/AddressRO_v1' errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. Included via "include" query parameter. readOnly: true description: Optionally included related data objects. Included via "include" query parameter. readOnly: true infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true AttributeCtnrRO_v1: type: object properties: data: $ref: '#/components/schemas/AttributeRO_v1Object' errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. description: Optionally included related data objects. infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true AttributeRO_v1Object: required: - name - type type: object properties: name: type: string description: The name of an element. type: type: string description: 'The type of the object. This is normally a **constant** that can be used to differentiate objects by their type. ' enum: - Boolean - Date - Decimal - Double - Integer - Long - Money - Quantity - String - Text - MultipleBoolean - MultipleDate - MultipleDecimal - MultipleDouble - MultipleInteger - MultipleLong - MultipleString value: type: object description: A representation of an attribute. discriminator: propertyName: type mapping: Boolean: '#/components/schemas/BooleanAttributeRO_v1' Date: '#/components/schemas/DateAttributeRO_v1' Decimal: '#/components/schemas/DecimalAttributeRO_v1' Double: '#/components/schemas/DoubleAttributeRO_v1' Integer: '#/components/schemas/IntegerAttributeRO_v1' Long: '#/components/schemas/LongAttributeRO_v1' Money: '#/components/schemas/MoneyAttributeRO_v1' Quantity: '#/components/schemas/QuantityAttributeRO_v1' String: '#/components/schemas/StringAttributeRO_v1' Text: '#/components/schemas/TextAttributeRO_v1' MultipleBoolean: '#/components/schemas/MultipleBooleanAttributeRO_v1' MultipleDate: '#/components/schemas/MultipleDateAttributeRO_v1' MultipleDecimal: '#/components/schemas/MultipleDecimalAttributeRO_v1' MultipleDouble: '#/components/schemas/MultipleDoubleAttributeRO_v1' MultipleInteger: '#/components/schemas/MultipleIntegerAttributeRO_v1' MultipleLong: '#/components/schemas/MultipleLongAttributeRO_v1' MultipleString: '#/components/schemas/MultipleStringAttributeRO_v1' oneOf: - $ref: '#/components/schemas/BooleanAttributeRO_v1' - $ref: '#/components/schemas/DateAttributeRO_v1' - $ref: '#/components/schemas/DecimalAttributeRO_v1' - $ref: '#/components/schemas/DoubleAttributeRO_v1' - $ref: '#/components/schemas/IntegerAttributeRO_v1' - $ref: '#/components/schemas/LongAttributeRO_v1' - $ref: '#/components/schemas/MoneyAttributeRO_v1' - $ref: '#/components/schemas/QuantityAttributeRO_v1' - $ref: '#/components/schemas/StringAttributeRO_v1' - $ref: '#/components/schemas/TextAttributeRO_v1' - $ref: '#/components/schemas/MultipleBooleanAttributeRO_v1' - $ref: '#/components/schemas/MultipleDateAttributeRO_v1' - $ref: '#/components/schemas/MultipleDecimalAttributeRO_v1' - $ref: '#/components/schemas/MultipleDoubleAttributeRO_v1' - $ref: '#/components/schemas/MultipleIntegerAttributeRO_v1' - $ref: '#/components/schemas/MultipleLongAttributeRO_v1' - $ref: '#/components/schemas/MultipleStringAttributeRO_v1' AttributeListCtnrRO_v1: type: object properties: data: type: array description: The core data of the response object. items: $ref: '#/components/schemas/AttributeRO_v1Object' errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. description: Optionally included related data objects. infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true BasketShippingBucketListCtnrRO_v1: type: object properties: data: type: array description: The core data of the response object. items: $ref: '#/components/schemas/BasketShippingBucketRO_v1' errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. Included via "include" query parameter. readOnly: true description: Optionally included related data objects. Included via "include" query parameter. readOnly: true infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true BasketShippingBucketRO_v1: type: object properties: basket: type: string description: The basket this shipping bucket belongs to. readOnly: true example: yUQKAEsBeeoAAAFl9vhJwIZc calculated: type: boolean description: The calculation state of the shipping bucket. By default the shipping bucket will always be calculated after an update. By settings this to 'false', the shipping bucket will not be calculated. Note that the calculation results of a previous calculation will still be present in this case. Also note that by setting this to 'true', not only the shipping bucket, but the whole basket is calculated. deliveryTimeMax: type: object properties: years: type: integer format: int32 months: type: integer format: int32 days: type: integer format: int32 zero: type: boolean chronology: type: object properties: calendarType: type: string id: type: string negative: type: boolean units: type: array items: type: object properties: duration: type: object properties: seconds: type: integer format: int64 zero: type: boolean negative: type: boolean nano: type: integer format: int32 dateBased: type: boolean timeBased: type: boolean durationEstimated: type: boolean description: The maximum time the delivery will take based on the chosen shipping method (in ISO-8601 period format). readOnly: true example: P7D deliveryTimeMin: type: object properties: years: type: integer format: int32 months: type: integer format: int32 days: type: integer format: int32 zero: type: boolean chronology: type: object properties: calendarType: type: string id: type: string negative: type: boolean units: type: array items: type: object properties: duration: type: object properties: seconds: type: integer format: int64 zero: type: boolean negative: type: boolean nano: type: integer format: int32 dateBased: type: boolean timeBased: type: boolean durationEstimated: type: boolean description: The minimum time the delivery will take based on the chosen shipping method (in ISO-8601 period format). readOnly: true example: P3D discounts: type: array description: The IDs of the discounts applied to the bucket totals. readOnly: true items: type: string description: The IDs of the discounts applied to the bucket totals. readOnly: true id: type: string description: The ID of the bucket. readOnly: true example: "54489489212" lineItems: type: array description: The ids of all line items which are associated with this bucket. readOnly: true items: type: string description: The ids of all line items which are associated with this bucket. readOnly: true shipToAddress: type: string description: The ship-to address URN for this bucket. example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei shippingCosts: $ref: '#/components/schemas/PriceRO_v1' shippingMethod: type: string description: The shipping method id for this bucket. example: STD_5DAY surcharges: type: array description: All extra charges arising from surcharges directly specified on product or by shipping rules with action type 'bucket'. readOnly: true items: $ref: '#/components/schemas/BasketSurchargeRO_v1' description: Describes a shipping bucket. BasketShippingBucketCtnrRO_v1: type: object properties: data: $ref: '#/components/schemas/BasketShippingBucketRO_v1' errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. Included via "include" query parameter. readOnly: true description: Optionally included related data objects. Included via "include" query parameter. readOnly: true infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true BasketShippingMethodListCtnrRO_v1: type: object properties: data: type: array description: The core data of the response object. items: $ref: '#/components/schemas/BasketShippingMethodRO_v1' errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. Included via "include" query parameter. readOnly: true description: Optionally included related data objects. Included via "include" query parameter. readOnly: true infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true BasketShippingMethodRO_v1: type: object properties: attributes: type: array items: $ref: '#/components/schemas/AttributeRO_v1' deliveryTimeMax: type: object properties: years: type: integer format: int32 months: type: integer format: int32 days: type: integer format: int32 zero: type: boolean chronology: type: object properties: calendarType: type: string id: type: string negative: type: boolean units: type: array items: type: object properties: duration: type: object properties: seconds: type: integer format: int64 zero: type: boolean negative: type: boolean nano: type: integer format: int32 dateBased: type: boolean timeBased: type: boolean durationEstimated: type: boolean description: The maximum time the delivery will take when selecting this shipping method (in ISO-8601 period format). Note that because the delivery time depends on the shipping bucket, it will only be returned if request from the bucket. readOnly: true example: P7D deliveryTimeMin: type: object properties: years: type: integer format: int32 months: type: integer format: int32 days: type: integer format: int32 zero: type: boolean chronology: type: object properties: calendarType: type: string id: type: string negative: type: boolean units: type: array items: type: object properties: duration: type: object properties: seconds: type: integer format: int64 zero: type: boolean negative: type: boolean nano: type: integer format: int32 dateBased: type: boolean timeBased: type: boolean durationEstimated: type: boolean description: The minimum time the delivery will take when selecting this shipping method (in ISO-8601 period format). Note that because the delivery time depends on the shipping bucket, it will only be returned if request from the bucket. readOnly: true example: P3D description: type: string description: The shipping method's localized description. readOnly: true example: Delivered to you 3-7 business days after we process your order. digitalDelivery: type: boolean description: Whether this shipping method is a digital delivery method (e. g. for e-mail delivery). readOnly: true id: type: string description: The shipping method's unique identifier. readOnly: true example: STD_GROUND name: type: string description: The name of an element. readOnly: true example: Standard Ground shippingCosts: $ref: '#/components/schemas/PriceRO_v1' shippingInstructionsSupported: type: boolean description: Whether special shipping instructions can be added to the shipping bucket when selecting this shipping method. readOnly: true shortName: type: string description: The shipping method's localized short Name. readOnly: true example: Int'l Express Delivery. description: Describes a shipping method that can be selected as delivery option. ParameterRO_v1: type: object properties: name: type: string description: The name of an element. example: expiryDate value: type: object description: The value of the parameter. example: 12/20 description: A representation of a parameter value. readOnly: true PaymentCtnrRO_v1: type: object properties: data: $ref: '#/components/schemas/PaymentRO_v1' errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. description: Optionally included related data objects. infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true PaymentRO_v1: required: - paymentInstrument type: object properties: baseAmount: $ref: '#/components/schemas/MoneyRO_v1' id: type: string description: The ID of the payment. readOnly: true example: AAFjXFq2QKAEsBiyQABB6G14 openTender: type: boolean description: Whether or not the payment is an 'open-tender' payment. readOnly: true paymentCosts: $ref: '#/components/schemas/PriceRO_v1' paymentInstrument: type: string description: The reference to the payment instrument that was selected for this payment. example: c2UKAEsBar8AAAFmxYVBTOiI paymentMethod: type: string description: The reference to the payment method that was used for this payment. readOnly: true example: ISH_INVOICE redirect: $ref: '#/components/schemas/PaymentRedirectRO_v1' redirectRequired: type: boolean description: Whether or not a redirect is required to finish the payment. The type of redirect (before or after the checkout process) can be determined via the capabilities of the payment method. readOnly: true status: type: string description: The localized display name of the payment status. readOnly: true example: Partially captured totalAmount: $ref: '#/components/schemas/MoneyRO_v1' description: A payment assigned to the basket/order to pay the bill with. PaymentRedirectRO_v1: required: - cancelUrl - failureUrl - successUrl type: object properties: cancelUrl: type: string description: The URL to be called when the user cancelled payment and the PSP redirects the user back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders \*orderID\* and \*paymentID\* are available. format: uri example: https://shop.server/cancel?paymentID=*paymentID* failureUrl: type: string description: The URL to be called when the payment failed and the PSP redirects the user back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders \*orderID\* and \*paymentID\* are available. format: uri example: https://shop.server/failure parameters: type: array description: List of parameters returned in the redirect response from the PSP. items: $ref: '#/components/schemas/ParameterRO_v1' redirectUrl: type: string description: The URL to be called when redirecting the user to the payment providers page. format: uri readOnly: true example: https://psp-server/pay status: type: string description: The final status of the redirect returned to the shop. example: SUCCESS enum: - SUCCESS - CANCEL - FAILURE successUrl: type: string description: The URL to be called on successful payment redirect back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders \*orderID\* and \*paymentID\* are available. format: uri example: https://shop.server/success?orderID=*orderID* description: 'Describes a payment redirect. Note: Beta version - This class can still be subject of change!' PaymentInstrumentCtnrRO_v1: type: object properties: data: $ref: '#/components/schemas/PaymentInstrumentRO_v1' errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. description: Optionally included related data objects. infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true PaymentInstrumentRO_v1: required: - paymentMethod type: object properties: accountIdentifier: type: string description: An optional identifier for the customers bank account. readOnly: true example: DE12****7890 id: type: string description: The ID of the payment instrument. example: AAFjXFq2QKAEsBiyQABB6G14 numberOfPayments: type: integer description: The number of payments done with this instrument. format: int32 readOnly: true example: 3 parameters: type: array description: The parameters for the payment instrument. items: $ref: '#/components/schemas/ParameterRO_v1' paymentMethod: type: string description: The reference to the payment method the instrument is created for. example: ISH_DIRECT_DEBIT urn: type: string description: The URN of the payment instrument. example: urn:payment-instrument:basket:q2QKAEsBiyQAAAFjXFBB6G14:AAFjXFq2QKAEsBiyQABB6G14 description: A payment instrument with stored bank account data. ContainerRO_v1: type: object properties: data: type: object description: The core data of the response object. errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. description: Optionally included related data objects. infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true BasketPromotionCodeRO_v1: required: - code type: object properties: code: type: string description: The promotion code string. example: JSTTWVJNSIIUW description: Describes the applied promotion code. BasketValidationCtnrRO_v1: type: object properties: data: $ref: '#/components/schemas/BasketValidationRO_v1' errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. description: Optionally included related data objects. infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true BasketValidationRO_v1: type: object properties: adjustmentsAllowed: type: boolean description: Defines whether adjustments of the basket are allowed during the validation. For example, if this is set to 'true', then a product that is no longer available will be removed during the validation; if this is set to 'false' instead, then only an error will be returned. default: false basket: type: string description: The ID of the basket that is validated. readOnly: true example: MAoKAEsBSYIAAAFrkghefNsj errorBehavior: type: string description: Defines whether the validation immediately stops if an error occurs. If this is set to 'StopOnError', then the validation only continues until the first error. If this is set to 'StopOnErrorFinishScope', then the validation will finish the scope where the first error occurs and stop afterwards. If this is set to 'NeverStop', then it will continue to the end and return all validation errors at once. enum: - StopOnError - StopOnErrorFinishScope - NeverStop default: NeverStop results: $ref: '#/components/schemas/BasketValidationResultRO_v1' scopes: type: array description: The list of scopes that are validated. If not specified, the basket will be validated for all scopes. Note that the list of allowable values only contains the standard scopes; if there are custom validation handlers with different scopes, those can be used too. items: type: string description: The list of scopes that are validated. If not specified, the basket will be validated for all scopes. Note that the list of allowable values only contains the standard scopes; if there are custom validation handlers with different scopes, those can be used too. enum: - All - CostCenter - InvoiceAddress - Order - Payment - Products - Promotion - Quote - Shipping - ShippingAddress - Subscription - Value default: All enum: - All - CostCenter - InvoiceAddress - Order - Payment - Products - Promotion - Quote - Shipping - ShippingAddress - Subscription - Value default: All description: A representation of a basket validation operation. Contains parameters for triggering the validation as well as the validation results for the given scopes. BasketValidationResultRO_v1: type: object properties: adjusted: type: boolean description: Returns whether the basket has been adjusted during the validation. readOnly: true errors: type: array description: List of errors that occurred while validating the basket for the given scope(s). The paths of the feedback messages refer to the basket that has been validated (with related objects being embedded). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' infos: type: array description: List of adjustments that were made while validating the basket for the given scope(s). The paths of the feedback messages refer to the basket that has been validated (with related objects being embedded). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' valid: type: boolean description: Returns whether the basket is valid. A basket is valid if no errors occurred during the validation. readOnly: true description: A representation of the results of a basket validation operation. readOnly: true BasketLineItemListCtnrRO_v1: type: object properties: data: type: array description: The core data of the response object. items: $ref: '#/components/schemas/BasketLineItemRO_v1' errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. Included via "include" query parameter. readOnly: true description: Optionally included related data objects. Included via "include" query parameter. readOnly: true infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true BasketLineItemPricingRO_v1: type: object properties: giftingTotal: $ref: '#/components/schemas/PriceRO_v1' price: $ref: '#/components/schemas/PriceRO_v1' salesTaxTotal: $ref: '#/components/schemas/MoneyRO_v1' shippingRebatesTotal: $ref: '#/components/schemas/PriceRO_v1' shippingTaxTotal: $ref: '#/components/schemas/MoneyRO_v1' singleBasePrice: $ref: '#/components/schemas/PriceRO_v1' undiscountedPrice: $ref: '#/components/schemas/PriceRO_v1' undiscountedShippingTotal: $ref: '#/components/schemas/PriceRO_v1' undiscountedSingleBasePrice: $ref: '#/components/schemas/PriceRO_v1' valueRebatesTotal: $ref: '#/components/schemas/PriceRO_v1' description: total price values of a line item that has been added to a basket readOnly: true BasketLineItemRO_v1: required: - product type: object properties: attributes: type: array items: $ref: '#/components/schemas/AttributeRO_v1' basket: type: string description: The basket this line item belongs to. readOnly: true example: yUQKAEsBeeoAAAFl9vhJwIZc calculated: type: boolean description: The calculation state of the line item. By default the line item will always be calculated after an update. By settings this to 'false', the line item will not be calculated. Note that the calculation results of a previous calculation will still be present in this case. Also note that by setting this to 'true', not only the line item, but the whole basket is calculated. desiredDelivery: type: string description: The desired delivery date for the Item. format: date example: 2001-07-04 discounts: type: array description: The IDs of the discounts applied to the item pricing. readOnly: true items: type: string description: The IDs of the discounts applied to the item pricing. readOnly: true freeGift: type: boolean description: Flag indicating that this product line item is a free gift and has been automatically placed in the line item container. readOnly: true example: false giftMessage: type: string description: Additional gift message for this the line item. readOnly: true giftWrap: type: string description: Additional gift wrapping for this the line item. readOnly: true hiddenGift: type: boolean description: Flag indicating that this product line item is a free gift, that will not be displayed in line item container. readOnly: true example: false id: type: string description: The line item's unique identifier. readOnly: true position: type: integer description: The position of the item in the basket. format: int32 pricing: $ref: '#/components/schemas/BasketLineItemPricingRO_v1' product: type: string description: The product represented as stock keeping unit (SKU). example: "5079747" quantity: $ref: '#/components/schemas/QuantityRO_v1' quantityFixed: type: boolean description: Flag indicating that this product line item quantity is not changeable. example: true quote: type: string description: The quote this item was created from. example: Qu0T3MgoyuMAx9Es2sx0Ue1 shipToAddress: type: string description: The ship-to address URN for this bucket. example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei shippingMethod: type: string description: The shipping method id for this bucket. example: STD_5DAY surcharges: type: array description: Details about additional surcharges applied to the item. readOnly: true items: $ref: '#/components/schemas/BasketSurchargeRO_v1' thumbnail: type: string description: The thumbnail uri of the Product. readOnly: true example: /INTERSHOP/static/WFS/inSPIRED-inTRONICS-Site/-/inSPIRED/en_US/M/3957288-5427.jpg warranty: type: string description: A warranty assigned to the line item. readOnly: true description: Describes a line item that has been added to a basket. BasketLineItemCtnrRO_v1: type: object properties: data: $ref: '#/components/schemas/BasketLineItemRO_v1' errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. Included via "include" query parameter. readOnly: true description: Optionally included related data objects. Included via "include" query parameter. readOnly: true infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true BasketMergeCtnrRO.v1: type: object properties: data: $ref: '#/components/schemas/BasketMergeRO.v1' errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. Included via "include" query parameter. readOnly: true description: Optionally included related data objects. Included via "include" query parameter. readOnly: true infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true BasketMergeRO.v1: type: object properties: overrideAttributes: type: boolean description: 'The flag decides if the target basket custom attributes can be override. (default: The custom attributes can not override.)' example: false removeSourceBasket: type: boolean description: 'The flag decides if the source basket retains. (default: The source basket will removed.)' example: true sourceAuthenticationToken: type: string description: The authentication token to access the source basket. sourceBasket: type: string description: The id of the basket whose information are merged into the other basket. example: 1XQKABsm5boAAAFrzZFR4EbI targetBasket: type: string description: The id of the basket where the line items are merged into. readOnly: true example: yiwKABsmStEAAAFrd.FhzEc5 description: A representation of merge basket information ConstraintRO_v1: required: - message type: object properties: message: type: string description: The message text of the constraint. readOnly: true description: A constraint of a parameter. OptionRO_v1: type: object properties: displayName: type: string description: The localized display name of the parameter option. example: American Express id: type: string description: The id of the parameter option. example: amx description: A representation of a parameter option. ParameterDefinitionRO_v1: required: - name - type type: object properties: constraints: type: object additionalProperties: $ref: '#/components/schemas/ConstraintRO_v1' description: A map of parameter constraints. The key is the constraint type. description: type: string description: The localized parameter description. readOnly: true displayName: type: string description: The localized display name of the parameter. readOnly: true example: Expiration Date hidden: type: boolean description: A flag indicating a hidden parameter that is not visible in the UI. readOnly: true name: type: string description: The name of an element. readOnly: true example: expiryDate options: type: array description: A list of allowable values to choose from for this parameter. items: $ref: '#/components/schemas/OptionRO_v1' placeholder: type: string description: A placeholder string for the parameter. readOnly: true type: type: string description: 'The type of the object. This is normally a **constant** that can be used to differentiate objects by their type. ' readOnly: true example: String updatable: type: boolean description: A flag indicating a parameter value is updatable via REST. readOnly: true description: A representation of a parameter definition. readOnly: true PaymentMethodListCtnrRO_v1: type: object properties: data: type: array description: The core data of the response object. items: $ref: '#/components/schemas/PaymentMethodRO_v1' errors: type: array description: List of errors that occurred in relation to the request. readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' included: type: object additionalProperties: type: object description: Optionally included related data objects. Included via "include" query parameter. readOnly: true description: Optionally included related data objects. Included via "include" query parameter. readOnly: true infos: type: array description: List of informations regarding to the request (e.g. value adjustments). readOnly: true items: $ref: '#/components/schemas/FeedbackRO_v1' links: type: object additionalProperties: type: object description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements. readOnly: true PaymentMethodRO_v1: type: object properties: capabilities: type: array description: List of supported payment service capabilities. readOnly: true example: RedirectAfterCheckout items: type: string description: List of supported payment service capabilities. readOnly: true example: RedirectAfterCheckout default: type: boolean description: Whether the payment method is the default payment method of the channel. readOnly: true description: type: string description: A more detailed description of the payment method. readOnly: true example: Simulate a payment with the Intershop demo method displayName: type: string description: The display name of the payment method. readOnly: true example: ISH Demo Payment hostedPaymentPageParameters: type: array description: List of content parameters for Hosted Payment Pages. readOnly: true items: $ref: '#/components/schemas/ParameterRO_v1' id: type: string description: The ID of the payment method. Internally this is the ID of the payment method configuration in the backoffice. readOnly: true example: ISH_INVOICE maxOrderAmount: $ref: '#/components/schemas/PriceRO_v1' minOrderAmount: $ref: '#/components/schemas/PriceRO_v1' parameterDefinitions: type: array description: List of parameters (e.g. credit card 3DS token or IBAN) for this payment. readOnly: true items: $ref: '#/components/schemas/ParameterDefinitionRO_v1' paymentCosts: $ref: '#/components/schemas/PriceRO_v1' paymentCostsThreshold: $ref: '#/components/schemas/PriceRO_v1' paymentInstruments: type: array description: The IDs of all payment instruments stored for this payment method in the current context. readOnly: true items: type: string description: The IDs of all payment instruments stored for this payment method in the current context. readOnly: true restricted: type: boolean description: Whether the payment method can be used in the current context. readOnly: true restrictions: type: array description: The restrictions which prevent the payment method from being applicable. readOnly: true items: $ref: '#/components/schemas/PaymentRestrictionRO_v1' saveAllowed: type: boolean description: Whether the entered payment data can be saved for later reuse. readOnly: true example: false serviceID: type: string description: The ID of the payment service. readOnly: true example: SomePaymentProvider_CreditCard description: A configured payment method. PaymentRestrictionRO_v1: required: - code - message type: object properties: code: type: string description: A unique identifier for this restriction. readOnly: true example: payment.restriction.MultipleBuckets message: type: string description: A human readable message in request's locale describing the restriction. readOnly: true example: Not available for orders being dispatched to multiple addresses or in multiple shipments. parameters: type: object additionalProperties: type: object description: A map of additional parameters to be used in the description. readOnly: true description: A map of additional parameters to be used in the description. readOnly: true description: A restriction which limits the use of a payment method. readOnly: true 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 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 parameters: loc: name: loc in: path description: The locale ID (submitted as optional matrix parameter ```;loc=```). If omitted, the site's or user's default locale is used. required: false style: matrix schema: type: string description: The locale ID (submitted as optional matrix parameter ```;loc=```). If omitted, the site's or user's default locale is used. 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 LVL: description: Latvian Lats value: LVL SCR: description: Seychelles Rupee value: SCR CDF: description: Congolese Franc value: CDF GTQ: description: Guatemalan Quetzal value: GTQ BBD: description: Barbados Dollar value: BBD CLP: description: Chilean Peso value: CLP HNL: description: Honduran Lempira value: HNL UGX: description: Ugandan Shilling value: UGX ZAR: description: South African Rand value: ZAR TND: description: Tunisian Dinar value: TND BSD: description: Bahamian Dollar value: BSD SLL: description: Sierra Leonean Leone value: SLL 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 AZN: description: Azerbaijanian Manat value: AZN PGK: description: Papua New Guinean Kina value: PGK OMR: description: Omani Rial value: OMR KES: description: Kenyan Shilling value: KES SEK: description: Swedish Krona value: SEK BTN: description: Ngultrum value: BTN UAH: description: Ukrainian Hryvnia value: UAH GNF: description: Guinea Franc value: GNF ERN: description: Nakfa value: ERN MZN: description: Mozambican Metical value: MZN SVC: description: Salvadoran Colón value: SVC ARS: description: Argentine Peso value: ARS QAR: description: Qatari Riyal value: QAR IRR: description: Iranian Rial value: IRR NLG: description: Dutch Guilder value: NLG MRO: description: Mauritanian Ouguiya value: MRO CNY: description: Yuan Renminbi value: CNY XPF: description: CFP Franc value: XPF UZS: description: Uzbekistani Som value: UZS THB: description: Thai Baht value: THB BDT: description: Bangladeshi Taka value: BDT LYD: description: Libyan Dinar value: LYD BMD: description: Bermudian Dollar value: BMD KWD: description: Kuwaiti Dinar value: KWD PHP: description: Philippine Peso value: PHP 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 MKD: description: Denar value: MKD USD: description: US Dollar value: USD DZD: description: Algerian Dinar value: DZD PAB: description: Panamanian Balboa value: PAB SGD: description: Singapore Dollar value: SGD ETB: description: Ethiopian Birr value: ETB KGS: description: Som value: KGS VUV: description: Vanuatu Vatu value: VUV VEF: description: Venezuelan Bolivar Fuerte value: VEF SOS: description: Somali Shilling value: SOS LAK: description: Lao Kip value: LAK BND: description: Brunei Dollar value: BND ZMK: description: Zambian Kwacha value: ZMK 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 BWP: description: Botswana Pula value: BWP TRY: description: Turkish Lira value: TRY SHP: description: Saint Helena Pound value: SHP LBP: description: Lebanese Pound value: LBP CYP: description: Cyprus Pound value: CYP TJS: description: Tajikistani Somoni value: TJS JOD: description: Jordanian Dinar value: JOD HKD: description: Hong Kong Dollar value: HKD AED: description: United Arab Emirates Dirham value: AED RWF: description: Rwanda Franc value: RWF 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 MUR: description: Mauritian Rupee value: MUR SYP: description: Syrian Pound value: SYP NOK: description: Norwegian Krone value: NOK 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 GRD: description: Greek Drachma value: GRD XCD: description: East Carribean Dollar value: XCD HTG: description: Haitian Gourde value: HTG ANG: description: Netherlands Antillian Guilder value: ANG BHD: description: Bahraini Dinar value: BHD SIT: description: Slovenian Tolar value: SIT PTE: description: Portuguese Escudo value: PTE BPP: description: Bonus Point Price value: BPP KZT: description: Kazakhstani Tenge value: KZT SZL: description: Swazi Lilangeni value: SZL SRD: description: Surinam Dollar value: SRD LTL: description: Lithuanian Litas value: LTL TTD: description: Trinidad and Tobago Dollar value: TTD SAR: description: Saudi Riyal value: SAR YER: description: Yemeni Rial value: YER MVR: description: Maldivian Rufiyaa value: MVR AFN: description: Afghani value: AFN BPV: description: Bonus Point Value value: BPV INR: description: Indian Rupee value: INR KRW: description: South Korean Won value: KRW AWG: description: Aruban Florin value: AWG NPR: description: Nepalese Rupee value: NPR MNT: description: Mongolian Tugrik value: MNT JPY: description: Japanese Yen value: JPY AOA: description: Angolan Kwanza value: AOA PLN: description: Polish Złoty value: PLN GBP: description: Pound Sterling value: GBP SBD: description: Solomon Islands Dollar value: SBD 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 personal group identifier (submitted as matrix parameter ```;pgid=```). required: false style: matrix schema: type: string description: The personal group identifier (submitted as matrix parameter ```;pgid=```). example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 spgid: name: spgid in: path description: The secure personal group identifier (submitted as matrix parameter ```;spgid=```). required: false style: matrix schema: type: string description: The secure personal group identifier (submitted as matrix parameter ```;spgid=```). 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_v100 x-origin-class: com.intershop.component.rest.capi.resource.RootResource,com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource,com.intershop.sellside.rest.common.capi.resource.basket.BasketResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource,com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource,com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource x-apiMediaType: application/vnd.intershop.basket.v1+json x-strict-apiMediaType: "true"