openapi: 3.0.1 info: title: Customer description: |- The _Customer REST API_ provides resources for performing various customer-related operations. These include registering new customers, managing address and payment information, handling gift cards and certificates, and interacting with user profiles associated with B2B customers. For operations related to Intershop Commerce Management (back office), refer to the Customer Management REST API. ## Changelog - - - ### Version 1.3.0 * __BETA__ | Added attribute `customFieldDefintions` to the resource objects `PrivateCustomerRO`and `SMBCustomerRO` ### Version 1.2.1 * Added this changelog ### Version 1.2.0 * Added read-only attributes `externalID` and `externalUrn` to the `Address` resource object version: 1.3.0 servers: - url: "/INTERSHOP/rest/{serverGroup}/{siteName}/{appUrl}" description: Intershop ICM Server variables: serverGroup: description: The server group default: WFS siteName: description: The site name default: inSPIRED-inTRONICS-Site appUrl: description: The application URL identifier enum: - rest - rest - example - "-" default: rest paths: /customers: post: tags: - General summary: registers a new SMB customer operationId: createCustomer requestBody: content: application/json: schema: $ref: '#/components/schemas/NewCustomerRO' text/xml: schema: $ref: '#/components/schemas/NewCustomerRO' responses: "201": description: Created content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' "400": description: Bad request "401": description: Authorization is required if the customer gets assigned to an existing user "403": description: Authorized user has to be the same as the one to get assigned to the new customer security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource.createCustomer(com.intershop.sellside.rest.smb.capi.resourceobject.NewCustomerRO) x-origin-class: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource /customers/{CustomerKey}: get: tags: - General summary: Get customer profile of currently logged in user operationId: getCustomer parameters: - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SMBCustomerRO' text/xml: schema: $ref: '#/components/schemas/SMBCustomerRO' "401": description: Unauthorized "403": description: FORBIDDEN "404": description: Not found security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerRO com.intershop.sellside.rest.smb.capi.resource.customer.CustomerItemResource.getCustomer() x-origin-class: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerItemResource put: tags: - General summary: Update customer profile of currently logged in user operationId: updateCustomer parameters: - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/SMBCustomerRO' text/xml: schema: $ref: '#/components/schemas/SMBCustomerRO' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SMBCustomerRO' text/xml: schema: $ref: '#/components/schemas/SMBCustomerRO' "401": description: Unauthorized "404": description: Not found security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerRO com.intershop.sellside.rest.smb.capi.resource.customer.CustomerItemResource.updateCustomer(com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerRO) x-origin-class: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerItemResource /customers/{CustomerKey}/addresses: get: tags: - Address summary: Returns the customer's addresses description: | This operation returns a list of the customer's addresses based on the provided CustomerResourceKey. The response resource collection contains objects of the type LinkRO. operationId: getAddresses parameters: - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource responses: "200": description: OK - The addresses of the customer. content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' links: itemInfo: operationId: getAddress parameters: CustomerAddressKey: "$response.body#/elements/{$index}/itemId" description: Links to item of type AddressRO "401": description: Unauthorized - The organization is not valid. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressListResource.getAddresses() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressListResource post: tags: - Address summary: Create new customer address description: Creates a new customer address by using POST data provided by the client operationId: createAddress parameters: - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/AddressRO' text/xml: schema: $ref: '#/components/schemas/AddressRO' responses: "200": description: |- OK The created address is a duplicate. The existing instance is returned. "201": description: |- Created Creation of a unique address finished succesfully "401": description: Unauthorized "400": description: |- Bad request possible values for header error-key: - customer.address.invalid_fields.usage.error - customer.address.missing_fields.error "404": description: |- Not found possible values for header error-key: - customer.address.not_found.error security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressListResource.createAddress(com.intershop.sellside.rest.common.capi.resourceobject.AddressRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressListResource /customers/{CustomerKey}/addresses/{CustomerAddressKey}: get: tags: - Address summary: Get customer address details description: Returns details about customer's address to the client operationId: getAddress parameters: - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource - name: CustomerAddressKey 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.customer.address.CustomerAddressListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AddressRO' text/xml: schema: $ref: '#/components/schemas/AddressRO' "401": description: Unauthorized "404": description: |- Not found possible values for header error-key: - customer.address_not_found.error security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.AddressRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource.getAddress() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource put: tags: - Address summary: Update customer address description: Updates a customer address with address data provided from the client operationId: updateAddress parameters: - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource - name: CustomerAddressKey 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.customer.address.CustomerAddressListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/AddressRO' text/xml: schema: $ref: '#/components/schemas/AddressRO' responses: "200": description: OK "400": description: "Bad request\n possible values for header error-key:\n - customer.address.missing_fields.error\n\ \ - customer.address.update.error.inconsistentUsage\n Other errors (`customer.address.update.error.failureCode`)\ \ may be returned if `AddressUpdateHandlers` are registered " "401": description: Unauthorized "403": description: |- FORBIDDEN possible values for header error-key: - customer.address.update.error.AddressNotUpdatable "404": description: |- Not found possible values for header error-key: - customer.address.not_found.error security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource.updateAddress(com.intershop.sellside.rest.common.capi.resourceobject.AddressRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource delete: tags: - Address summary: Delete customer address description: Deletes a customer address operationId: deleteAddress parameters: - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource - name: CustomerAddressKey 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.customer.address.CustomerAddressListResource responses: "204": description: No content "401": description: Unauthorized "404": description: Not found "409": description: |- Conflict possible values for header error-key: - customer.address.deletion.error.LastAddress - customer.address.deletion.error.WrongAddressRepository Other errors (`customer.address.deletion.error.failureCode`) may be returned if additional `AddressDeletionHandlers` are registered security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource.deleteAddress() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource /customers/{CustomerKey}/payments: get: tags: - Payment summary: Get list of customer profile payments description: Returns a list of all payment methods as Links that are store in the customer profile of the logged in customer. operationId: getPayments parameters: - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' links: itemInfo: operationId: getPayment parameters: CustomerPaymentKey: "$response.body#/elements/{$index}/itemId" description: Links to item of type PaymentRO "401": description: Unauthorized "404": description: "Not found\n value for header error-key: \n - payment.instrument.not_found.error\ \ (e.g. unregistred user)" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentListResource.getPayments() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentListResource post: tags: - Payment summary: Add a payment to Customer profile description: Adds a payment to the customer profile of the logged in customer. operationId: createPayment parameters: - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentRO' text/xml: schema: $ref: '#/components/schemas/PaymentRO' responses: "201": description: Created "401": description: Unauthorized "400": description: |- Bad request possible values for header error-key: - shopping_cart.payment.paymentdata.error (e.g., wrong giftcard number) - shopping_cart.payment.missing_fields.error - shopping_cart.payment.invalid_fields.error - shopping_cart.payment.name.error (payment method not found) - shopping_cart.payment.dublicate.error security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentListResource.createPayment(com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentListResource options: tags: - Payment summary: Return payment options for customer description: Returns all available payment methods and its parameters that can be added to the customer operationId: getPaymentOptions parameters: - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PaymentOptionsRO' text/xml: schema: $ref: '#/components/schemas/PaymentOptionsRO' "401": description: Unauthorized security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentOptionsRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentListResource.getPaymentOptions() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentListResource /customers/{CustomerKey}/payments/{CustomerPaymentKey}: get: tags: - Payment summary: Get details of a customer profile payment description: Returns detailed information of a payment method available for a customer operationId: getPayment parameters: - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource - name: CustomerPaymentKey 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.customer.payment.CustomerPaymentListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PaymentRO' text/xml: schema: $ref: '#/components/schemas/PaymentRO' "401": description: Unauthorized "404": description: "Not found\n value for header error-key: \n - payment.instrument.not_found.error\ \ (e.g. unregistred user)" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource.getPayment() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource put: tags: - Payment summary: Update payment from customer profile description: Updates a payment (with attributes) from customer profile for the logged in user. The request has to contain all attributes even if they are not changed. Payments without further attributes can not be updated. operationId: updatePayment parameters: - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource - name: CustomerPaymentKey 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.customer.payment.CustomerPaymentListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentRO' text/xml: schema: $ref: '#/components/schemas/PaymentRO' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PaymentRO' text/xml: schema: $ref: '#/components/schemas/PaymentRO' "401": description: Unauthorized "400": description: |- Bad request possible values for header error-key: - shopping_cart.payment.paymentdata.error (e.g. wrong giftcard number) - shopping_cart.payment.missing_fields.error - shopping_cart.payment.invalid_fields.error security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource.updatePayment(com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource delete: tags: - Payment summary: Remove a payment from customer profile description: Removes a payment method from the customer profile of the logged in customer operationId: deletePayment parameters: - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource - name: CustomerPaymentKey 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.customer.payment.CustomerPaymentListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' "401": description: Unauthorized "404": description: Not found security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource.deletePayment() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource /customers/{CustomerKey}/users: get: tags: - User summary: Get users of SMB customer description: List all registered users of selected SMB customer with link to user item resource. operationId: getCustomers parameters: - name: offset in: query description: The start element position schema: type: string default: "0" - name: limit in: query description: The count of users to return schema: type: string default: "50" - name: filter in: query description: "Only users which firtName, lastName or login contains the filter\ \ will be returned" schema: type: string - name: sort in: query description: The sorting to be applied on returned users. Minus means sorting in DESC direction. schema: type: string enum: - name - creationDate - login - -name - -creationDate - -login default: name - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource responses: "200": description: The list of registered users content: application/json: schema: $ref: '#/components/schemas/UserLinkROCollection' text/xml: schema: $ref: '#/components/schemas/UserLinkROCollection' "401": description: Unauthorized content: application/json: schema: type: string text/xml: schema: type: string "404": description: Not found content: application/json: schema: type: string text/xml: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource.getCustomers() x-origin-class: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource post: tags: - User summary: Registers new users of SMB customer operationId: addUsersToCustomer parameters: - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource requestBody: description: A collection with data of the new users to be created. content: application/json: schema: $ref: '#/components/schemas/SMBCustomerUserROCollection' text/xml: schema: $ref: '#/components/schemas/SMBCustomerUserROCollection' responses: "201": description: Collection with links to created users content: application/json: schema: $ref: '#/components/schemas/UserLinkROCollection' text/xml: schema: $ref: '#/components/schemas/UserLinkROCollection' "207": description: Collection with links to created users and header 'not-created-users' with list of users which creation finished with error content: application/json: schema: $ref: '#/components/schemas/UserLinkROCollection' text/xml: schema: $ref: '#/components/schemas/UserLinkROCollection' "401": description: Unauthorized content: application/json: schema: type: string text/xml: schema: type: string "409": description: In case user with provided login or business partner number already exists content: application/json: schema: type: string text/xml: schema: type: string "400": description: In case provided login is not acceptable content: application/json: schema: type: string text/xml: schema: type: string "500": description: In case provided user data contain missing or invalid fields content: application/json: schema: type: string text/xml: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource.addUsersToCustomer(com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerUserROCollection) x-origin-class: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource /customers/{CustomerKey}/users/{CustomerItemUserKey}: get: tags: - User summary: Get user profile data of selected user operationId: getCustomerUser parameters: - name: include in: query description: "The relations to be included in returned user data, If not provided\ \ all user data will be included." schema: type: string enum: - general - preferredShipToAddress - preferredInvoiceToAddress - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey 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.smb.capi.resource.user.CustomerItemUserListResource responses: "200": description: "Display available user data. In case user has preferred address\ \ assigned, all address data will be displayed in the response." content: application/json: schema: $ref: '#/components/schemas/SMBCustomerUserRO' text/xml: schema: $ref: '#/components/schemas/SMBCustomerUserRO' "401": description: Unauthorized content: application/json: schema: type: string text/xml: schema: type: string "404": description: Not found content: application/json: schema: type: string text/xml: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerUserRO com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserItemResource.getCustomerUser() x-origin-class: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserItemResource put: tags: - User summary: Update the profile of selected user of SMB customer operationId: updateCustomerUser parameters: - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey 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.smb.capi.resource.user.CustomerItemUserListResource requestBody: description: The updated data of the user. content: application/json: schema: $ref: '#/components/schemas/SMBCustomerUserRO' text/xml: schema: $ref: '#/components/schemas/SMBCustomerUserRO' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/SMBCustomerUserRO' text/xml: schema: $ref: '#/components/schemas/SMBCustomerUserRO' "401": description: Unauthorized content: application/json: schema: type: string text/xml: schema: type: string "404": description: Not found content: application/json: schema: type: string text/xml: schema: type: string "400": description: Bad request content: application/json: schema: type: string text/xml: schema: type: string "409": description: In case user with provided business partner number already exists content: application/json: schema: type: string text/xml: schema: type: string "500": description: In case provided user data contain missing or invalid fields content: application/json: schema: type: string text/xml: schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserItemResource.updateCustomerUser(com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerUserRO) x-origin-class: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserItemResource delete: tags: - User summary: Delete user of SMB customer description: Deletes the user with the same ID or login as the item resource name operationId: deleteUser parameters: - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey 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.smb.capi.resource.user.CustomerItemUserListResource responses: "204": description: No content "401": description: Unauthorized content: '*/*': schema: type: string "404": description: Not found content: '*/*': schema: type: string "403": description: |- FORBIDDEN Requires authentication with user having assigned the following permission: Manage Users (APP_B2B_MANAGE_USERS) content: '*/*': schema: type: string security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserItemResource.deleteUser() x-origin-class: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserItemResource /customers/{CustomerKey}/users/{CustomerItemUserKey}/giftcardsandcertificates: get: tags: - Gift Card and Certificate summary: Returns gift cards and certificates description: This operation returns a list of gift cards and certificates associated with the current user. operationId: getGiftCardsAndCertificates_1 parameters: - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey 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.smb.capi.resource.user.CustomerItemUserListResource responses: "200": description: OK - The list of gift cards and certificates. content: application/json: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' text/xml: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' "404": description: Not found - The customer or user could not be found. "403": description: Forbidden - The authenticated user does not match the requested user. "401": description: Unauthorized - The user could not be authenticated. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.giftcardsandcertificates.CustomerGiftCardsAndCertificatesResource.getGiftCardsAndCertificates() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.giftcardsandcertificates.CustomerGiftCardsAndCertificatesResource /customers/{CustomerKey}/users/{CustomerItemUserKey}/giftcardsandcertificates/{CustomerGiftCardAndCertificateResourceKey}: get: tags: - Gift Card and Certificate summary: Returns gift card or certificate details description: This operation returns details about a specific gift card or certificate associated with the current user. operationId: getGiftCardAndCertificate_1 parameters: - name: CustomerKey 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.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey 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.smb.capi.resource.user.CustomerItemUserListResource - name: CustomerGiftCardAndCertificateResourceKey in: path description: The gift card or certificate number required: true schema: type: string description: The gift card or certificate number example: "27755166187" example: "27755166187" x-item-key: com.intershop.sellside.rest.common.capi.resource.customer.giftcardsandcertificates.CustomerGiftCardsAndCertificatesResource responses: "200": description: OK - The gift card or certificate with the given ID. content: application/json: schema: $ref: '#/components/schemas/GiftCardAndCertificateRO' text/xml: schema: $ref: '#/components/schemas/GiftCardAndCertificateRO' "404": description: "Not found - The customer, user or gift card/certificate could\ \ not be found." "403": description: Forbidden - The authenticated user does not match the requested user. "401": description: Unauthorized - The user could not be authenticated. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.GiftCardAndCertificateRO com.intershop.sellside.rest.common.capi.resource.customer.giftcardsandcertificates.balance.CustomerGiftCardAndCertificateResource.getGiftCardAndCertificate() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.giftcardsandcertificates.balance.CustomerGiftCardAndCertificateResource /privatecustomers: post: tags: - General summary: Create individual customer description: Creates an individual customer. Available for unregistered users only. operationId: createCustomer_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/NewCustomerRO' text/xml: schema: $ref: '#/components/schemas/NewCustomerRO' responses: "201": description: Created "400": description: |- Bad request possible values for header error-key: - customer.already_exists.error - customer.customerno.already_exists.error - customer.missing_fields.error - customer.invalid_fields.error - customer.credentials.missing_fields.error - customer.credentials.login.not_acceptable.error - customer.credentials.login.not_unique.error - customer.credentials.password.invalid.error - customer.address.missing_fields.error "409": description: Conflict "401": description: Authorization is required if the customer gets assigned to an existing user "403": description: Authorized user has to be the same as the one to get assigned to the new customer security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource.createCustomer(com.intershop.sellside.rest.b2c.capi.resourceobject.NewCustomerRO) x-origin-class: com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource /privatecustomers/simple: post: tags: - General summary: Create Customer description: simplified creation process for new customerwith minimal information operationId: createAccount requestBody: content: application/json: schema: $ref: '#/components/schemas/CredentialsRO' text/xml: schema: $ref: '#/components/schemas/CredentialsRO' responses: "201": description: Created "400": description: Bad request "409": description: |- Conflict possible values for header error-key: - customer.already_exists.error "501": description: |- Not implemented possible values for header error-key: - customer.simpleaccount.not_possible.error security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource.createAccount(com.intershop.sellside.rest.common.capi.resourceobject.CredentialsRO) x-origin-class: com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource /privatecustomers/{CustomerKey}: get: tags: - General summary: Get current customer profile details operationId: getCustomer_1 parameters: - name: CustomerKey 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.b2c.capi.resource.customer.PrivateCustomerListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PrivateCustomerRO' text/xml: schema: $ref: '#/components/schemas/PrivateCustomerRO' "401": description: Unauthorized "403": description: FORBIDDEN "404": description: Not found security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.b2c.capi.resourceobject.PrivateCustomerRO com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerItemResource.getCustomer() x-origin-class: com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerItemResource put: tags: - General summary: Upates a customer operationId: updateCustomer_1 parameters: - name: CustomerKey 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.b2c.capi.resource.customer.PrivateCustomerListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/PrivateCustomerRO' text/xml: schema: $ref: '#/components/schemas/PrivateCustomerRO' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PrivateCustomerRO' text/xml: schema: $ref: '#/components/schemas/PrivateCustomerRO' "401": description: Unauthorized "400": description: Bad request "404": description: Not found security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.b2c.capi.resourceobject.PrivateCustomerRO com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerItemResource.updateCustomer(com.intershop.sellside.rest.b2c.capi.resourceobject.PrivateCustomerRO) x-origin-class: com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerItemResource /privatecustomers/{CustomerKey}/addresses: get: tags: - Address summary: Returns the customer's addresses description: | This operation returns a list of the customer's addresses based on the provided CustomerResourceKey. The response resource collection contains objects of the type LinkRO. operationId: getAddresses parameters: - name: CustomerKey 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.b2c.capi.resource.customer.PrivateCustomerListResource responses: "200": description: OK - The addresses of the customer. content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' links: itemInfo: operationId: getAddress_1 parameters: CustomerAddressKey: "$response.body#/elements/{$index}/itemId" description: Links to item of type AddressRO "401": description: Unauthorized - The organization is not valid. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressListResource.getAddresses() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressListResource post: tags: - Address summary: Create new customer address description: Creates a new customer address by using POST data provided by the client operationId: createAddress_1 parameters: - name: CustomerKey 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.b2c.capi.resource.customer.PrivateCustomerListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/AddressRO' text/xml: schema: $ref: '#/components/schemas/AddressRO' responses: "200": description: |- OK The created address is a duplicate. The existing instance is returned. "201": description: |- Created Creation of a unique address finished succesfully "401": description: Unauthorized "400": description: |- Bad request possible values for header error-key: - customer.address.invalid_fields.usage.error - customer.address.missing_fields.error "404": description: |- Not found possible values for header error-key: - customer.address.not_found.error security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressListResource.createAddress(com.intershop.sellside.rest.common.capi.resourceobject.AddressRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressListResource /privatecustomers/{CustomerKey}/addresses/{CustomerAddressKey}: get: tags: - Address summary: Get customer address details description: Returns details about customer's address to the client operationId: getAddress_1 parameters: - name: CustomerKey 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.b2c.capi.resource.customer.PrivateCustomerListResource - name: CustomerAddressKey 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.customer.address.CustomerAddressListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AddressRO' text/xml: schema: $ref: '#/components/schemas/AddressRO' "401": description: Unauthorized "404": description: |- Not found possible values for header error-key: - customer.address_not_found.error security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.AddressRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource.getAddress() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource put: tags: - Address summary: Update customer address description: Updates a customer address with address data provided from the client operationId: updateAddress_1 parameters: - name: CustomerKey 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.b2c.capi.resource.customer.PrivateCustomerListResource - name: CustomerAddressKey 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.customer.address.CustomerAddressListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/AddressRO' text/xml: schema: $ref: '#/components/schemas/AddressRO' responses: "200": description: OK "400": description: "Bad request\n possible values for header error-key:\n - customer.address.missing_fields.error\n\ \ - customer.address.update.error.inconsistentUsage\n Other errors (`customer.address.update.error.failureCode`)\ \ may be returned if `AddressUpdateHandlers` are registered " "401": description: Unauthorized "403": description: |- FORBIDDEN possible values for header error-key: - customer.address.update.error.AddressNotUpdatable "404": description: |- Not found possible values for header error-key: - customer.address.not_found.error security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource.updateAddress(com.intershop.sellside.rest.common.capi.resourceobject.AddressRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource delete: tags: - Address summary: Delete customer address description: Deletes a customer address operationId: deleteAddress_1 parameters: - name: CustomerKey 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.b2c.capi.resource.customer.PrivateCustomerListResource - name: CustomerAddressKey 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.customer.address.CustomerAddressListResource responses: "204": description: No content "401": description: Unauthorized "404": description: Not found "409": description: |- Conflict possible values for header error-key: - customer.address.deletion.error.LastAddress - customer.address.deletion.error.WrongAddressRepository Other errors (`customer.address.deletion.error.failureCode`) may be returned if additional `AddressDeletionHandlers` are registered security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource.deleteAddress() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource /privatecustomers/{CustomerKey}/giftcardsandcertificates: get: tags: - Gift Card and Certificate summary: Returns gift cards and certificates description: This operation returns a list of gift cards and certificates associated with the current user. operationId: getGiftCardsAndCertificates parameters: - name: CustomerKey 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.b2c.capi.resource.customer.PrivateCustomerListResource responses: "200": description: OK - The list of gift cards and certificates. content: application/json: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' text/xml: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' "404": description: Not found - The customer or user could not be found. "403": description: Forbidden - The authenticated user does not match the requested user. "401": description: Unauthorized - The user could not be authenticated. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.giftcardsandcertificates.CustomerGiftCardsAndCertificatesResource.getGiftCardsAndCertificates() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.giftcardsandcertificates.CustomerGiftCardsAndCertificatesResource /privatecustomers/{CustomerKey}/giftcardsandcertificates/{CustomerGiftCardAndCertificateResourceKey}: get: tags: - Gift Card and Certificate summary: Returns gift card or certificate details description: This operation returns details about a specific gift card or certificate associated with the current user. operationId: getGiftCardAndCertificate parameters: - name: CustomerKey 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.b2c.capi.resource.customer.PrivateCustomerListResource - name: CustomerGiftCardAndCertificateResourceKey in: path description: The gift card or certificate number required: true schema: type: string description: The gift card or certificate number example: "27755166187" example: "27755166187" x-item-key: com.intershop.sellside.rest.common.capi.resource.customer.giftcardsandcertificates.CustomerGiftCardsAndCertificatesResource responses: "200": description: OK - The gift card or certificate with the given ID. content: application/json: schema: $ref: '#/components/schemas/GiftCardAndCertificateRO' text/xml: schema: $ref: '#/components/schemas/GiftCardAndCertificateRO' "404": description: "Not found - The customer, user or gift card/certificate could\ \ not be found." "403": description: Forbidden - The authenticated user does not match the requested user. "401": description: Unauthorized - The user could not be authenticated. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.GiftCardAndCertificateRO com.intershop.sellside.rest.common.capi.resource.customer.giftcardsandcertificates.balance.CustomerGiftCardAndCertificateResource.getGiftCardAndCertificate() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.giftcardsandcertificates.balance.CustomerGiftCardAndCertificateResource /privatecustomers/{CustomerKey}/payments: get: tags: - Payment summary: Get list of customer profile payments description: Returns a list of all payment methods as Links that are store in the customer profile of the logged in customer. operationId: getPayments_1 parameters: - name: CustomerKey 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.b2c.capi.resource.customer.PrivateCustomerListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' links: itemInfo: operationId: getPayment_1 parameters: CustomerPaymentKey: "$response.body#/elements/{$index}/itemId" description: Links to item of type PaymentRO "401": description: Unauthorized "404": description: "Not found\n value for header error-key: \n - payment.instrument.not_found.error\ \ (e.g. unregistred user)" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentListResource.getPayments() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentListResource post: tags: - Payment summary: Add a payment to Customer profile description: Adds a payment to the customer profile of the logged in customer. operationId: createPayment_1 parameters: - name: CustomerKey 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.b2c.capi.resource.customer.PrivateCustomerListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentRO' text/xml: schema: $ref: '#/components/schemas/PaymentRO' responses: "201": description: Created "401": description: Unauthorized "400": description: |- Bad request possible values for header error-key: - shopping_cart.payment.paymentdata.error (e.g., wrong giftcard number) - shopping_cart.payment.missing_fields.error - shopping_cart.payment.invalid_fields.error - shopping_cart.payment.name.error (payment method not found) - shopping_cart.payment.dublicate.error security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentListResource.createPayment(com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentListResource options: tags: - Payment summary: Return payment options for customer description: Returns all available payment methods and its parameters that can be added to the customer operationId: getPaymentOptions_1 parameters: - name: CustomerKey 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.b2c.capi.resource.customer.PrivateCustomerListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PaymentOptionsRO' text/xml: schema: $ref: '#/components/schemas/PaymentOptionsRO' "401": description: Unauthorized security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentOptionsRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentListResource.getPaymentOptions() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentListResource /privatecustomers/{CustomerKey}/payments/{CustomerPaymentKey}: get: tags: - Payment summary: Get details of a customer profile payment description: Returns detailed information of a payment method available for a customer operationId: getPayment_1 parameters: - name: CustomerKey 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.b2c.capi.resource.customer.PrivateCustomerListResource - name: CustomerPaymentKey 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.customer.payment.CustomerPaymentListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PaymentRO' text/xml: schema: $ref: '#/components/schemas/PaymentRO' "401": description: Unauthorized "404": description: "Not found\n value for header error-key: \n - payment.instrument.not_found.error\ \ (e.g. unregistred user)" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource.getPayment() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource put: tags: - Payment summary: Update payment from customer profile description: Updates a payment (with attributes) from customer profile for the logged in user. The request has to contain all attributes even if they are not changed. Payments without further attributes can not be updated. operationId: updatePayment_1 parameters: - name: CustomerKey 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.b2c.capi.resource.customer.PrivateCustomerListResource - name: CustomerPaymentKey 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.customer.payment.CustomerPaymentListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentRO' text/xml: schema: $ref: '#/components/schemas/PaymentRO' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/PaymentRO' text/xml: schema: $ref: '#/components/schemas/PaymentRO' "401": description: Unauthorized "400": description: |- Bad request possible values for header error-key: - shopping_cart.payment.paymentdata.error (e.g. wrong giftcard number) - shopping_cart.payment.missing_fields.error - shopping_cart.payment.invalid_fields.error security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource.updatePayment(com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource delete: tags: - Payment summary: Remove a payment from customer profile description: Removes a payment method from the customer profile of the logged in customer operationId: deletePayment_1 parameters: - name: CustomerKey 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.b2c.capi.resource.customer.PrivateCustomerListResource - name: CustomerPaymentKey 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.customer.payment.CustomerPaymentListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' "401": description: Unauthorized "404": description: Not found security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource.deletePayment() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource components: schemas: LinkRO: title: Link type: object properties: name: type: string description: The name of the returned element xml: attribute: true type: type: string description: "This is a constant: **Link**" readOnly: true example: Link xml: attribute: true attributes: type: array description: The list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' uri: type: string description: The URI relation: type: string description: The relation of the link externalDocs: description: Link Relations (www.iana.org) url: http://www.iana.org/assignments/link-relations/link-relations.xml enum: - about - alternate - appendix - archives - author - bookmark - canonical - chapter - collection - contents - copyright - create-form - current - describedby - describes - disclosure - duplicate - edit - edit-form - edit-media - enclosure - first - glossary - help - hosts - hub - icon - index - item - last - latest-version - license - lrdd - monitor - monitor-group - next - next-archive - nofollow - noreferrer - payment - predecessor-version - prefetch - prev - preview - previous - prev-archive - privacy-policy - profile - related - replies - search - section - self - service - start - stylesheet - subsection - successor-version - tag - terms-of-service - type - up - version-history - via - working-copy - working-copy-of title: type: string description: The title of the link description: type: string description: The description of the link itemId: type: string description: The ID of the linked item attribute: $ref: '#/components/schemas/ResourceAttribute' description: A Link pointing to a resource xml: name: Link ResourceAttribute: title: Attribute type: object properties: name: type: string description: The attribute's name xml: attribute: true type: type: string description: "This is a constant: **ResourceAttribute**" example: ResourceAttribute xml: attribute: true value: type: object description: The attribute's value. description: An attribute xml: name: ResourceAttribute AddressRO: title: Address type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: Address xml: attribute: true urn: type: string description: the URN representation of this address example: urn:address:customer:1234567890:0987654321 id: type: string description: The ID of the returned element example: vagKAB17gg4AAAFGSkFqQASI externalId: type: string description: The ID uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system readOnly: true example: "000123456" externalUrn: type: string description: The URN uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system readOnly: true example: urn:address:MSDynamics365:MyCorp:000123456 addressName: type: string description: The name of the address example: customeraddr-ABCDEFGPRMuMCscyXgSRVU title: type: string description: "The (personal) title of the contact person, like 'Mr.' or\ \ 'Ms.'" example: Mrs. aristocraticTitle: type: string description: "the aristocratic title of the contact person, like Lord\ \ or Lady" jobTitle: type: string description: the job title of the contact person example: CEO honorific: type: string description: "the honorific title of the contact person that denotes the\ \ honored person's occupation, like Captain, Coach, Officer,\ \ Reverend or the academic title, like PhD" firstName: type: string description: The (first) given name of the contact person example: Patricia secondName: type: string description: the second given name of the contact person example: Luise lastName: type: string description: The last name of the contact person example: Miller secondLastName: type: string description: the second last name of the contact person companyName1: type: string description: the company name example: PMiller ltd. companyName2: type: string description: The second company name addressLine1: type: string description: the first address line example: Berliner Str. 20 addressLine2: type: string description: the second address line example: 1st Floor addressLine3: type: string description: The third address line example: Second door on the right postBox: type: string description: the post-office box example: PO Box 42 mainDivision: type: string description: "the main division of the country, e. g. a state or province" example: AL mainDivisionName: type: string description: The localized display name of the main division example: Alabama subDivision: type: string description: The sub division code of the country. example: GB-PKN subDivisionName: type: string description: The localized display name of the sub division example: Perth and Kinross postalCode: type: string description: The postal code example: "14482" email: type: string description: the e-mail address of the contact person example: pmiller@intershop.de phoneMobile: type: string description: The number of the contact person's cell phone example: "+49364112677" phoneHome: type: string description: The phone number of the house or apartment where the contact person lives example: "049364112677" phoneBusiness: type: string description: The phone number of the contact person's company example: "049364112699" phoneBusinessDirect: type: string description: the business phone number of the contact person that allows an outside caller to connect directly to the contact person without any help of an attendant or operator example: "049364112659" country: type: string description: The display name of the country in the current locale example: Germany countryCode: type: string description: The country code example: DE city: type: string description: The name of the city example: Potsdam fax: type: string description: the fax number example: "049364112643" 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: A049364112643 usage: type: object properties: empty: type: boolean description: " Returns usage information for the address. Every bit in the\ \ returned set marks a specific usage type, like ship-from or invoice-to\ \ address. If a bit is set, the address may be used for the specific purpose\ \ mapped to this bit. Further bits may be used for custom types. Default\ \ usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to" description: This resource holds the details of an address. xml: name: Address CredentialsRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true login: type: string description: the login example: pmiller@test.intershop.de password: type: string description: the password example: '!InterShop00!' securityQuestion: type: string description: the security question example: what was the name of your first pet? securityQuestionAnswer: type: string description: the security questions answer example: Snoopy description: the credentials of the new customer as CredentialsRO nullable: true xml: name: Credentials CustomFieldDefinitionRO_v1: type: object properties: description: type: string description: The localized custom field description. readOnly: true displayName: type: string description: The localized display name of the custom field. readOnly: true example: Delivery Preference name: type: string description: The name of an element readOnly: true example: deliveryPreference position: type: integer description: The position of the custom field in the list of custom fields. format: int32 readOnly: true example: 1 scopes: type: array description: A list of configured scopes for this custom field. readOnly: true items: $ref: '#/components/schemas/CustomFieldDefinitionScopeRO_v1' type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true example: String description: __BETA__ | A representation of a custom field definition. readOnly: true CustomFieldDefinitionScopeRO_v1: type: object properties: isEditable: type: boolean description: Flag indicating whether a custom field can be edited or not. readOnly: true example: true isVisible: type: boolean description: Flag indicating whether a custom field is visible or not. readOnly: true example: true name: type: string description: The name of an element readOnly: true example: Basket description: __BETA__ | A representation of a custom field definition scope. readOnly: true GenericPropertyROObject: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true key: type: string property: type: object displayName: type: string xml: name: Property MoneyRO: title: Money type: object properties: type: type: string description: "This is a constant: **Money**" readOnly: true example: Money xml: attribute: true value: type: number description: The monetary value. example: 10.99 currencyMnemonic: type: string deprecated: true currency: type: string description: Three-letter currency code (ISO 4217) of the monetary value. example: USD description: Money combines a currency and a money amount. readOnly: true xml: name: Money NewCustomerRO: type: object properties: address: $ref: '#/components/schemas/AddressRO' birthday: type: string description: the birthday of the customer nullable: true example: 1970-03-10 credentials: $ref: '#/components/schemas/CredentialsRO' customFieldDefinitions: type: array description: "The collection of the custom field definitions
[BETA]:\ \ This property is still in BETA and could be subject to breaking changes." readOnly: true items: $ref: '#/components/schemas/CustomFieldDefinitionRO_v1' customerNo: type: string customerType: type: string description: the type of the customer readOnly: true example: PRIVATE email: type: string description: the email address of the customer nullable: true example: patrik@test.intershop.net externalURN: type: string description: the external URN of the customer nullable: true example: A4211324 fax: type: string description: the fax number of the customer nullable: true example: "4211324" firstName: type: string description: the first name of the customer nullable: true example: Patrik lastName: type: string description: the last name of the customer nullable: true example: Mueller login: type: string description: the login(username) of the customer nullable: true example: patrik_83 name: type: string description: The name of an element xml: attribute: true phoneBusiness: type: string description: the business phone number of the customer nullable: true example: "4211324" phoneHome: type: string description: the phone home number of the customer nullable: true example: "4211324" phoneMobile: type: string description: the mobile phone number of the customer nullable: true example: "4211324" preferredInvoiceToAddress: $ref: '#/components/schemas/AddressRO' preferredLanguage: type: string description: the preferred language of the customer nullable: true example: de_DE preferredPaymentInstrument: $ref: '#/components/schemas/PaymentRO' preferredShipToAddress: $ref: '#/components/schemas/AddressRO' title: type: string description: the title of the customer nullable: true example: Mr type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: PrivateCustomer xml: attribute: true userId: type: string description: "the id of the user this customer is based on. If not set,\ \ credentials and user data are mandatory." nullable: true xml: name: NewCustomer PaymentRO: title: Payment type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: Payment xml: attribute: true attributes: type: array description: The list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' id: type: string description: The payment ID example: dhKsEmZRPyEAAAF2hyV6dB2n limitedTenderBalance: $ref: '#/components/schemas/MoneyRO' paymentTotalAmount: $ref: '#/components/schemas/MoneyRO' accountIdentifier: type: string description: The optional account identifier for this payment instrument readOnly: true example: DE12****7890 parameters: type: array description: The parameters for this payment xml: wrapped: true items: $ref: '#/components/schemas/GenericPropertyROObject' attribute: $ref: '#/components/schemas/ResourceAttribute' xml: name: Payment SMBCustomerUserRO: type: object properties: type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: SMBCustomerUser xml: attribute: true name: type: string description: The name of an element example: SMBCustomerUser xml: attribute: true login: type: string description: The login to be used for that user. example: pmerkel@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 businessPartnerNo: type: string description: ID uniquely identifying the user in the context of the customer. example: PMerkel preferredLanguage: type: string description: the preffered language of the user example: de_DE phoneBusiness: type: string description: the business phone number of the user example: "4211324" phoneMobile: type: string description: the mobile phone number of the user example: "4211324" department: type: string description: the department of the user example: Sales title: type: string description: "The personal title, like Ms., Mr." example: Mr. birthday: type: string description: Date of birth of the person represented by this user in format MM/dd/yyyy nullable: true example: 12/24/1998 preferredPaymentInstrument: $ref: '#/components/schemas/PaymentRO' phoneHome: type: string description: the phone home number of the user example: "4211324" fax: type: string description: the fax number of the user example: "4211324" email: type: string description: the email of the user example: pmerkel@test.intershop.de active: type: boolean description: the user is active or not example: true preferredInvoiceToAddressUrn: type: string description: The URN representation of the preferred invoice address for the user in the format urn:address:customer:addressID:customerID nullable: true example: "" preferredShipToAddressUrn: type: string description: The URN representation of the preferred shipping address for the user in the format urn:address:customer:addressID:customerID nullable: true example: "" xml: name: SMBCustomerUser SMBCustomerRO: type: object properties: companyName: type: string description: the company name of the customer example: AgroNet companyName2: type: string customFieldDefinitions: type: array description: "The collection of the custom field definitions
[BETA]:\ \ This property is still in BETA and could be subject to breaking changes." readOnly: true items: $ref: '#/components/schemas/CustomFieldDefinitionRO_v1' customerNo: type: string customerType: type: string description: the type of the customer readOnly: true example: PRIVATE description: type: string description: the description of the customer example: AgroNet description externalURN: type: string description: the external URN of the customer example: A123456 industry: type: string description: the industry of the customer example: agrar industry name: type: string description: The name of an element xml: attribute: true preferredInvoiceToAddress: $ref: '#/components/schemas/AddressRO' preferredShipToAddress: $ref: '#/components/schemas/AddressRO' taxationID: type: string description: the taxation ID of the customer example: "123456" type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: SMBCustomer xml: attribute: true xml: name: SMBCustomer AbstractResourceObject: title: Object type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true description: The list of elements ResourceCollectionRO: type: object properties: pageable: type: string description: The pageable ID total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/AbstractResourceObject' type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: The keys to sort for xml: name: sortKey name: type: string description: The name of an element xml: attribute: true description: A list of ResourceObjects xml: name: ResourceCollection ResourceCollectionROLinkRO: title: Link List type: object properties: pageable: type: string description: The pageable ID. total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/LinkRO' type: type: string description: "This is a constant: **ResourceCollection**" example: ResourceCollection xml: attribute: true sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: The keys to sort for xml: name: sortKey name: type: string description: The name of the returned element xml: attribute: true description: A list of links xml: name: ResourceCollection PaymentOptionRO: title: PaymentOption type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: PaymentOption xml: attribute: true id: type: string description: The ID of the payment option example: ISH_INVOICE displayName: type: string description: The display name of the payment option example: Invoice applicability: type: string example: Applicable restrictions: type: array description: The restrictions for this payment option xml: wrapped: true items: type: string xml: name: restriction paymentParameters: type: array description: The parameters for this payment option xml: name: parameters wrapped: true items: $ref: '#/components/schemas/GenericPropertyROObject' description: This resource holds information on a payment option. xml: name: PaymentOption PaymentOptionsForMethodRO: title: PaymentOptionsForMethod type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: PaymentOptionsForMethodRO xml: attribute: true payments: type: array description: The payments items: $ref: '#/components/schemas/PaymentOptionRO' method: type: string description: The HTTP method to use when adding this method example: POST description: This resource holds information about payment methods that can be added and the HTTP method to be used. xml: name: PaymentOptionsForMethodRO PaymentOptionsRO: title: PaymentOptions type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: PaymentOptions xml: attribute: true methods: type: array description: The payment methods that can be added via HTTP items: $ref: '#/components/schemas/PaymentOptionsForMethodRO' description: This resource holds one or more PaymentOptionsForMethodRO. xml: name: PaymentOptions UserLinkRO: type: object properties: type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: Link xml: attribute: true name: type: string description: The name of an element example: Peter Merkel xml: attribute: true login: type: string description: The login of the user example: pmerkel@test.intershop.de uri: type: string description: the uri to the user item resource example: Organization-Channel-Site/-/customers/-/users/pmerkel@test.intershop.de attributes: type: array description: The list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' attribute: $ref: '#/components/schemas/ResourceAttribute' description: A Link to registered User Item Resource xml: name: Link UserLinkROCollection: type: object properties: type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: UserLinkCollection xml: attribute: true name: type: string description: The name of an element example: users xml: attribute: true amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/UserLinkRO' pageable: type: string description: The pageable ID total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 limit: type: integer description: the maximum count of users to return format: int32 filter: type: string description: the defined filter criteria for returned users sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: The keys to sort for xml: name: sortKey description: A collection of users with link to user item resource xml: name: ResourceCollection SMBCustomerUserROCollection: type: object properties: type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: SMBCustomerUserCollection xml: attribute: true name: type: string description: The name of an element example: Users xml: attribute: true elements: type: array description: The list of elements xml: name: SMBCustomerUser items: $ref: '#/components/schemas/SMBCustomerUserRO' description: A resource object containing the data for one or more users of given SMB Customer xml: name: SMBCustomerUserCollection LinkROResourceCollectionRO: type: object properties: pageable: type: string description: The pageable ID total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/LinkRO' type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: The keys to sort for xml: name: sortKey name: type: string description: The name of an element xml: attribute: true description: A list of Link-ResourceObjects xml: name: ResourceCollection GiftCardAndCertificateRO: title: GiftCardAndCertificate type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: GiftCardAndCertificate xml: attribute: true currency: type: string description: The currency of the gift card example: USD amount: type: number description: The value of the gift card example: 25 amountRemaining: type: number description: The remaining value of the gift card example: 12.73 description: This resource holds information on a gift card or a gift certificate. xml: name: GiftCardAndCertificate PrivateCustomerRO: type: object properties: birthday: type: string description: the birthday of the customer nullable: true example: 1970-03-10 customFieldDefinitions: type: array description: "The collection of the custom field definitions
[BETA]:\ \ This property is still in BETA and could be subject to breaking changes." readOnly: true items: $ref: '#/components/schemas/CustomFieldDefinitionRO_v1' customerNo: type: string customerType: type: string description: the type of the customer readOnly: true example: PRIVATE email: type: string description: the email address of the customer nullable: true example: patrik@test.intershop.net externalURN: type: string description: the external URN of the customer nullable: true example: A4211324 fax: type: string description: the fax number of the customer nullable: true example: "4211324" firstName: type: string description: the first name of the customer nullable: true example: Patrik lastName: type: string description: the last name of the customer nullable: true example: Mueller login: type: string description: the login(username) of the customer nullable: true example: patrik_83 name: type: string description: The name of an element xml: attribute: true phoneBusiness: type: string description: the business phone number of the customer nullable: true example: "4211324" phoneHome: type: string description: the phone home number of the customer nullable: true example: "4211324" phoneMobile: type: string description: the mobile phone number of the customer nullable: true example: "4211324" preferredInvoiceToAddress: $ref: '#/components/schemas/AddressRO' preferredLanguage: type: string description: the preferred language of the customer nullable: true example: de_DE preferredPaymentInstrument: $ref: '#/components/schemas/PaymentRO' preferredShipToAddress: $ref: '#/components/schemas/AddressRO' title: type: string description: the title of the customer nullable: true example: Mr type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: PrivateCustomer xml: attribute: true xml: name: PrivateCustomer responses: "200": description: OK "201": description: Created "202": description: Accepted "204": description: No Content "205": description: Reset Content "206": description: Partial Content "300": description: Multiple Choices "301": description: Moved Permanently "302": description: Found "303": description: See Other "304": description: Not Modified "305": description: Use Proxy "307": description: Temporary Redirect "308": description: Permanent Redirect "400": description: Bad Request "401": description: Unauthorized "402": description: Payment Required "403": description: Forbidden "404": description: Not Found "405": description: Method Not Allowed "406": description: Not Acceptable "407": description: Proxy Authentication Required "408": description: Request Timeout "409": description: Conflict "410": description: Gone "411": description: Length Required "412": description: Precondition Failed "413": description: Request Entity Too Large "414": description: Request-URI Too Long "415": description: Unsupported Media Type "416": description: Requested Range Not Satisfiable "417": description: Expectation Failed "428": description: Precondition Required "429": description: Too Many Requests "431": description: Request Header Fields Too Large "451": description: Unavailable For Legal Reasons "500": description: Internal Server Error "501": description: Not Implemented "502": description: Bad Gateway "503": description: Service Unavailable "504": description: Gateway Timeout "505": description: HTTP Version Not Supported "511": description: Network Authentication Required parameters: loc: name: loc in: path description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using a\ \ underscore, e. g. ```en_US```." required: false style: matrix schema: type: string description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using\ \ a underscore, e. g. ```en_US```." default: en_US examples: en_US: description: English (United States) value: en_US fr_FR: description: French (France) value: fr_FR de_DE: description: German (Germany) value: de_DE x-matrixParamPath: / cur: name: cur in: path description: "The currency code (submitted as optional matrix parameter ```;cur=```).\ \ If omitted, the site's or user's default currency is used." required: false style: matrix schema: type: string description: "The currency code (submitted as optional matrix parameter ```;cur=```).\ \ If omitted, the site's or user's default currency is used." default: USD examples: FJD: description: Fiji Dollar value: FJD MXN: description: Mexican Peso value: MXN STD: description: São Tomé / Príncipe Dobra value: STD LVL: description: Latvian Lats value: LVL SCR: description: Seychelles Rupee value: SCR CDF: description: Congolese Franc value: CDF BBD: description: Barbados Dollar value: BBD GTQ: description: Guatemalan Quetzal value: GTQ 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 CUP: description: Cuban Peso value: CUP GMD: description: Gambian Dalasi value: GMD 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 OMR: description: Omani Rial value: OMR PGK: description: Papua New Guinean Kina value: PGK 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 THB: description: Thai Baht value: THB UZS: description: Uzbekistani Som value: UZS XPF: description: CFP Franc value: XPF 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 ISK: description: Iceland Krona value: ISK JMD: description: Jamaican Dollar value: JMD 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 SOS: description: Somali Shilling value: SOS VEF: description: Venezuelan Bolivar Fuerte value: VEF VUV: description: Vanuatu Vatu value: VUV 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 ATS: description: Austrian Schilling value: ATS CHF: description: Swiss Franc value: CHF HRK: description: Croatian Kuna value: HRK ITL: description: Italian Lira value: ITL ALL: description: Albanian Lek value: ALL DJF: description: Djibouti Franc value: DJF 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 GHS: description: Ghanaian Cedi value: GHS GYD: description: Guyanese Dollar value: GYD KPW: description: North Korean Won value: KPW BOB: description: Boliviano value: BOB KHR: description: Cambodian Riel value: KHR MDL: description: Moldovan Leu value: MDL 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 SHP: description: Saint Helena Pound value: SHP TRY: description: Turkish Lira value: TRY CYP: description: Cyprus Pound value: CYP LBP: description: Lebanese Pound value: LBP TJS: description: Tajikistani Somoni value: TJS JOD: description: Jordanian Dinar value: JOD AED: description: United Arab Emirates Dirham value: AED HKD: description: Hong Kong Dollar value: HKD 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 EEK: description: Estonian Kroon value: EEK MMK: description: Kyat value: MMK MUR: description: Mauritian Rupee value: MUR NOK: description: Norwegian Krone value: NOK SYP: description: Syrian Pound value: SYP 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 CRC: description: Costa Rican Colon value: CRC CZK: description: Czech Koruna value: CZK IEP: description: Irish Pound value: IEP PKR: description: Pakistani Rupee value: PKR GRD: description: Greek Drachma value: GRD XCD: description: East Carribean Dollar value: XCD ANG: description: Netherlands Antillian Guilder value: ANG HTG: description: Haitian Gourde value: HTG 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 SRD: description: Surinam Dollar value: SRD SZL: description: Swazi Lilangeni value: SZL LTL: description: Lithuanian Litas value: LTL SAR: description: Saudi Riyal value: SAR TTD: description: Trinidad and Tobago Dollar value: TTD 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 AWG: description: Aruban Florin value: AWG KRW: description: South Korean Won value: KRW NPR: description: Nepalese Rupee value: NPR JPY: description: Japanese Yen value: JPY MNT: description: Mongolian Tugrik value: MNT 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 BZD: description: Belize Dollar value: BZD DEM: description: Deutsche Mark value: DEM BAM: description: Convertible Marks value: BAM EGP: description: Egyptian Pound value: EGP MOP: description: Macanese Pataca value: MOP 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 NZD: description: New Zealand Dollar value: NZD WST: description: Samoan Tala value: WST TMT: description: Turkmenistani Manat value: TMT FRF: description: French Franc value: FRF BRL: description: Brazilian Real value: BRL x-matrixParamPath: / regionals: name: regionals in: path required: false style: matrix schema: type: object properties: loc: type: string description: The locale ID example: en_US cur: type: string description: The currency code example: EUR x-matrixParamPath: / pgid: name: pgid in: path description: "The personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 spgid: name: spgid in: path description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 securitySchemes: basicAuth: type: http description: "Basic access authentication. In basic authentication, a request\ \ contains a header field in the form of authorization: ```Basic ```,\ \ where credentials is the Base64 encoding of ID and password joined by a\ \ single colon :." scheme: basic authToken: type: apiKey description: User authentication token to authenticate the request. The token is a string generated by the ICM server in the same header in every response of an REST endpoint. name: authentication-token in: header bearerAuth: type: http description: "Bearer token authentication. A request contains a header field\ \ in the form of authorization: ```Bearer ```, where is a string\ \ generated by an authentication service in response to a login request." scheme: bearer bearerFormat: JWT x-apiID: customer x-origin-class: "com.intershop.component.rest.capi.resource.RootResource,com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource,com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource,com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource,com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource,com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource,com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource,com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource,com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource,com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource,com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource,com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource,com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource,com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource,com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemResource,com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource,com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource,com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource,com.intershop.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentItemResource"