Download Specification
This API specification is available for download as an Open API 3.0 YAML file:
API Specification
Introduction
Budget API
A budget is a means to define spending limits for users or certain parts of an organization within a definable time frame.
The following operations are available:
/customers/{CustomerKey}/users/{CustomerItemUserKey}/budgets
GET: [BETA] Returns the budgets for the user
Description
This operation returns budgets for the user based on the provided keys. The budget information consists of threshold amount for single orders, budget and corresponding budget period (weekly, monthly etc.) as well as the calculated values spent budget and remaining budget.
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.approval.capi.resource.budget.UserBudgetResource.getUserBudgets()
Request Body
--
Request Parameters
Location | Name | Format | Description |
---|
in path | CustomerKey | string | Required | The customer ID | Example: OilCorp |
in path | CustomerItemUserKey | string | Required | The user ID | Example: pmiller@test.intershop.de |
Response
200 - OK
- The user budgets.
UserBudgetsRO application/json
401 - Unauthorized
- The user could not be authenticated.
403 - Forbidden
- The user is not allowed to access this resource.
404 - Not Found
- The customer or the user for the given ID could not be found.
PUT: [BETA] Updates the budgets for the user
Description
This operation updates budgets for the user. The budget information consists of threshold amount for single orders, budget and corresponding budget period (weekly, monthly etc.) as well as the calculated values spent budget and remaining budget.
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.approval.capi.resource.budget.UserBudgetResource.setUserBudgets(com.intershop.sellside.rest.b2b.approval.capi.resourceobject.budget.UserBudgetsRO)
Request Body
UserBudgetsRO application/json
Request Parameters
Location | Name | Format | Description |
---|
in path | CustomerKey | string | Required | The customer ID | Example: OilCorp |
in path | CustomerItemUserKey | string | Required | The user ID | Example: pmiller@test.intershop.de |
Response
200 - OK
- The updated user budget.
UserBudgetsRO application/json
401 - Unauthorized
- The user could not be authenticated.
403 - Forbidden
- The user is not allowed to access this resource.
404 - Not Found
- The customer or the user for the given ID could not be found.
Requisition API
A requisition is a submitted shopping cart that is subject to an approval process and has not yet been converted into an order. The following operations are available:
/customers/{CustomerKey}/users/{CustomerItemUserKey}/requisitions
GET: [BETA] Returns the list of requisitions for the user
Description
This operations returns a list of the user's requisitions. Depending on the 'view' attribute, the list of requisitions consists either of purchases made by the user (buyer view) or of purchases the user (with role 'approver') has to approve. The requisition information consists of creation date, amount of line items and the total overall line items.
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.approval.capi.resource.requisition.RequisitionListResource.getRequisitions(java.lang.String,java.lang.String,java.lang.String,java.lang.String)
Request Body
--
Request Parameters
Location | Name | Format | Description |
---|
in path | CustomerKey | string | Required | The customer ID | Example: OilCorp |
in path | CustomerItemUserKey | string | Required | The user ID | Example: pmiller@test.intershop.de |
in query | status | string | The optional approval status to filter. Possible values: 'pending', 'approved', 'rejected', 'all'. If parameter is missing or empty, the option 'all' is returned. | Example: approved |
in query | type | string | The optional requisition type to filter. Possible values: 'one-time', 'recurring', 'all'. If parameter is missing or empty, the option 'all' is returned. | Example: one-time |
in query | view | string | The optional view attribute defines if the buyer view (purchases of the user) or approver view (purchases the user has to approve) is applied. Possible values: 'buyer', 'approver'. If parameter is missing or empty, the option 'buyer' is returned. | Example: approver |
in query | include | string | Related objects (as a comma separated list) which are to be included with the response |
Response
200 - OK
- The list of requisitions for the user (buyer, approver). If the list is requested with approver view and the given user is not an approver, an empty list will be returned.
RequisitionListCtnrRO application/json
400 - Bad Request
- A query parameter contains an invalid value.
401 - Unauthorized
- The user could not be authenticated.
403 - Forbidden
- The user is not allowed to access this resource.
404 - Not Found
- The customer or user for the given ID could not be found.
/customers/{CustomerKey}/users/{CustomerItemUserKey}/requisitions/{RequisitionKey}
GET: [BETA] Returns the requisition with the given ID
Description
This operation returns details for a specific requisition based on the provided keys. The requisition information consists of creation date, the amount of line items and the total overall line items.
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.approval.capi.resource.requisition.RequisitionItemResource.getRequisition(java.lang.String)
Request Body
--
Request Parameters
Location | Name | Format | Description |
---|
in path | CustomerKey | string | Required | The customer ID | Example: OilCorp |
in path | CustomerItemUserKey | string | Required | The user ID | Example: pmiller@test.intershop.de |
in path | RequisitionKey | string | Required | The requisition ID | Example: eBwKDgAFba0AAAF0C4NAPHh3 |
in query | include | string | Related objects (as a comma separated list) which are to be included with the response |
Response
200 - OK
- The requisition with the given ID.
RequisitionItemCtnrRO application/json
401 - Unauthorized
- The user could not be authenticated.
403 - Forbidden
- The user does not have the required access privileges.
404 - Not Found
- The customer, the user or the requisition for the given ID could not be found.
FeedbackRO_v1 application/json
PATCH: [BETA] Changes the approval status of a requisition
Description
This operation changes the approval status of a specific requisition and returns its information. The requisition information consists of creation date, amount of line items and the total overall line items.
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.approval.capi.resource.requisition.RequisitionItemResource.changeStatus(com.intershop.sellside.rest.b2b.approval.capi.resourceobject.approval.ApprovalStatusChangeRO,java.lang.String)
Request Body
ApprovalStatusChangeRO application/json
Request Parameters
Location | Name | Format | Description |
---|
in path | CustomerKey | string | Required | The customer ID | Example: OilCorp |
in path | CustomerItemUserKey | string | Required | The user ID | Example: pmiller@test.intershop.de |
in path | RequisitionKey | string | Required | The requisition ID | Example: eBwKDgAFba0AAAF0C4NAPHh3 |
in query | include | string | Related objects (as a comma separated list) which are to be included with the response |
Response
200 - OK
- The requisition was successfully updated.
RequisitionItemCtnrRO application/json
404 - Not Found
- The customer, the user or the requisition for the given ID could not be found.
FeedbackRO_v1 application/json
422 - Unprocessable Entity
- The requisition could not be updated.
FeedbackRO_v1 application/json
Role API
The B2B storefront features four different roles with different permissions, which are defined via DBInit. These are Buyer, Approver, Cost Center Manager, Administrator.
For details on the individual permissions, please refer to: Guide - B2B Storefront Functionality.
The following operations are available:
/customers/{CustomerKey}/roles
GET: [BETA] Returns user roles for the customer
Description
This operation returns the complete list of user roles (assignable & implicit) for the customer. The list contains implicitly assigned roles as well roles that can be explicitly assigned. The role information consists of the role ID, the localized display name and a list of localized names of the included permissions. The flag 'fixed' indicates that the role is implicitly assigned and can't be removed.
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.approval.capi.resource.role.CustomerRoleResource.getCustomerRoles()
Request Body
--
Request Parameters
Location | Name | Format | Description |
---|
in path | CustomerKey | string | Required | The customer ID | Example: OilCorp |
Response
200 - OK
- The list of user roles.
UserRolesRO application/json
401 - Unauthorized
- The user could not be authenticated.
403 - Forbidden
- The user is not allowed to access this resource.
404 - Not Found
- The customer for the given ID could not be found.
/customers/{CustomerKey}/users/{CustomerItemUserKey}/roles
GET: [BETA] Returns a list of assigned user roles
Description
This operation returns the list of roles that are assigned to the user. The role information consists of the role ID, the localized display name and a list of localized names of the included permissions. The flag 'fixed' indicates that the role is implicitly assigned and cannot be removed.
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.approval.capi.resource.role.UserRoleResource.getUserRoles()
Request Body
--
Request Parameters
Location | Name | Format | Description |
---|
in path | CustomerKey | string | Required | The customer ID | Example: OilCorp |
in path | CustomerItemUserKey | string | Required | The user ID | Example: pmiller@test.intershop.de |
Response
200 - OK
- The list of user roles.
UserRolesRO application/json
401 - Unauthorized
- The user could not be authenticated.
403 - Forbidden
- The user is not allowed to access this resource.
404 - Not Found
- The customer or the user for the given id could not be found.
PUT: [BETA] Updates a list of assigned user roles
Description
This operation updates the list of roles that are assigned to the user. Some roles might be implicitly assigned and cannot be removed. An empty list will remove all roles despite the ones that cannot be removed. The updated list of user roles is returned.
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.approval.capi.resource.role.UserRoleResource.setUserRoles(com.intershop.sellside.rest.b2b.approval.capi.resourceobject.role.UserRolesInputRO)
Request Body
UserRolesInputRO application/json
Request Parameters
Location | Name | Format | Description |
---|
in path | CustomerKey | string | Required | The customer ID | Example: OilCorp |
in path | CustomerItemUserKey | string | Required | The user ID | Example: pmiller@test.intershop.de |
Response
200 - OK
- The list of user roles.
UserRolesRO application/json
401 - Unauthorized
- The user could not be authenticated.
403 - Forbidden
- The user is not allowed to access this resource.
404 - Not Found
- The customer or the user for the given ID could not be found.
Request and Response Object Schemata
ApprovalStatusChangeRO application/json
{"name":
string
The name of an element.
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type.
"statusCode":
string
The approval status to be changed | Example: APPROVED, REJECTED
"approvalComment":
string
The approval comment for rejection | Example: The costs are way over budget.
}FeedbackRO_v1 application/json
{"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
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/JsonPath
}
]
"code":
string
An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
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/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}RequisitionItemCtnrRO application/json
{"data":
object
A RequisitionRO
object. This resource holds information about the requisition.
{
"affiliatePartner":
string
"affiliateProgram":
string
"approval":
object
A ApprovalRO
object. This resource represents a basket approval.
{
"approvalRequired":
boolean
"costCenterApproval":
object
A ApprovalCostCenterRO
object. This resource represents a cost center approval.
{
"approvers":
array
An array of UserRO
objects.
[
UserRO
:
This resource represents a user.{
"firstName":
string
The given name (also known as a personal name, first name, forename) of the person represented by this user | Example: Peter
"lastName":
string
The surname (also known as a family name, last name) of the person represented by this user | Example: Merkel
}
]
}
"customerApproval":
object
A ApprovalCustomerRO
object. This resource represents a customer approval.
{
"approvers":
array
An array of UserRO
objects.
[
UserRO
:
This resource represents a user.{
"firstName":
string
The given name (also known as a personal name, first name, forename) of the person represented by this user | Example: Peter
"lastName":
string
The surname (also known as a family name, last name) of the person represented by this user | Example: Merkel
}
]
}
}
"approvalStatus":
object
A ApprovalStatusRO
object. This resource holds information about the approval status.
{
"name":
string
The name of an element.
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type.
"approvalDate":
string
Format: date-time
"approver":
object
A UserRO
object. This resource represents a user.
{
"firstName":
string
The given name (also known as a personal name, first name, forename) of the person represented by this user | Example: Peter
"lastName":
string
The surname (also known as a family name, last name) of the person represented by this user | Example: Merkel
}
}
"attributes":
array
An array of AttributeRO_v1
objects.
[
AttributeRO_v1
:
A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1
, DateAttributeRO_v1
, DecimalAttributeRO_v1
, DoubleAttributeRO_v1
, IntegerAttributeRO_v1
, LongAttributeRO_v1
, MoneyAttributeRO_v1
, QuantityAttributeRO_v1
, StringAttributeRO_v1
, TextAttributeRO_v1
, MultipleBooleanAttributeRO_v1
, MultipleDateAttributeRO_v1
, MultipleDecimalAttributeRO_v1
, MultipleDoubleAttributeRO_v1
, MultipleIntegerAttributeRO_v1
, MultipleLongAttributeRO_v1
, MultipleStringAttributeRO_v1
.{
"name":
string
Required | The name of an element.
"type":
string
Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: Boolean
Date
Decimal
Double
Integer
Long
Money
Quantity
String
Text
MultipleBoolean
MultipleDate
MultipleDecimal
MultipleDouble
MultipleInteger
MultipleLong
MultipleString
}
]
"buckets":
array
An array of string
literals.
"commonShipToAddress":
string
"commonShippingMethod":
string
"creationDate":
string
Format: date-time
"customer":
string
Readonly
"discounts":
object
A DiscountsRO
object. This resource holds information on the applied discounts.
{
"dynamicMessages":
array
Readonly | An array of string
literals.
"freeGiftDiscounts":
array
Readonly | An array of string
literals.
"shippingBasedDiscounts":
array
Readonly | An array of string
literals. The IDs of all discounts granted on shipping and handling costs.
"valueBasedDiscounts":
array
Readonly | An array of string
literals.
}
"documentNumber":
string
Readonly
"externalOrderReference":
string
"invoiceToAddress":
string
"lineItemCount":
integer
Format: int32
"lineItems":
array
An array of string
literals.
"messageToMerchant":
string
"order":
object
A OrderLinkRO
object. This resource represents an order link.
{
"attribute":
object
A ResourceAttribute
object. An attribute
{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
"attributes":
array
An array of ResourceAttribute
objects. The list of attributes
[
ResourceAttribute
:
An attribute{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
]
"itemId":
string
Example: owkKAE2l14QAAAF1CpAXi0XN
"name":
string
The name of an element.
"relation":
string
Possible Values: about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
"title":
string
Example: owkKAE2l14QAAAF1CpAXi0XN
"type":
string
Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
"uri":
string
Example: https://jxdemoserver6.intershop.de/INTERSHOP/rest/WFS/inSPIRED-inTRONICS_Business-Site/-/orders/owkKAE2l14QAAAF1CpAXi0XN
}
"payments":
array
An array of string
literals.
"promotionCodes":
array
An array of string
literals.
"purchaseCurrency":
string
Readonly
"recurrence":
object
A RequisitionRecurrenceRO
object. This resource holds recurrence data associated with a requisition.
{
"endDate":
string
Required | Format: date-time
"executeMissedOrders":
boolean
"interval":
object
Required
{
"years":
integer
Format: int32
"months":
integer
Format: int32
"days":
integer
Format: int32
"units":
array
An array of object
literals.
[
{
{
"seconds":
integer
Format: int64
"nano":
integer
Format: int32
}
"durationEstimated":
boolean
}
]
}
"repetitions":
integer
Required | Format: int32
"startDate":
string
Required | Format: date-time
}
"recurringOrderDocumentNo":
string
Readonly
"surcharges":
object
A RequisitionSurchargesRO
object. This resource holds information on surcharges that are applied to a requisition.
{
"bucketSurcharges":
array
Readonly | An array of SurchargeRO
objects.
[
SurchargeRO
:
This resource describes a single surcharge incurred to a shipping bucket.{
"amount":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"name":
string
Readonly | The name of an element.
"description":
string
Readonly
"taxes":
array
Readonly | An array of TaxItemRO_v1
objects.
[
TaxItemRO_v1
:
Represents a single tax item.{
"calculatedTax":
object
Required | A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"effectiveTaxRate":
number
Required | The effective rate used to calculate the tax.
"jurisdiction":
object
A JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
{
"id":
string
The jurisdiction ID. | Example: CANADA
"level":
string
The level of the jurisdiction for which the tax is applied. | Example: 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
}
"nonTaxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"situs":
string
Readonly | The situs/place of taxation. | Example: DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"taxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
]
}
]
"itemSurcharges":
array
Readonly | An array of SurchargeRO
objects.
[
SurchargeRO
:
This resource describes a single surcharge incurred to a shipping bucket.{
"amount":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"name":
string
Readonly | The name of an element.
"description":
string
Readonly
"taxes":
array
Readonly | An array of TaxItemRO_v1
objects.
[
TaxItemRO_v1
:
Represents a single tax item.{
"calculatedTax":
object
Required | A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"effectiveTaxRate":
number
Required | The effective rate used to calculate the tax.
"jurisdiction":
object
A JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
{
"id":
string
The jurisdiction ID. | Example: CANADA
"level":
string
The level of the jurisdiction for which the tax is applied. | Example: 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
}
"nonTaxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"situs":
string
Readonly | The situs/place of taxation. | Example: DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"taxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
]
}
]
}
"taxIdentificationNumber":
string
"totalGross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"totalNet":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"totalProductQuantity":
number
Readonly
"totals":
object
A RequisitionTotalsRO
object. This resource holds total price values for a requisition.
{
"grandTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"paymentCostsTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"undiscountedItemTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"undiscountedShippingTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"bucketShippingDiscountsTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"discountTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"giftingTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"itemShippingDiscountsTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"itemTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"itemValueDiscountsTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"requisitionShippingDiscountsTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"requisitionValueDiscountsTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"salesTaxTotalsByTaxRate":
array
Readonly | An array of TaxItemRO_v1
objects.
[
TaxItemRO_v1
:
Represents a single tax item.{
"calculatedTax":
object
Required | A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"effectiveTaxRate":
number
Required | The effective rate used to calculate the tax.
"jurisdiction":
object
A JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
{
"id":
string
The jurisdiction ID. | Example: CANADA
"level":
string
The level of the jurisdiction for which the tax is applied. | Example: 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
}
"nonTaxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"situs":
string
Readonly | The situs/place of taxation. | Example: DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"taxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
]
"shippingDiscountsTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"shippingTaxTotalsByTaxRate":
array
Readonly | An array of TaxItemRO_v1
objects.
[
TaxItemRO_v1
:
Represents a single tax item.{
"calculatedTax":
object
Required | A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"effectiveTaxRate":
number
Required | The effective rate used to calculate the tax.
"jurisdiction":
object
A JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
{
"id":
string
The jurisdiction ID. | Example: CANADA
"level":
string
The level of the jurisdiction for which the tax is applied. | Example: 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
}
"nonTaxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"situs":
string
Readonly | The situs/place of taxation. | Example: DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"taxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
]
"shippingTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"surchargeTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"taxTotalsByTaxRate":
array
Readonly | An array of TaxItemRO_v1
objects.
[
TaxItemRO_v1
:
Represents a single tax item.{
"calculatedTax":
object
Required | A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"effectiveTaxRate":
number
Required | The effective rate used to calculate the tax.
"jurisdiction":
object
A JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
{
"id":
string
The jurisdiction ID. | Example: CANADA
"level":
string
The level of the jurisdiction for which the tax is applied. | Example: 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
}
"nonTaxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"situs":
string
Readonly | The situs/place of taxation. | Example: DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"taxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
]
"valueDiscountsTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
}
"userBudgets":
object
A UserBudgetsRO
object. This resource represents the user's budget.
{
"name":
string
The name of an element.
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: UserBudgets
"orderSpentLimit":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"remainingBudget":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"spentBudget":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"budget":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"budgetPeriod":
string
The user budget period | Example: monthly
"remainingBudgetIncludingThisRequisition":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"spentBudgetIncludingThisRequisition":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"userInformation":
object
A UserRO
object. This resource represents a user.
{
"firstName":
string
The given name (also known as a personal name, first name, forename) of the person represented by this user | Example: Peter
"lastName":
string
The surname (also known as a family name, last name) of the person represented by this user | Example: Merkel
}
}
"errors":
array
Readonly | An array of FeedbackRO_v1
objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1
:
An error or information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
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/JsonPath
}
]
"code":
string
An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
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/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"included":
object
Optionally included related data objects.
"infos":
array
Readonly | An array of 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.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
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/JsonPath
}
]
"code":
string
An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
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/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
}RequisitionListCtnrRO application/json
{"data":
array
An array of RequisitionRO
objects. The core data of the response object.
[
RequisitionRO
:
This resource holds information about the requisition.{
"affiliatePartner":
string
"affiliateProgram":
string
"approval":
object
A ApprovalRO
object. This resource represents a basket approval.
{
"approvalRequired":
boolean
"costCenterApproval":
object
A ApprovalCostCenterRO
object. This resource represents a cost center approval.
{
"approvers":
array
An array of UserRO
objects.
[
UserRO
:
This resource represents a user.{
"firstName":
string
The given name (also known as a personal name, first name, forename) of the person represented by this user | Example: Peter
"lastName":
string
The surname (also known as a family name, last name) of the person represented by this user | Example: Merkel
}
]
}
"customerApproval":
object
A ApprovalCustomerRO
object. This resource represents a customer approval.
{
"approvers":
array
An array of UserRO
objects.
[
UserRO
:
This resource represents a user.{
"firstName":
string
The given name (also known as a personal name, first name, forename) of the person represented by this user | Example: Peter
"lastName":
string
The surname (also known as a family name, last name) of the person represented by this user | Example: Merkel
}
]
}
}
"approvalStatus":
object
A ApprovalStatusRO
object. This resource holds information about the approval status.
{
"name":
string
The name of an element.
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type.
"approvalDate":
string
Format: date-time
"approver":
object
A UserRO
object. This resource represents a user.
{
"firstName":
string
The given name (also known as a personal name, first name, forename) of the person represented by this user | Example: Peter
"lastName":
string
The surname (also known as a family name, last name) of the person represented by this user | Example: Merkel
}
}
"attributes":
array
An array of AttributeRO_v1
objects.
[
AttributeRO_v1
:
A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1
, DateAttributeRO_v1
, DecimalAttributeRO_v1
, DoubleAttributeRO_v1
, IntegerAttributeRO_v1
, LongAttributeRO_v1
, MoneyAttributeRO_v1
, QuantityAttributeRO_v1
, StringAttributeRO_v1
, TextAttributeRO_v1
, MultipleBooleanAttributeRO_v1
, MultipleDateAttributeRO_v1
, MultipleDecimalAttributeRO_v1
, MultipleDoubleAttributeRO_v1
, MultipleIntegerAttributeRO_v1
, MultipleLongAttributeRO_v1
, MultipleStringAttributeRO_v1
.{
"name":
string
Required | The name of an element.
"type":
string
Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: Boolean
Date
Decimal
Double
Integer
Long
Money
Quantity
String
Text
MultipleBoolean
MultipleDate
MultipleDecimal
MultipleDouble
MultipleInteger
MultipleLong
MultipleString
}
]
"buckets":
array
An array of string
literals.
"commonShipToAddress":
string
"commonShippingMethod":
string
"creationDate":
string
Format: date-time
"customer":
string
Readonly
"discounts":
object
A DiscountsRO
object. This resource holds information on the applied discounts.
{
"dynamicMessages":
array
Readonly | An array of string
literals.
"freeGiftDiscounts":
array
Readonly | An array of string
literals.
"shippingBasedDiscounts":
array
Readonly | An array of string
literals. The IDs of all discounts granted on shipping and handling costs.
"valueBasedDiscounts":
array
Readonly | An array of string
literals.
}
"documentNumber":
string
Readonly
"externalOrderReference":
string
"invoiceToAddress":
string
"lineItemCount":
integer
Format: int32
"lineItems":
array
An array of string
literals.
"messageToMerchant":
string
"order":
object
A OrderLinkRO
object. This resource represents an order link.
{
"attribute":
object
A ResourceAttribute
object. An attribute
{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
"attributes":
array
An array of ResourceAttribute
objects. The list of attributes
[
ResourceAttribute
:
An attribute{
"name":
string
The attribute's name
"type":
string
This is a constant: ResourceAttribute | Example: ResourceAttribute
"value":
object
The attribute's value.
}
]
"itemId":
string
Example: owkKAE2l14QAAAF1CpAXi0XN
"name":
string
The name of an element.
"relation":
string
Possible Values: about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
"title":
string
Example: owkKAE2l14QAAAF1CpAXi0XN
"type":
string
Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
"uri":
string
Example: https://jxdemoserver6.intershop.de/INTERSHOP/rest/WFS/inSPIRED-inTRONICS_Business-Site/-/orders/owkKAE2l14QAAAF1CpAXi0XN
}
"payments":
array
An array of string
literals.
"promotionCodes":
array
An array of string
literals.
"purchaseCurrency":
string
Readonly
"recurrence":
object
A RequisitionRecurrenceRO
object. This resource holds recurrence data associated with a requisition.
{
"endDate":
string
Required | Format: date-time
"executeMissedOrders":
boolean
"interval":
object
Required
{
"years":
integer
Format: int32
"months":
integer
Format: int32
"days":
integer
Format: int32
"units":
array
An array of object
literals.
[
{
{
"seconds":
integer
Format: int64
"nano":
integer
Format: int32
}
"durationEstimated":
boolean
}
]
}
"repetitions":
integer
Required | Format: int32
"startDate":
string
Required | Format: date-time
}
"recurringOrderDocumentNo":
string
Readonly
"surcharges":
object
A RequisitionSurchargesRO
object. This resource holds information on surcharges that are applied to a requisition.
{
"bucketSurcharges":
array
Readonly | An array of SurchargeRO
objects.
[
SurchargeRO
:
This resource describes a single surcharge incurred to a shipping bucket.{
"amount":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"name":
string
Readonly | The name of an element.
"description":
string
Readonly
"taxes":
array
Readonly | An array of TaxItemRO_v1
objects.
[
TaxItemRO_v1
:
Represents a single tax item.{
"calculatedTax":
object
Required | A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"effectiveTaxRate":
number
Required | The effective rate used to calculate the tax.
"jurisdiction":
object
A JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
{
"id":
string
The jurisdiction ID. | Example: CANADA
"level":
string
The level of the jurisdiction for which the tax is applied. | Example: 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
}
"nonTaxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"situs":
string
Readonly | The situs/place of taxation. | Example: DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"taxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
]
}
]
"itemSurcharges":
array
Readonly | An array of SurchargeRO
objects.
[
SurchargeRO
:
This resource describes a single surcharge incurred to a shipping bucket.{
"amount":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"name":
string
Readonly | The name of an element.
"description":
string
Readonly
"taxes":
array
Readonly | An array of TaxItemRO_v1
objects.
[
TaxItemRO_v1
:
Represents a single tax item.{
"calculatedTax":
object
Required | A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"effectiveTaxRate":
number
Required | The effective rate used to calculate the tax.
"jurisdiction":
object
A JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
{
"id":
string
The jurisdiction ID. | Example: CANADA
"level":
string
The level of the jurisdiction for which the tax is applied. | Example: 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
}
"nonTaxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"situs":
string
Readonly | The situs/place of taxation. | Example: DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"taxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
]
}
]
}
"taxIdentificationNumber":
string
"totalGross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"totalNet":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"totalProductQuantity":
number
Readonly
"totals":
object
A RequisitionTotalsRO
object. This resource holds total price values for a requisition.
{
"grandTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"paymentCostsTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"undiscountedItemTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"undiscountedShippingTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"bucketShippingDiscountsTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"discountTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"giftingTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"itemShippingDiscountsTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"itemTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"itemValueDiscountsTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"requisitionShippingDiscountsTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"requisitionValueDiscountsTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"salesTaxTotalsByTaxRate":
array
Readonly | An array of TaxItemRO_v1
objects.
[
TaxItemRO_v1
:
Represents a single tax item.{
"calculatedTax":
object
Required | A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"effectiveTaxRate":
number
Required | The effective rate used to calculate the tax.
"jurisdiction":
object
A JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
{
"id":
string
The jurisdiction ID. | Example: CANADA
"level":
string
The level of the jurisdiction for which the tax is applied. | Example: 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
}
"nonTaxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"situs":
string
Readonly | The situs/place of taxation. | Example: DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"taxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
]
"shippingDiscountsTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"shippingTaxTotalsByTaxRate":
array
Readonly | An array of TaxItemRO_v1
objects.
[
TaxItemRO_v1
:
Represents a single tax item.{
"calculatedTax":
object
Required | A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"effectiveTaxRate":
number
Required | The effective rate used to calculate the tax.
"jurisdiction":
object
A JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
{
"id":
string
The jurisdiction ID. | Example: CANADA
"level":
string
The level of the jurisdiction for which the tax is applied. | Example: 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
}
"nonTaxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"situs":
string
Readonly | The situs/place of taxation. | Example: DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"taxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
]
"shippingTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"surchargeTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"taxTotalsByTaxRate":
array
Readonly | An array of TaxItemRO_v1
objects.
[
TaxItemRO_v1
:
Represents a single tax item.{
"calculatedTax":
object
Required | A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"effectiveTaxRate":
number
Required | The effective rate used to calculate the tax.
"jurisdiction":
object
A JurisdictionRO_v1
object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
{
"id":
string
The jurisdiction ID. | Example: CANADA
"level":
string
The level of the jurisdiction for which the tax is applied. | Example: 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
}
"nonTaxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"situs":
string
Readonly | The situs/place of taxation. | Example: DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"taxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
]
"valueDiscountsTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
{
"gross":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"net":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"tax":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
}
"userBudgets":
object
A UserBudgetsRO
object. This resource represents the user's budget.
{
"name":
string
The name of an element.
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: UserBudgets
"orderSpentLimit":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"remainingBudget":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"spentBudget":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"budget":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"budgetPeriod":
string
The user budget period | Example: monthly
"remainingBudgetIncludingThisRequisition":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"spentBudgetIncludingThisRequisition":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}
"userInformation":
object
A UserRO
object. This resource represents a user.
{
"firstName":
string
The given name (also known as a personal name, first name, forename) of the person represented by this user | Example: Peter
"lastName":
string
The surname (also known as a family name, last name) of the person represented by this user | Example: Merkel
}
}
]
"errors":
array
Readonly | An array of FeedbackRO_v1
objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1
:
An error or information representation regarding the current request.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
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/JsonPath
}
]
"code":
string
An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
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/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"included":
object
Optionally included related data objects.
"infos":
array
Readonly | An array of 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.{
"causes":
array
An array of FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.
[
FeedbackCauseRO_v1
:
A representation for the common feedback informations.{
"code":
string
Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
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/JsonPath
}
]
"code":
string
An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
"message":
string
A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
"parameters":
object
A map of several parameters that are used to assemble the message.
"paths":
array
An array of
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/JsonPath"status":
string
The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
}UserBudgetsRO application/json
{"name":
string
The name of an element.
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: UserBudgets
"orderSpentLimit":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"remainingBudget":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"spentBudget":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"budget":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"budgetPeriod":
string
The user budget period | Example: monthly
"remainingBudgetIncludingThisRequisition":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
"spentBudgetIncludingThisRequisition":
object
A MoneyRO_v1
object. Describes a money object.
{
"currency":
string
Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
"value":
number
The monetary value. | Example: 10.99
}
}UserRolesInputRO application/json
{"name":
string
The name of an element.
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: UserRoles
"userRoles":
array
An array of string
literals. The assigned user roles | Example: ["APP_B2B_APPROVER","APP_B2B_ACCOUNT_OWNER"]
}UserRolesRO application/json
{"name":
string
The name of an element.
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: UserRoles
"userRoles":
array
An array of UserRoleRO
objects. The assigned user roles
[
UserRoleRO
:
This resource represents the assigned user roles.{
"name":
string
The name of an element.
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: UserRole
"roleID":
string
The ID of the role | Example: APP_B2B_APPROVER
"roleDisplayName":
string
The localized name of the role | Example: Approver
"roleDescription":
string
The localized description of the role | Example: The approver is responsible for the requisition approval.
"fixed":
boolean
Flag that indicates if the role is fixed (implicitly assigned) and cannot be deselected | Example: true
"permissions":
array
An array of RolePermissionRO
objects. The list of permissions assigned to the role containing ID and localized display name
[
RolePermissionRO
:
This resource holds a list of permissions assigned to the role, including ID and the localized display name.{
"name":
string
The name of an element.
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: RolePermission
"permissionID":
string
The ID of the permission | Example: APP_B2B_ASSIGN_COSTOBJECT_TO_BASKET
"permissionDisplayName":
string
The localized name of the permission | Example: Assign a cost object to a basket
}
]
}
]
}The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.