This API specification is available for download as an Open API 3.0 YAML file:
The following page lists available REST APIs for ICM 7.10 and their version dependencies:
/baskets/{BasketResourceKey}/addresses
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressListResource.getAddresses_V1(java.lang.String,java.lang.Boolean,java.lang.Boolean,java.lang.Boolean,java.lang.Boolean,java.lang.Boolean)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | string |
| Related objects (as a comma separated list) which are to be included with the response. | |
in query | eligibleInvoiceToAddress | boolean | Whether invoice-to addresses should be included in the response or not. | ||
in query | eligibleShipToAddress | boolean | Whether ship-to addresses should be included in the response or not. | ||
in query | eligibleShipFromAddress | boolean | Whether ship-from addresses should be included in the response or not. | ||
in query | eligibleServiceToAddress | boolean | Whether service-to addresses should be included in the response or not. | ||
in query | eligibleInstallToAddress | boolean | Whether install-to addresses should be included in the response or not. |
200 - OK The list of addresses.
401 - Unauthorized If the user couldn't be authenticated.
If a address with initial data is passed, these data will be set at the newly created address.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressListResource.createAddress_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.address.AddressRO,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | string |
| Related objects which are to be included with the response. |
201 - Created The newly created address, if it was created successfully.
401 - Unauthorized If the user couldn't be authenticated.
422 - Unprocessable Entity A list of (semantical) error messages, if the address could not be added.
/baskets/{BasketResourceKey}/addresses/{AddressKey}
Returns the address for the given ID. If no address with this ID is found, a 404 error will be returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressItemResource.getAddress_V1(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | AddressKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | string |
| Related objects (as a comma separated list) which are to be included with the response. |
200 - OK The address with the given ID.
404 - Not Found If an address with the given ID is not found in the basket.
Deletes the address with the given ID from the basket. If no address with this ID is found, a 404 error will be returned. If for some reason the address could not be removed, a 422 error will be returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressItemResource.deleteAddress_V1()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | AddressKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK Information message describing success status.
404 - Not Found If an address with the given ID is not found in the basket.
422 - Unprocessable Entity If the address could not be deleted.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressItemResource.updateAddress_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.address.AddressRO,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | AddressKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | string |
| Related objects which are to be included with the response. |
200 - OK The updated address.
404 - Not Found If a address with the given ID is not found in the basket.
422 - Unprocessable Entity If the address could not be updated.
/baskets/{BasketResourceKey}/addresses/{AddressKey}/attributes
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.AddressAttributeListResource.getAttributes_V1(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | AddressKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | string |
| Related objects (as a comma separated list) which are to be included with the response. |
200 - OK The list of attributes.
Creates a new (custom) attribute at the basket address. The name of the attribute is used as identifier for the created sub resource. If an attribute with this name already exists or if an unknown type is passed or the value does not match the type, error 422 will be returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.AddressAttributeListResource.createAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | AddressKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | string |
| Related objects (as a comma separated list) which are to be included with the response. |
201 - Created The created attribute.
422 - Unprocessable Entity If the attribute could not be created because of semantic errors in the passed data.
/baskets/{BasketResourceKey}/addresses/{AddressKey}/attributes/{AddressAttributeKey}
Deletes the attribute from the basket address. If no attribute with this name is found, a 404 error will be returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.AddressAttributeItemResource.deleteAttribute_V1()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | AddressKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | AddressAttributeKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK Information message describing success status.
404 - Not Found If an attribute with the given name is not found in the address.
Updates the basket address attribute. Note that only the value may be changed; name and type of the attribute are immutable. An error with status code 422 will be returned in case the attribute could not be updated.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.AddressAttributeItemResource.updateAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | AddressKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | AddressAttributeKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | string |
| Related objects (as a comma separated list) which are to be included with the response. |
200 - OK The updated attribute.
422 - Unprocessable Entity If the attribute could not be updated because of semantic errors in the passed data.
/baskets/{BasketResourceKey}/eligible-addresses
Returns the list of eligible addresses that can be set as invoice-to or ship-to addresses at the selected basket. This may include addresses created at the basket or at the customer.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.address.EligibleAddressListResource.getAddresses_V1(java.lang.String,java.lang.Boolean,java.lang.Boolean,java.lang.Boolean,java.lang.Boolean,java.lang.Boolean)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | string |
| Related objects (as a comma separated list) which are to be included with the response. | |
in query | eligibleInvoiceToAddress | boolean | Whether invoice-to addresses should be included in the response or not. | ||
in query | eligibleShipToAddress | boolean | Whether ship-to addresses should be included in the response or not. | ||
in query | eligibleShipFromAddress | boolean | Whether ship-from addresses should be included in the response or not. | ||
in query | eligibleServiceToAddress | boolean | Whether service-to addresses should be included in the response or not. | ||
in query | eligibleInstallToAddress | boolean | Whether install-to addresses should be included in the response or not. |
200 - OK The list of eligible addresses.
401 - Unauthorized If the user couldn't be authenticated.
/baskets
Returns the list of active baskets for the user. A basket is active if it is in status 'OPEN'. The last modified basket is the most recent and therefore the first in the result list. If user authentication fails, a 401 error with body string 'Unauthorized' is returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.basket.BasketListResource.getBaskets_V1(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in query | include | array | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all buckets commonShipToAddress commonShippingMethod custom discounts invoiceToAddress lineItems payments |
200 - OK The list of active baskets.
401 - Unauthorized If the user couldn't be authenticated.
Creates a new basket for the user. If a basket with initial data is passed, these data will be set at the newly created basket. In case this leads to validation errors, no basket is created and error 422 together with a cause desciption is returned. If user authentication fails, a 401 error with body string 'Unauthorized' is returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.basket.BasketListResource.createBasket_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.basket.BasketRO,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in query | include | array | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all buckets commonShipToAddress commonShippingMethod custom discounts invoiceToAddress lineItems payments |
201 - Created The created basket.
401 - Unauthorized If the user couldn't be authenticated.
422 - Unprocessable Entity If the basket could not be created because of semantical errors in the initial data.
/baskets/{BasketResourceKey}
Returns the basket with the given ID for the user. If no active basket with this ID is found, a 404 error will be returned. If user authentication fails, a 401 error with body string 'Unauthorized' is returned. Error 403 is returned, if the user does not have the required access privileges. Instead of an ID "current" may be specified to retrieve the current active basket, if there is one.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.basket.BasketItemResource.getBasket_V1(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | array | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all buckets commonShipToAddress commonShippingMethod custom discounts invoiceToAddress lineItems payments |
200 - OK The basket with the given ID.
401 - Unauthorized If the user could not be authenticated.
403 - Forbidden If the user does not have the required access privileges.
404 - Not Found If no active basket is found.
Deletes the basket with the given ID. Note that the basket may not be deleted immediately, but rather later on by a scheduled job. However, after calling this method, it will no longer be accessible. If no active basket with this ID is found for the user, a 404 error will be returned. If user authentication fails, a 401 error with body string 'Unauthorized' is returned. Error 403 is returned, if the user does not have the required access privileges. Instead of an ID "current" may be specified to delete the current active basket, if there is one.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.basket.BasketItemResource.deleteBasket_V1()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK Information message describing success status.
401 - Unauthorized If the user could not be authenticated.
403 - Forbidden If the user does not have the required access privileges.
404 - Not Found If a basket with the given ID is not found in the list of user baskets.
Partially updates the basket with the given ID. If no active basket with this ID is found for the user, a 404 error will be returned. If user authentication fails, a 401 error with body string 'Unauthorized' is returned. Error 403 is returned, if the user does not have the required access privileges. Instead of an ID "current" may be specified to update the current active basket, if there is one.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.basket.BasketItemResource.updateBasket_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.basket.BasketRO,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | array | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all buckets commonShipToAddress commonShippingMethod custom discounts invoiceToAddress lineItems payments |
200 - OK The updated basket
401 - Unauthorized If the user could not be authenticated.
403 - Forbidden If the user does not have the required access privileges.
404 - Not Found If a basket with the given ID is not found in the list of user baskets.
/baskets/{BasketResourceKey}/attributes
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.BasketAttributeListResource.getAttributes_V1(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | string |
| Related objects (as a comma separated list) which are to be included with the response. |
200 - OK The list of attributes.
Creates a new (custom) attribute at the basket. The name of the attribute is used as identifier for the created sub resource. If an attribute with this name already exists or if an unknown type is passed or the value does not match the type, error 422 will be returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.BasketAttributeListResource.createAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | string |
| Related objects (as a comma separated list) which are to be included with the response. |
201 - Created The created attribute.
422 - Unprocessable Entity If the attribute could not be created because of semantic errors in the passed data.
/baskets/{BasketResourceKey}/attributes/{BasketAttributeKey}
Deletes the attribute from the basket. If no attribute with this name is found, a 404 error will be returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.BasketAttributeItemResource.deleteAttribute_V1()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | BasketAttributeKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK Information message describing success status.
404 - Not Found If an attribute with the given name is not found in the basket.
Updates the basket attribute. Note that only the value may be changed; name and type of the attribute are immutable. An error with status code 422 will be returned in case the attribute could not be updated.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.BasketAttributeItemResource.updateAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | BasketAttributeKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | string |
| Related objects (as a comma separated list) which are to be included with the response. |
200 - OK The updated attribute.
422 - Unprocessable Entity If the attribute could not be updated because of semantic errors in the passed data.
/baskets/{BasketResourceKey}/merges
Merge the basket (target basket) with an other basket (source basket). In that case, the source basket owner is not registered and the corresponding authentication token is not part of the payload, the source basket will be anonymized. Merge objects are the line items, recurrence information, and the affiliate informations. If the corresponding authentication token is part of the payload, the source basket will not be anonymized. In that case, the source basket owner is registered and is equals to the target basket owner, line items, addresses, recurrence information, promotion codes and affiliate informations will be merged. Generally not included in scope are the payments of the source basket. The source basket will removed after merge unless the payload of the request contains information to suppress this behavior.If no active basket with this ID is found for the user, a 404 error will be returned. If during the processing of the request a failure occurred, a 422 error with specific error cause is returned. Possible error keys are "basket.not_found.error", "basket.merge.invalid_token.error", "basket.merge.token_is_expired.error","basket.merge.source_basket_user_is_registered.error".Instead of an ID "current" may be specified to update the current active basket, if there is one.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.merge.BasketMergeListResource.mergeBasket_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.merge.BasketMergeRO,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | array | Related objects which are to be included with the response. | Possible Values: all targetBasket |
201 - Created The merge data
401 - Unauthorized If the user could not be authenticated.
404 - Not Found If a basket with the given ID is not found in the list of user baskets.
422 - Unprocessable Entity If during the processing of the request a failure occurred, a 422 error with specific error cause is returned.
/baskets/{BasketResourceKey}/validations
Triggers a validation of the basket and returns the validation errors. Optionally, the basket is adjusted automatically (e. g. to remove unavailable line items).
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.validation.BasketValidationListResource.validateBasket_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.validation.BasketValidationRO,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | array | Related objects which are to be included with the response. | Possible Values: all basket |
201 - Created Returns the result of the validation.
401 - Unauthorized Returns an error, if the user couldn't be authenticated.
422 - Unprocessable Entity Returns a list of (semantical) error messages, if the validation could not be executed.
/baskets/{BasketResourceKey}/items
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemListResource.getLineItems_V1(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | array | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all discounts product shipToAddress shippingMethod warranty |
200 - OK - The list of line items.
401 - Unauthorized - The user could not be authenticated.
Adds one or more products to the basket. This creates new line items in the basket or, if a product already exists in the basket and merging is configured, increases the quantity of an existing line item. Note that this request may succeed partially, i. e. if three products are to be added and one fails because of semantical errors, the other two will still be added to the basket.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemListResource.createLineItems_V1(java.util.List,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | array | Related objects which are to be included with the response | Possible Values: all discounts product shipToAddress shippingMethod warranty |
200 - OK - The line items were successfully merged.
201 - Created - All line items were created successfully.
207 - Multi-Status Some items could not be added.This response will be returned if there are different response codes for individual items.
401 - Unauthorized - The user could not be authenticated.
422 - Unprocessable Entity - No product could be added.
Deletes all line items from a basket with a given basket ID.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemListResource.deleteLineItems_V1()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK - The basket line items were deleted.
404 - Not Found - A basket with the given ID could not be found.
422 - Unprocessable Entity - The line item(s) could not be deleted.
/baskets/{BasketResourceKey}/items/{BasketLineKey}
Returns the line item for the given ID. If no line item with this ID is found, a 404 error will be returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemItemResource.getLineItem_V1(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | BasketLineKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | array | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all discounts product shipToAddress shippingMethod warranty |
200 - OK Information message describing success status.
404 - Not Found If a line item with the given ID is not found in the basket.
Deletes the line item with the given ID from the basket. If no line item with this ID is found, a 404 error will be returned. If for some reason the line item could not be removed, a 422 error will be returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemItemResource.deleteLineItem_V1()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | BasketLineKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK Information message describing success status.
404 - Not Found If a line item with the given ID is not found in the basket.
422 - Unprocessable Entity If the line item could not be deleted.
Partially updates the lineitem with the given ID. If no line item with this ID is found, a 404 error will be returned. If for some reason the line item could not be updated, a 422 error will be returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemItemResource.updateLineItem_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.lineitem.LineItemRO,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | BasketLineKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | array | Related objects which are to be included with the response. | Possible Values: all discounts product shipToAddress shippingMethod warranty |
200 - OK Information message describing success status.
404 - Not Found If a line item with the given ID is not found in the basket.
422 - Unprocessable Entity If the line item could not be updated.
/baskets/{BasketResourceKey}/items/{BasketLineKey}/attributes
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.LineItemAttributeListResource.getAttributes_V1(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | BasketLineKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | string |
| Related objects (as a comma separated list) which are to be included with the response. |
200 - OK The list of attributes.
Creates a new (custom) attribute at the line item. The name of the attribute is used as identifier for the created sub resource. If an attribute with this name already exists or if an unknown type is passed or the value does not match the type, error 422 will be returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.LineItemAttributeListResource.createAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | BasketLineKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | string |
| Related objects (as a comma separated list) which are to be included with the response. |
201 - Created The created attribute.
422 - Unprocessable Entity If the attribute could not be created because of semantic errors in the passed data.
/baskets/{BasketResourceKey}/items/{BasketLineKey}/attributes/{LineItemAttributeKey}
Deletes the attribute from the line item. If no attribute with this name is found, a 404 error will be returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.LineItemAttributeItemResource.deleteAttribute_V1()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | BasketLineKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | LineItemAttributeKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK Information message describing success status.
404 - Not Found If an attribute with the given name is not found in the line item.
Updates the line item attribute. Note that only the value may be changed; name and type of the attribute are immutable. An error with status code 422 will be returned in case the attribute could not be updated.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.LineItemAttributeItemResource.updateAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | BasketLineKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | LineItemAttributeKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | string |
| Related objects (as a comma separated list) which are to be included with the response. |
200 - OK The updated attribute.
422 - Unprocessable Entity If the attribute could not be updated because of semantic errors in the passed data.
/baskets/{BasketResourceKey}/eligible-payment-methods
Returns the list of payment methods that are eligible for the selected basket. If there are no eligible payment methods available, an empty list will be returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource.getEligiblePaymentMethods_V1(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | array | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all paymentInstruments |
200 - OK The list of eligible payment methods.
401 - Unauthorized If the user couldn't be authenticated.
/baskets/{BasketResourceKey}/payment-instruments
Adds a payment instrument to the basket. This creates new payment instrument in the basket.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentInstrumentListResource.createPaymentInstrument_V1(com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentInstrumentRO,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | array | Related objects which are to be included with the response. | Possible Values: all paymentMethod |
201 - Created The newly created payment instrument with the data provided.
401 - Unauthorized If the user couldn't be authenticated.
422 - Unprocessable Entity A list of (semantical) error messages, if the payment instrument could not be created.
/baskets/{BasketResourceKey}/payment-instruments/{PaymentInstrumentKey}
This operation deletes the payment instrument with the given ID. If no payment instrument with this ID is found, a 404 error will be returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentInstrumentItemResource.deletePaymentInstrument_V1()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | PaymentInstrumentKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK Information message describing success status.
404 - Not Found A payment instrument with the given ID was not found.
This operation updates the payment instrument with the given ID partially. If no payment instrument with this ID is found, a 404 error will be returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentInstrumentItemResource.updatePaymentInstrument_V1(com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentInstrumentRO,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | PaymentInstrumentKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | array | Related objects which are to be retrieved with the response. | Possible Values: all paymentMethod |
200 - OK Information message describing success status.
404 - Not Found A payment instrument with the given ID was not found.
/baskets/{BasketResourceKey}/payments
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentListResource.getPayments_V1(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | array | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all paymentInstrument paymentMethod |
200 - OK The list of payments.
401 - Unauthorized If the user couldn't be authenticated.
Creates a new payment in the given basket using the payment instrument from the request payload. This can be used to create payments for limited tender payment instruments (e. g. gift cards) as well as for open tender payment instruments (e. g. credit cards). However, the request will still fail with an "422 Unprocessable Entity" error when trying to create an open tender payment when there already is an open tender payment in the basket. If an open tender payment is to be replaced, use the "PUT" method on the item resource with ID "open-tender". An open tender payment can also not be created if the basket is already fully covered by limited tender payments. If a limited tender payment is to be created and an open tender payment is already present, then the latter may be removed if the limited tender fully covers the basket; in that case no further limited tender payments can be created afterwards. In general, limited tender payments always have a higher priority than open tenders. If the payment could not be created for other reasons, a "422 Unprocessable Entity" error with a specific error message will also be returned. In case that the applied payment instrument supports redirect, it is possible to append success, cancel and failure redirect URL. Otherwise it is ignored.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentListResource.createPayment_V1(com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentRO,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | array | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all paymentInstrument paymentMethod |
201 - Created Information message describing success status.
422 - Unprocessable Entity If the payment could not be created.
/baskets/{BasketResourceKey}/payments/{BasketPaymentKey}
Creates (or replaces) the payment with the given ID. If the payment could not be created, a 422 error will be returned. Note that this will only work for open tender payments, i. e. where the ID is 'open-tender'. Other payments are not supported via this method and a 405 error will be returned for those. An open tender payment can only be created, if the basket is not already fully covered by limited tenders. For creating a new limited tender payment, use the POST method on the list resource. Updating or replacing an existing limited tender payment is never supported, it needs to be deleted and re-created.In case that the applied payment instrument supports redirect, it is possible to append success, cancel and failure redirect URL. Otherwise it is ignored.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentItemResource.replacePayment_V1(com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentRO,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | BasketPaymentKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | array | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all paymentInstrument paymentMethod |
201 - Created Information message describing success status.
422 - Unprocessable Entity If the payment could not be created.
Deletes the payment with the given ID. If no payment with this ID is found, a 404 error will be returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentItemResource.deletePayment_V1()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | BasketPaymentKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK Information message describing success status.
404 - Not Found If a payment with the given ID is not found.
Updates the payment. If the payment could not be updated, a 422 error will be returned. Note that this will only allow to set/update redirect data, e.g. the return URLS'. Other changes are not supported and will be ignored.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentItemResource.updatePayment_V1(com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentRO,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | BasketPaymentKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | array | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all paymentInstrument paymentMethod |
200 - OK Information message describing success status.
422 - Unprocessable Entity If the payment could not be updated.
/baskets/{BasketResourceKey}/promotioncodes
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.promotion.BasketPromotionCodeListResource.getPromotionCodes_V1()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK The list of promotion codes.
401 - Unauthorized If the user couldn't be authenticated.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.promotion.BasketPromotionCodeListResource.addPromotionCode_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.promotion.PromotionCodeRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
201 - Created The newly added promotion code, if it was added successfully.
401 - Unauthorized If the user couldn't be authenticated.
422 - Unprocessable Entity A list of (semantical) error messages, if the promotion code could not be added.
/baskets/{BasketResourceKey}/promotioncodes/{BasketPromotionCodeKey}
Returns the promotion code data for the given promotion code string. If no promotion code with this string is found, a 404 error will be returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.promotion.BasketPromotionCodeItemResource.getPromotionCode_V1()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | BasketPromotionCodeKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK The promotion code data for the given promotion code string.
404 - Not Found If a promotion code with the given string is not found in the basket.
Removes the promotion code with the given string from the basket. If no address with this string is found, a 404 error will be returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.promotion.BasketPromotionCodeItemResource.removePromotionCode_V1()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | BasketPromotionCodeKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
204 - No Content Information message describing success status.
404 - Not Found If an promotion code with the given ID is not found in the basket.
/baskets/{BasketResourceKey}/buckets
Returns the list of shipping buckets for the selected basket. Note that buckets are built dynamically and are not persisted. Bucket assignments and IDs could change if items are moved to a different bucket (by changing ship-to address or shipping method of a line item). It is therefore recommended to always retrieve the list of buckets before performing any operation on a single bucket.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.shipping.ShippingBucketListResource.getShippingBuckets_V1(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | array | Related objects which are to be included with the response. | Possible Values: all discounts shipToAddress shippingMethod |
200 - OK The list of shipping buckets.
401 - Unauthorized If the user couldn't be authenticated.
/baskets/{BasketResourceKey}/buckets/{ShippingBucketKey}
Returns the shipping bucket with the given ID. If no shipping bucket with this ID is found, a 404 error will be returned. Note that this could also mean that items have been added or removed from the bucket, as buckets are not persisted and IDs are determined dynamically through a hash over all items in the bucket. If such changes occur, the shipping bucket list needs to be retrieved again before working on single buckets.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.shipping.ShippingBucketItemResource.getShippingBucket_V1(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | ShippingBucketKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | array | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all discounts shipToAddress shippingMethod |
200 - OK The shipping bucket.
401 - Unauthorized If the user couldn't be authenticated.
404 - Not Found If a shipping bucket with the given ID is not found in the basket.
Updates the shipping bucket with the given ID. If no shipping bucket with this ID is found, a 404 error will be returned. If for some reason the shipping bucket could not be updated, a 422 error will be returned. Note that manipulating the shipping bucket may cause a change in the shipping bucket ID, as IDs are determined dynamically through a hash over all items in the bucket. This means a bucket with a different ID may be returned in the response (e. g. when multiple shipping buckets are merged by changing the ship-to address or shipping method). When this happens, the whole shipping bucket list should be retrieved again before displaying it the next time (as other buckets may havebeen changed or removed as well).
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.shipping.ShippingBucketItemResource.updateShippingBucket_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.shipping.ShippingBucketRO,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | ShippingBucketKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | array | Related objects which are to be included with the response. | Possible Values: all discounts shipToAddress shippingMethod |
200 - OK Information message describing success status.
404 - Not Found If a shipping bucket with the given ID is not found in the basket.
422 - Unprocessable Entity If the shipping bucket could not be updated.
/baskets/{BasketResourceKey}/buckets/{ShippingBucketKey}/eligible-shipping-methods
Returns the list of shipping methods that are eligible for the selected shipping bucket. This will only return common shipping methods that are valid for all line items in the shipping bucket.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.shipping.ShippingBucketEligibleShippingMethodListResource.getEligibleShippingMethods_V1(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | ShippingBucketKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | string |
| Related objects (as a comma separated list) which are to be included with the response. |
200 - OK The list of eligible shipping methods.
401 - Unauthorized If the user couldn't be authenticated.
/baskets/{BasketResourceKey}/eligible-shipping-methods
Returns the list of shipping methods that are eligible for the selected basket. This will only return common shipping methods that are valid for all line items. If there are no common shipping methods, an empty list will be returned.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.shipping.BasketEligibleShippingMethodListResource.getEligibleShippingMethods_V1(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | string |
| Related objects (as a comma separated list) which are to be included with the response. |
200 - OK The list of eligible shipping methods.
401 - Unauthorized If the user couldn't be authenticated.
/baskets/{BasketResourceKey}/items/{BasketLineKey}/eligible-shipping-methods
Returns the list of shipping methods that are eligible for the selected line item.
public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.shipping.LineItemEligibleShippingMethodListResource.getEligibleShippingMethods_V1(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | BasketResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | BasketLineKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | include | string |
| Related objects (as a comma separated list) which are to be included with the response. |
200 - OK The list of eligible shipping methods.
401 - Unauthorized If the user couldn't be authenticated.
AddressRO_v1
object. The addressBerliner Str. 20
AttributeRO_v1
objects.BooleanAttributeRO_v1
: A representation of a boolean attribute.DateAttributeRO_v1
: A representation of a date/time attribute.DecimalAttributeRO_v1
: A representation of a decimal attribute.DoubleAttributeRO_v1
: A representation of a double attribute.IntegerAttributeRO_v1
: A representation of an integer attribute.LongAttributeRO_v1
: A representation of a long attribute.MoneyAttributeRO_v1
: A representation of a money attribute.QuantityAttributeRO_v1
: A representation of a quantity attribute.StringAttributeRO_v1
: A representation of a string attribute.TextAttributeRO_v1
: A representation of a text attribute.MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.Potsdam
Intershop Communications AG
Germany
DE
false
true
false
false
true
patricia@test.intershop.de
000123456
urn:address:MSDynamics365:MyCorp:000123456
Patricia
0987654321
Miller
Alabama
Al
049364112677
14482
City of Westminster
020
Ms.
urn:address:customer:1234567890:0987654321
FeedbackRO_v1
objects. List of errors that occurred in relation to the request.FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
AddressRO_v1
objects. The core data of the response object.AddressRO_v1
: The addressBerliner Str. 20
AttributeRO_v1
objects.BooleanAttributeRO_v1
: A representation of a boolean attribute.DateAttributeRO_v1
: A representation of a date/time attribute.DecimalAttributeRO_v1
: A representation of a decimal attribute.DoubleAttributeRO_v1
: A representation of a double attribute.IntegerAttributeRO_v1
: A representation of an integer attribute.LongAttributeRO_v1
: A representation of a long attribute.MoneyAttributeRO_v1
: A representation of a money attribute.QuantityAttributeRO_v1
: A representation of a quantity attribute.StringAttributeRO_v1
: A representation of a string attribute.TextAttributeRO_v1
: A representation of a text attribute.MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.Potsdam
Intershop Communications AG
Germany
DE
false
true
false
false
true
patricia@test.intershop.de
000123456
urn:address:MSDynamics365:MyCorp:000123456
Patricia
0987654321
Miller
Alabama
Al
049364112677
14482
City of Westminster
020
Ms.
urn:address:customer:1234567890:0987654321
FeedbackRO_v1
objects. List of errors that occurred in relation to the request.FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
Berliner Str. 20
AttributeRO_v1
objects.BooleanAttributeRO_v1
: A representation of a boolean attribute.DateAttributeRO_v1
: A representation of a date/time attribute.DecimalAttributeRO_v1
: A representation of a decimal attribute.DoubleAttributeRO_v1
: A representation of a double attribute.IntegerAttributeRO_v1
: A representation of an integer attribute.LongAttributeRO_v1
: A representation of a long attribute.MoneyAttributeRO_v1
: A representation of a money attribute.QuantityAttributeRO_v1
: A representation of a quantity attribute.StringAttributeRO_v1
: A representation of a string attribute.TextAttributeRO_v1
: A representation of a text attribute.MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.Potsdam
Intershop Communications AG
Germany
DE
false
true
false
false
true
patricia@test.intershop.de
000123456
urn:address:MSDynamics365:MyCorp:000123456
Patricia
0987654321
Miller
Alabama
Al
049364112677
14482
City of Westminster
020
Ms.
urn:address:customer:1234567890:0987654321
AttributeRO_v1Object
object. A representation of an attribute.Boolean
Date
Decimal
Double
Integer
Long
Money
Quantity
String
Text
MultipleBoolean
MultipleDate
MultipleDecimal
MultipleDouble
MultipleInteger
MultipleLong
MultipleString
FeedbackRO_v1
objects. List of errors that occurred in relation to the request.FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
AttributeRO_v1Object
objects. The core data of the response object.BooleanAttributeRO_v1
: A representation of a boolean attribute.DateAttributeRO_v1
: A representation of a date/time attribute.DecimalAttributeRO_v1
: A representation of a decimal attribute.DoubleAttributeRO_v1
: A representation of a double attribute.IntegerAttributeRO_v1
: A representation of an integer attribute.LongAttributeRO_v1
: A representation of a long attribute.MoneyAttributeRO_v1
: A representation of a money attribute.QuantityAttributeRO_v1
: A representation of a quantity attribute.StringAttributeRO_v1
: A representation of a string attribute.TextAttributeRO_v1
: A representation of a text attribute.MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.FeedbackRO_v1
objects. List of errors that occurred in relation to the request.FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
Boolean
Date
Decimal
Double
Integer
Long
Money
Quantity
String
Text
MultipleBoolean
MultipleDate
MultipleDecimal
MultipleDouble
MultipleInteger
MultipleLong
MultipleString
BasketLineItemRO_v1
object. Describes a line item that has been added to a basket.AttributeRO_v1
objects.BooleanAttributeRO_v1
: A representation of a boolean attribute.DateAttributeRO_v1
: A representation of a date/time attribute.DecimalAttributeRO_v1
: A representation of a decimal attribute.DoubleAttributeRO_v1
: A representation of a double attribute.IntegerAttributeRO_v1
: A representation of an integer attribute.LongAttributeRO_v1
: A representation of a long attribute.MoneyAttributeRO_v1
: A representation of a money attribute.QuantityAttributeRO_v1
: A representation of a quantity attribute.StringAttributeRO_v1
: A representation of a string attribute.TextAttributeRO_v1
: A representation of a text attribute.MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.yUQKAEsBeeoAAAFl9vhJwIZc
date
| Example: 2001-07-04T00:00:00.000Z
string
literals. The IDs of the discounts applied to the item pricing.false
false
int32
BasketLineItemPricingRO_v1
object. total price values of a line item that has been added to a basketPriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
5079747
QuantityRO_v1
object. A quantity of a business entity.kg
10
true
Qu0T3MgoyuMAx9Es2sx0Ue1
urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
STD_5DAY
BasketSurchargeRO_v1
objects. Details about additional surcharges applied to the item.BasketSurchargeRO_v1
: Describes a single surcharge incurred to a shipping bucket.PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
Fridge Box
Needs a fridge box for shipping.
TaxItemRO_v1
objects. The taxes applied to the surcharge.TaxItemRO_v1
: Represents a single tax item.MoneyRO_v1
object. Describes a money object.USD
10.99
JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.CANADA
COUNTRY
| Possible Values: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_DISTRICT
MoneyRO_v1
object. Describes a money object.USD
10.99
DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
MoneyRO_v1
object. Describes a money object.USD
10.99
/INTERSHOP/static/WFS/inSPIRED-inTRONICS-Site/-/inSPIRED/en_US/M/3957288-5427.jpg
FeedbackRO_v1
objects. List of errors that occurred in relation to the request.FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
BasketLineItemRO_v1
objects. The core data of the response object.BasketLineItemRO_v1
: Describes a line item that has been added to a basket.AttributeRO_v1
objects.BooleanAttributeRO_v1
: A representation of a boolean attribute.DateAttributeRO_v1
: A representation of a date/time attribute.DecimalAttributeRO_v1
: A representation of a decimal attribute.DoubleAttributeRO_v1
: A representation of a double attribute.IntegerAttributeRO_v1
: A representation of an integer attribute.LongAttributeRO_v1
: A representation of a long attribute.MoneyAttributeRO_v1
: A representation of a money attribute.QuantityAttributeRO_v1
: A representation of a quantity attribute.StringAttributeRO_v1
: A representation of a string attribute.TextAttributeRO_v1
: A representation of a text attribute.MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.yUQKAEsBeeoAAAFl9vhJwIZc
date
| Example: 2001-07-04T00:00:00.000Z
string
literals. The IDs of the discounts applied to the item pricing.false
false
int32
BasketLineItemPricingRO_v1
object. total price values of a line item that has been added to a basketPriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
5079747
QuantityRO_v1
object. A quantity of a business entity.kg
10
true
Qu0T3MgoyuMAx9Es2sx0Ue1
urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
STD_5DAY
BasketSurchargeRO_v1
objects. Details about additional surcharges applied to the item.BasketSurchargeRO_v1
: Describes a single surcharge incurred to a shipping bucket.PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
Fridge Box
Needs a fridge box for shipping.
TaxItemRO_v1
objects. The taxes applied to the surcharge.TaxItemRO_v1
: Represents a single tax item.MoneyRO_v1
object. Describes a money object.USD
10.99
JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.CANADA
COUNTRY
| Possible Values: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_DISTRICT
MoneyRO_v1
object. Describes a money object.USD
10.99
DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
MoneyRO_v1
object. Describes a money object.USD
10.99
/INTERSHOP/static/WFS/inSPIRED-inTRONICS-Site/-/inSPIRED/en_US/M/3957288-5427.jpg
FeedbackRO_v1
objects. List of errors that occurred in relation to the request.FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
BasketLineItemRO_v1
: Describes a line item that has been added to a basket.AttributeRO_v1
objects.BooleanAttributeRO_v1
: A representation of a boolean attribute.DateAttributeRO_v1
: A representation of a date/time attribute.DecimalAttributeRO_v1
: A representation of a decimal attribute.DoubleAttributeRO_v1
: A representation of a double attribute.IntegerAttributeRO_v1
: A representation of an integer attribute.LongAttributeRO_v1
: A representation of a long attribute.MoneyAttributeRO_v1
: A representation of a money attribute.QuantityAttributeRO_v1
: A representation of a quantity attribute.StringAttributeRO_v1
: A representation of a string attribute.TextAttributeRO_v1
: A representation of a text attribute.MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.yUQKAEsBeeoAAAFl9vhJwIZc
date
| Example: 2001-07-04T00:00:00.000Z
string
literals. The IDs of the discounts applied to the item pricing.false
false
int32
BasketLineItemPricingRO_v1
object. total price values of a line item that has been added to a basketPriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
5079747
QuantityRO_v1
object. A quantity of a business entity.kg
10
true
Qu0T3MgoyuMAx9Es2sx0Ue1
urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
STD_5DAY
BasketSurchargeRO_v1
objects. Details about additional surcharges applied to the item.BasketSurchargeRO_v1
: Describes a single surcharge incurred to a shipping bucket.PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
Fridge Box
Needs a fridge box for shipping.
TaxItemRO_v1
objects. The taxes applied to the surcharge.TaxItemRO_v1
: Represents a single tax item.MoneyRO_v1
object. Describes a money object.USD
10.99
JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.CANADA
COUNTRY
| Possible Values: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_DISTRICT
MoneyRO_v1
object. Describes a money object.USD
10.99
DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
MoneyRO_v1
object. Describes a money object.USD
10.99
/INTERSHOP/static/WFS/inSPIRED-inTRONICS-Site/-/inSPIRED/en_US/M/3957288-5427.jpg
BasketRO_v1
objects. The core data of the response object.BasketRO_v1
: A representation of a basket4bcKAB2Ykg4AAAFbjvEYRPJ7
uzMKAB2YvKAAAAFb7DUYRPJ8
ApprovalRO_v1
object. A representation of a basket approvaltrue
ApprovalCostCenterRO_v1
object. A representation of a cost center approvalApprovalUserRO_v1
objects. The cost center approvers.ApprovalUserRO_v1
: Represents an approval user item.Merkel@test.intershop.de
Peter
Merkel
Mr.
ApprovalCustomerRO_v1
object. A representation of a customer approvalApprovalUserRO_v1
objects. The customer approvers.ApprovalUserRO_v1
: Represents an approval user item.Merkel@test.intershop.de
Peter
Merkel
Mr.
AttributeRO_v1
objects.BooleanAttributeRO_v1
: A representation of a boolean attribute.DateAttributeRO_v1
: A representation of a date/time attribute.DecimalAttributeRO_v1
: A representation of a decimal attribute.DoubleAttributeRO_v1
: A representation of a double attribute.IntegerAttributeRO_v1
: A representation of an integer attribute.LongAttributeRO_v1
: A representation of a long attribute.MoneyAttributeRO_v1
: A representation of a money attribute.QuantityAttributeRO_v1
: A representation of a quantity attribute.StringAttributeRO_v1
: A representation of a string attribute.TextAttributeRO_v1
: A representation of a text attribute.MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.string
literals. The bucket ids of all shipping buckets of a basket.urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
STD_5DAY
511288
SALES
BasketDiscountsRO_v1
object. Provides details about the applied discounts.string
literals. The dynamic messages for a basket.string
literals. The IDs of all free gift discounts granted on the basket.string
literals. The IDs of all discounts granted on shipping and handling costs.string
literals. The IDs of all discounts granted on the basket total.30000008899
q2QKAEsBiyQAAAFjXFBB6G14
urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
string
literals. The ids of all line items of a basket.Is it possible to send the ordered articles before Christmas?
string
literals. The payments used to pay the basket.string
literals. The promotion codes of the basket.USD
BasketRecurrenceRO_v1
object. Recurrence data which are associated with a basket.date-time
| Example: 2020-05-23T11:23:45.000Z
false
P6Y11M27D
int32
int32
int32
object
literals.int64
int32
int32
| Example: 24
date-time
| Example: 2020-05-23T11:23:45.000Z
BasketSurchargesRO_v1
object. Surcharges that are applied to a basket.BasketSurchargeRO_v1
objects. All bucket based extra charges arising from surcharges with action type 'bucket'.BasketSurchargeRO_v1
: Describes a single surcharge incurred to a shipping bucket.PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
Fridge Box
Needs a fridge box for shipping.
TaxItemRO_v1
objects. The taxes applied to the surcharge.TaxItemRO_v1
: Represents a single tax item.MoneyRO_v1
object. Describes a money object.USD
10.99
JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.CANADA
COUNTRY
| Possible Values: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_DISTRICT
MoneyRO_v1
object. Describes a money object.USD
10.99
DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
MoneyRO_v1
object. Describes a money object.USD
10.99
BasketSurchargeRO_v1
objects. All item based extra charges arising from surcharges directly specified on product or by shipping rules with action type 'item'.BasketSurchargeRO_v1
: Describes a single surcharge incurred to a shipping bucket.PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
Fridge Box
Needs a fridge box for shipping.
TaxItemRO_v1
objects. The taxes applied to the surcharge.TaxItemRO_v1
: Represents a single tax item.MoneyRO_v1
object. Describes a money object.USD
10.99
JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.CANADA
COUNTRY
| Possible Values: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_DISTRICT
MoneyRO_v1
object. Describes a money object.USD
10.99
DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
MoneyRO_v1
object. Describes a money object.USD
10.99
11111111
23
BasketTotalsRO_v1
object. Total price values for a basket.PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
TaxItemRO_v1
objects. All sales taxes applied to the basket, accumulated by their tax rates.TaxItemRO_v1
: Represents a single tax item.MoneyRO_v1
object. Describes a money object.USD
10.99
JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.CANADA
COUNTRY
| Possible Values: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_DISTRICT
MoneyRO_v1
object. Describes a money object.USD
10.99
DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
TaxItemRO_v1
objects. All shipping taxes applied to the basket, accumulated by their tax rates.TaxItemRO_v1
: Represents a single tax item.MoneyRO_v1
object. Describes a money object.USD
10.99
JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.CANADA
COUNTRY
| Possible Values: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_DISTRICT
MoneyRO_v1
object. Describes a money object.USD
10.99
DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
TaxItemRO_v1
objects. All taxes applied to the basket, accumulated by their tax rates (includes taxes levied to sales, prices, shipping and surcharges.TaxItemRO_v1
: Represents a single tax item.MoneyRO_v1
object. Describes a money object.USD
10.99
JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.CANADA
COUNTRY
| Possible Values: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_DISTRICT
MoneyRO_v1
object. Describes a money object.USD
10.99
DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
FeedbackRO_v1
objects. List of errors that occurred in relation to the request.FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
JSTTWVJNSIIUW
4bcKAB2Ykg4AAAFbjvEYRPJ7
uzMKAB2YvKAAAAFb7DUYRPJ8
ApprovalRO_v1
object. A representation of a basket approvaltrue
ApprovalCostCenterRO_v1
object. A representation of a cost center approvalApprovalUserRO_v1
objects. The cost center approvers.ApprovalUserRO_v1
: Represents an approval user item.Merkel@test.intershop.de
Peter
Merkel
Mr.
ApprovalCustomerRO_v1
object. A representation of a customer approvalApprovalUserRO_v1
objects. The customer approvers.ApprovalUserRO_v1
: Represents an approval user item.Merkel@test.intershop.de
Peter
Merkel
Mr.
AttributeRO_v1
objects.BooleanAttributeRO_v1
: A representation of a boolean attribute.DateAttributeRO_v1
: A representation of a date/time attribute.DecimalAttributeRO_v1
: A representation of a decimal attribute.DoubleAttributeRO_v1
: A representation of a double attribute.IntegerAttributeRO_v1
: A representation of an integer attribute.LongAttributeRO_v1
: A representation of a long attribute.MoneyAttributeRO_v1
: A representation of a money attribute.QuantityAttributeRO_v1
: A representation of a quantity attribute.StringAttributeRO_v1
: A representation of a string attribute.TextAttributeRO_v1
: A representation of a text attribute.MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.string
literals. The bucket ids of all shipping buckets of a basket.urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
STD_5DAY
511288
SALES
BasketDiscountsRO_v1
object. Provides details about the applied discounts.string
literals. The dynamic messages for a basket.string
literals. The IDs of all free gift discounts granted on the basket.string
literals. The IDs of all discounts granted on shipping and handling costs.string
literals. The IDs of all discounts granted on the basket total.30000008899
q2QKAEsBiyQAAAFjXFBB6G14
urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
string
literals. The ids of all line items of a basket.Is it possible to send the ordered articles before Christmas?
string
literals. The payments used to pay the basket.string
literals. The promotion codes of the basket.USD
BasketRecurrenceRO_v1
object. Recurrence data which are associated with a basket.date-time
| Example: 2020-05-23T11:23:45.000Z
false
P6Y11M27D
int32
int32
int32
object
literals.int64
int32
int32
| Example: 24
date-time
| Example: 2020-05-23T11:23:45.000Z
BasketSurchargesRO_v1
object. Surcharges that are applied to a basket.BasketSurchargeRO_v1
objects. All bucket based extra charges arising from surcharges with action type 'bucket'.BasketSurchargeRO_v1
: Describes a single surcharge incurred to a shipping bucket.PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
Fridge Box
Needs a fridge box for shipping.
TaxItemRO_v1
objects. The taxes applied to the surcharge.TaxItemRO_v1
: Represents a single tax item.MoneyRO_v1
object. Describes a money object.USD
10.99
JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.CANADA
COUNTRY
| Possible Values: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_DISTRICT
MoneyRO_v1
object. Describes a money object.USD
10.99
DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
MoneyRO_v1
object. Describes a money object.USD
10.99
BasketSurchargeRO_v1
objects. All item based extra charges arising from surcharges directly specified on product or by shipping rules with action type 'item'.BasketSurchargeRO_v1
: Describes a single surcharge incurred to a shipping bucket.PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
Fridge Box
Needs a fridge box for shipping.
TaxItemRO_v1
objects. The taxes applied to the surcharge.TaxItemRO_v1
: Represents a single tax item.MoneyRO_v1
object. Describes a money object.USD
10.99
JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.CANADA
COUNTRY
| Possible Values: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_DISTRICT
MoneyRO_v1
object. Describes a money object.USD
10.99
DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
MoneyRO_v1
object. Describes a money object.USD
10.99
11111111
23
BasketTotalsRO_v1
object. Total price values for a basket.PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
TaxItemRO_v1
objects. All sales taxes applied to the basket, accumulated by their tax rates.TaxItemRO_v1
: Represents a single tax item.MoneyRO_v1
object. Describes a money object.USD
10.99
JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.CANADA
COUNTRY
| Possible Values: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_DISTRICT
MoneyRO_v1
object. Describes a money object.USD
10.99
DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.MoneyRO_v1
object. Describes a money object.MoneyRO_v1
object. Describes a money object.TaxItemRO_v1
objects. All shipping taxes applied to the basket, accumulated by their tax rates.PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.TaxItemRO_v1
objects. All taxes applied to the basket, accumulated by their tax rates (includes taxes levied to sales, prices, shipping and surcharges.PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.BasketShippingBucketRO_v1
object. Describes a shipping bucket.yUQKAEsBeeoAAAFl9vhJwIZc
P7D
int32
int32
int32
object
literals.int64
int32
P3D
int32
int32
int32
object
literals.int64
int32
string
literals. The IDs of the discounts applied to the bucket totals.54489489212
string
literals. The ids of all line items which are associated with this bucket.urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
STD_5DAY
BasketSurchargeRO_v1
objects. All extra charges arising from surcharges directly specified on product or by shipping rules with action type 'bucket'.BasketSurchargeRO_v1
: Describes a single surcharge incurred to a shipping bucket.PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
Fridge Box
Needs a fridge box for shipping.
TaxItemRO_v1
objects. The taxes applied to the surcharge.TaxItemRO_v1
: Represents a single tax item.MoneyRO_v1
object. Describes a money object.USD
10.99
JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.CANADA
COUNTRY
| Possible Values: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_DISTRICT
MoneyRO_v1
object. Describes a money object.USD
10.99
DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
MoneyRO_v1
object. Describes a money object.USD
10.99
FeedbackRO_v1
objects. List of errors that occurred in relation to the request.FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
BasketShippingBucketRO_v1
objects. The core data of the response object.BasketShippingBucketRO_v1
: Describes a shipping bucket.yUQKAEsBeeoAAAFl9vhJwIZc
P7D
int32
int32
int32
object
literals.int64
int32
P3D
int32
int32
int32
object
literals.int64
int32
string
literals. The IDs of the discounts applied to the bucket totals.54489489212
string
literals. The ids of all line items which are associated with this bucket.urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
STD_5DAY
BasketSurchargeRO_v1
objects. All extra charges arising from surcharges directly specified on product or by shipping rules with action type 'bucket'.BasketSurchargeRO_v1
: Describes a single surcharge incurred to a shipping bucket.PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
Fridge Box
Needs a fridge box for shipping.
TaxItemRO_v1
objects. The taxes applied to the surcharge.TaxItemRO_v1
: Represents a single tax item.MoneyRO_v1
object. Describes a money object.USD
10.99
JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.CANADA
COUNTRY
| Possible Values: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_DISTRICT
MoneyRO_v1
object. Describes a money object.USD
10.99
DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
MoneyRO_v1
object. Describes a money object.USD
10.99
FeedbackRO_v1
objects. List of errors that occurred in relation to the request.FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
yUQKAEsBeeoAAAFl9vhJwIZc
P7D
int32
int32
int32
object
literals.int64
int32
P3D
int32
int32
int32
object
literals.int64
int32
string
literals. The IDs of the discounts applied to the bucket totals.54489489212
string
literals. The ids of all line items which are associated with this bucket.urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
STD_5DAY
BasketSurchargeRO_v1
objects. All extra charges arising from surcharges directly specified on product or by shipping rules with action type 'bucket'.BasketSurchargeRO_v1
: Describes a single surcharge incurred to a shipping bucket.PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
Fridge Box
Needs a fridge box for shipping.
TaxItemRO_v1
objects. The taxes applied to the surcharge.TaxItemRO_v1
: Represents a single tax item.MoneyRO_v1
object. Describes a money object.USD
10.99
JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.CANADA
COUNTRY
| Possible Values: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_DISTRICT
MoneyRO_v1
object. Describes a money object.USD
10.99
DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
MoneyRO_v1
object. Describes a money object.USD
10.99
BasketShippingMethodRO_v1
objects. The core data of the response object.BasketShippingMethodRO_v1
: Describes a shipping method that can be selected as delivery option.AttributeRO_v1
objects.BooleanAttributeRO_v1
: A representation of a boolean attribute.DateAttributeRO_v1
: A representation of a date/time attribute.DecimalAttributeRO_v1
: A representation of a decimal attribute.DoubleAttributeRO_v1
: A representation of a double attribute.IntegerAttributeRO_v1
: A representation of an integer attribute.LongAttributeRO_v1
: A representation of a long attribute.MoneyAttributeRO_v1
: A representation of a money attribute.QuantityAttributeRO_v1
: A representation of a quantity attribute.StringAttributeRO_v1
: A representation of a string attribute.TextAttributeRO_v1
: A representation of a text attribute.MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.P7D
int32
int32
int32
object
literals.int64
int32
P3D
int32
int32
int32
object
literals.int64
int32
Delivered to you 3-7 business days after we process your order.
STD_GROUND
Standard Ground
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
Int'l Express Delivery.
FeedbackRO_v1
objects. List of errors that occurred in relation to the request.FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
FeedbackRO_v1
objects. List of errors that occurred in relation to the request.FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
FeedbackRO_v1
objects. List of errors that occurred in relation to the request.FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
PaymentRO_v1
object. A payment assigned to the basket/order to pay the bill with.MoneyRO_v1
object. Describes a money object.USD
10.99
AAFjXFq2QKAEsBiyQABB6G14
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
c2UKAEsBar8AAAFmxYVBTOiI
ISH_INVOICE
PaymentRedirectRO_v1
object. Describes a payment redirect. Note: Beta version - This class can still be subject of change!uri
| Example: https://shop.server/cancel?paymentID=*paymentID*
uri
| Example: https://shop.server/failure
ParameterRO_v1
objects. List of parameters returned in the redirect response from the PSP.ParameterRO_v1
: A representation of a parameter value.expiryDate
12/20
uri
| Example: https://psp-server/pay
SUCCESS
| Possible Values: SUCCESS
CANCEL
FAILURE
uri
| Example: https://shop.server/success?orderID=*orderID*
Partially captured
MoneyRO_v1
object. Describes a money object.USD
10.99
FeedbackRO_v1
objects. List of errors that occurred in relation to the request.FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
PaymentInstrumentRO_v1
object. A payment instrument with stored bank account data.DE12****7890
AAFjXFq2QKAEsBiyQABB6G14
int32
| Example: 3
ParameterRO_v1
objects. The parameters for the payment instrument.ParameterRO_v1
: A representation of a parameter value.expiryDate
12/20
ISH_DIRECT_DEBIT
urn:payment-instrument:basket:q2QKAEsBiyQAAAFjXFBB6G14:AAFjXFq2QKAEsBiyQABB6G14
FeedbackRO_v1
objects. List of errors that occurred in relation to the request.FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
DE12****7890
AAFjXFq2QKAEsBiyQABB6G14
int32
| Example: 3
ParameterRO_v1
objects. The parameters for the payment instrument.ParameterRO_v1
: A representation of a parameter value.expiryDate
12/20
ISH_DIRECT_DEBIT
urn:payment-instrument:basket:q2QKAEsBiyQAAAFjXFBB6G14:AAFjXFq2QKAEsBiyQABB6G14
PaymentMethodRO_v1
objects. The core data of the response object.PaymentMethodRO_v1
: A configured payment method.string
literals. List of supported payment service capabilities. | Example: RedirectAfterCheckout
Simulate a payment with the Intershop demo method
ISH Demo Payment
ParameterRO_v1
objects. List of content parameters for Hosted Payment Pages.ParameterRO_v1
: A representation of a parameter value.expiryDate
12/20
ISH_INVOICE
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
ParameterDefinitionRO_v1
objects. List of parameters (e.g. credit card 3DS token or IBAN) for this payment.ParameterDefinitionRO_v1
: A representation of a parameter definition.Expiration Date
expiryDate
OptionRO_v1
objects. A list of allowable values to choose from for this parameter.OptionRO_v1
: A representation of a parameter option.American Express
amx
String
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
string
literals. The IDs of all payment instruments stored for this payment method in the current context.PaymentRestrictionRO_v1
objects. The restrictions which prevent the payment method from being applicable.PaymentRestrictionRO_v1
: A restriction which limits the use of a payment method.payment.restriction.MultipleBuckets
Not available for orders being dispatched to multiple addresses or in multiple shipments.
false
SomePaymentProvider_CreditCard
FeedbackRO_v1
objects. List of errors that occurred in relation to the request.FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
MoneyRO_v1
object. Describes a money object.USD
10.99
AAFjXFq2QKAEsBiyQABB6G14
PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
c2UKAEsBar8AAAFmxYVBTOiI
ISH_INVOICE
PaymentRedirectRO_v1
object. Describes a payment redirect. Note: Beta version - This class can still be subject of change!uri
| Example: https://shop.server/cancel?paymentID=*paymentID*
uri
| Example: https://shop.server/failure
ParameterRO_v1
objects. List of parameters returned in the redirect response from the PSP.ParameterRO_v1
: A representation of a parameter value.expiryDate
12/20
uri
| Example: https://psp-server/pay
SUCCESS
| Possible Values: SUCCESS
CANCEL
FAILURE
uri
| Example: https://shop.server/success?orderID=*orderID*
Partially captured
MoneyRO_v1
object. Describes a money object.USD
10.99