openapi: 3.0.1
info:
title: Order
description: |-
This version is deprecated. Please use the newer version which covers all supported operations from this version and also additional functionality.
The _Order REST API_ contains resources that cover aspects of the checkout process and order handling.
A typical checkout process requires a series of REST requests, some of which are based on one another and must therefore
take place in a defined sequence. This cannot be sufficiently represented by the OpenAPI documentation only. Detailed
descriptions of various checkout scenarios can be found in the [Business Guide "Basket & Checkout REST API"][kb-business-guide] in the Intershop knowledge base.
[kb-business-guide]: https://support.intershop.com/kb/2873B2
version: 0.2.0
servers:
- url: "/INTERSHOP/rest/{serverGroup}/{siteName}/{appUrl}"
description: Intershop ICM Server
variables:
serverGroup:
description: The server group
default: WFS
siteName:
description: The site name
default: inSPIRED-inTRONICS-Site
appUrl:
description: The application URL identifier
enum:
- rest
- rest
- rest
- rest
- rest
- rest
default: rest
tags:
- name: General
x-origin-class: com.intershop.sellside.rest.common.capi.resource.order.OrderResource
paths:
/orders:
get:
tags:
- General
summary: Get order history list
description: |-
Get a list of links to orders of logged-in user
ResourceCollectionRO contains objects of type LinkRO
operationId: getOrderList
parameters:
- name: pageable
in: query
description: the ID of the respective pageable
schema:
type: string
- name: offset
in: query
description: the pageable offset
schema:
type: integer
format: int32
- name: amount
in: query
description: the pageable amount
schema:
type: integer
format: int32
- name: attrs
in: query
schema:
type: string
- name: view
in: query
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceCollectionROLinkRO'
text/xml:
schema:
$ref: '#/components/schemas/ResourceCollectionROLinkRO'
links:
itemInfo:
operationId: getOrder
parameters:
orderKey: "$response.body#/elements/{$index}/itemId"
description: Links to item of type OrderRO
"400":
description: Bad request
"401":
description: Unauthorized
"403":
description: FORBIDDEN
"500":
description: |-
Internal Server Error
possible values for header value error-key:
- search.error
deprecated: true
security:
- bearerAuth: []
- basicAuth: []
- authToken: []
x-origin-method: "public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO\
\ com.intershop.sellside.rest.common.capi.resource.order.OrderListResource.getOrderList(java.lang.String,java.lang.Integer,java.lang.Integer,java.lang.String,java.lang.String)\
\ throws com.intershop.beehive.foundation.quantity.CurrencyException"
x-origin-class: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
post:
tags:
- General
summary: Create new order
description: |-
Creates/submits an order.
When created, this call returns a LinkRO to the created order.
in genreal, failures that occur during error creation will be sent with the `failures` fieldof the response
operationId: createOrder
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderDescriptionRO'
text/xml:
schema:
$ref: '#/components/schemas/OrderDescriptionRO'
responses:
"201":
description: Created
"404":
description: |-
Not found
example reasons:
- wrong basketID
- order already created for this basketID
"202":
description: |-
Accepted
returned for example if the order has not been approved yet
deprecated: true
security:
- bearerAuth: []
- basicAuth: []
- authToken: []
x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.order.OrderListResource.createOrder(com.intershop.sellside.rest.common.capi.resourceobject.OrderDescriptionRO)
x-origin-class: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
/orders/{orderKey}:
get:
tags:
- General
summary: Get order details
description: Get detailed information of the order with given orderID for logged-in
user
operationId: getOrder
parameters:
- name: orderKey
in: path
description: The key or UUID to resolve a single item
required: true
schema:
type: string
example: ExampleKey
x-item-key: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrderRO'
text/xml:
schema:
$ref: '#/components/schemas/OrderRO'
"401":
description: Unauthorized
"403":
description: |-
FORBIDDEN
if ID of current user does not match userID of order
"404":
description: |-
Not found
possible values for header error-key:
- order.tracking.error
deprecated: true
security:
- bearerAuth: []
- basicAuth: []
- authToken: []
x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.order.OrderRO
com.intershop.sellside.rest.common.capi.resource.order.OrderResource.getOrder()
x-origin-class: com.intershop.sellside.rest.common.capi.resource.order.OrderResource
put:
tags:
- General
summary: Cancel an order
description: |-
Cancel an Order.
If successfull, `status` of returned OrderRO is CANCELED
operationId: cancelOrder
parameters:
- name: orderKey
in: path
description: The key or UUID to resolve a single item
required: true
schema:
type: string
example: ExampleKey
x-item-key: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderRO'
text/xml:
schema:
$ref: '#/components/schemas/OrderRO'
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrderRO'
text/xml:
schema:
$ref: '#/components/schemas/OrderRO'
"400":
description: |-
Bad request
possible values for header error-key:
- order.wrong_status
- order.cancel.error
- order.cancel.not_possible.error
"401":
description: Unauthorized
"403":
description: FORBIDDEN
"404":
description: Not found
"409":
description: |-
Conflict
possible values for header error-key:
- order.cancel.not_possible.status
deprecated: true
security:
- bearerAuth: []
- basicAuth: []
- authToken: []
x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.order.OrderRO
com.intershop.sellside.rest.common.capi.resource.order.OrderResource.cancelOrder(com.intershop.sellside.rest.common.capi.resourceobject.order.OrderRO)
throws com.intershop.beehive.foundation.quantity.CurrencyException
x-origin-class: com.intershop.sellside.rest.common.capi.resource.order.OrderResource
/orders/{orderKey}/costobjects:
get:
tags:
- Cost Object
summary: (Deprecated) Returns the cost objects assigned to the selected order
description: |-
This operation is deprecated. The Cost Object feature is no longer supported.
ResourceCollectionRO contains elements of type LinkRO
operationId: getOrderCostObjectAssignments
parameters:
- name: orderKey
in: path
description: The key or UUID to resolve a single item
required: true
schema:
type: string
example: ExampleKey
x-item-key: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceCollectionROLinkRO'
text/xml:
schema:
$ref: '#/components/schemas/ResourceCollectionROLinkRO'
links:
itemInfo:
operationId: getOrderCostObjectAssignment
parameters:
OrderCostObjectAssignmentKey: "$response.body#/elements/{$index}/itemId"
description: Links to item of type CostObjectAssignmentRO
"401":
description: Unauthorized
"403":
description: |-
FORBIDDEN
Requires authentication with a user who has been assigned the following permissions:
- View Cost Object (APP_B2B_VIEW_COSTOBJECT)
deprecated: true
security:
- bearerAuth: []
- basicAuth: []
- authToken: []
x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO
com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.OrderCostObjectAssignmentListResource.getOrderCostObjectAssignments()
x-origin-class: com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.OrderCostObjectAssignmentListResource
/orders/{orderKey}/costobjects/{OrderCostObjectAssignmentKey}:
get:
tags:
- Cost Object
summary: (Deprecated) Returns a specific cost object assigned to the selected
order
description: This operation is deprecated. The Cost Object feature is no longer
supported.
operationId: getOrderCostObjectAssignment
parameters:
- name: orderKey
in: path
description: The key or UUID to resolve a single item
required: true
schema:
type: string
example: ExampleKey
x-item-key: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
- name: OrderCostObjectAssignmentKey
in: path
description: The key or UUID to resolve a single item
required: true
schema:
type: string
example: ExampleKey
x-item-key: com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.OrderCostObjectAssignmentListResource
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CostObjectAssignmentRO'
text/xml:
schema:
$ref: '#/components/schemas/CostObjectAssignmentRO'
"401":
description: Unauthorized
"404":
description: Not found
"403":
description: |-
FORBIDDEN
Requires authentication with a user who has been assigned the following permissions:
- View Cost Object (APP_B2B_VIEW_COSTOBJECT)
deprecated: true
security:
- bearerAuth: []
- basicAuth: []
- authToken: []
x-origin-method: public com.intershop.application.storefront.rest.b2b.capi.costobject.resourceobject.CostObjectAssignmentRO
com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.OrderCostObjectAssignmentItemResource.getOrderCostObjectAssignment()
x-origin-class: com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.OrderCostObjectAssignmentItemResource
components:
schemas:
GenericPropertyROObject:
type: object
properties:
name:
type: string
description: The name of an element
xml:
attribute: true
type:
type: string
description: 'The type of the element. This is normally a **constant** that
can be used to differentiate elements by their type. '
readOnly: true
xml:
attribute: true
key:
type: string
property:
type: object
displayName:
type: string
xml:
name: Property
OrderDescriptionRO:
type: object
properties:
name:
type: string
description: The name of an element
xml:
attribute: true
type:
type: string
description: 'The type of the element. This is normally a **constant** that
can be used to differentiate elements by their type. '
example: OrderDescription
xml:
attribute: true
paymentInformations:
$ref: '#/components/schemas/OrderPaymentInformationsRO'
basketID:
type: string
description: the id of the corresponding basket
example: u.0KDgAjIYsAAAFjIQxW6PNc
acceptTermsAndConditions:
type: boolean
description: did the customer accept the terms and conditions
deprecated: true
xml:
name: OrderDescription
OrderPaymentInformationsRO:
type: object
properties:
name:
type: string
description: The name of an element
xml:
attribute: true
type:
type: string
description: 'The type of the element. This is normally a **constant** that
can be used to differentiate elements by their type. '
example: OrderPaymentInformations
xml:
attribute: true
attributes:
type: array
description: The list of attributes
xml:
wrapped: true
items:
$ref: '#/components/schemas/ResourceAttribute'
id:
type: string
parameters:
type: array
xml:
wrapped: true
items:
$ref: '#/components/schemas/GenericPropertyROObject'
attribute:
$ref: '#/components/schemas/ResourceAttribute'
description: The payment information for this order as OrderPaymentInformationsRO
ResourceAttribute:
title: Attribute
type: object
properties:
name:
type: string
description: The attribute's name
xml:
attribute: true
type:
type: string
description: "This is a constant: **ResourceAttribute**"
example: ResourceAttribute
xml:
attribute: true
value:
type: object
description: The attribute's value.
description: An attribute
xml:
name: ResourceAttribute
AbstractResourceObject:
title: Object
type: object
properties:
name:
type: string
description: The name of an element
xml:
attribute: true
type:
type: string
description: 'The type of the element. This is normally a **constant** that
can be used to differentiate elements by their type. '
readOnly: true
xml:
attribute: true
description: The list of elements
ResourceCollectionRO:
type: object
properties:
pageable:
type: string
description: The pageable ID
total:
type: integer
description: The pageable amount total
format: int32
offset:
type: integer
description: The pageable offset
format: int32
amount:
type: integer
description: The pageable amount
format: int32
elements:
type: array
description: The list of elements
xml:
wrapped: true
items:
$ref: '#/components/schemas/AbstractResourceObject'
type:
type: string
description: 'The type of the element. This is normally a **constant** that
can be used to differentiate elements by their type. '
xml:
attribute: true
sortKeys:
uniqueItems: true
type: array
description: The keys to sort for
xml:
wrapped: true
items:
type: string
description: The keys to sort for
xml:
name: sortKey
name:
type: string
description: The name of an element
xml:
attribute: true
description: A list of ResourceObjects
xml:
name: ResourceCollection
LinkRO:
title: Link
type: object
properties:
name:
type: string
description: The name of the returned element
xml:
attribute: true
type:
type: string
description: "This is a constant: **Link**"
readOnly: true
example: Link
xml:
attribute: true
attributes:
type: array
description: The list of attributes
xml:
wrapped: true
items:
$ref: '#/components/schemas/ResourceAttribute'
uri:
type: string
description: The URI
relation:
type: string
description: The relation of the link
externalDocs:
description: Link Relations (www.iana.org)
url: http://www.iana.org/assignments/link-relations/link-relations.xml
enum:
- about
- alternate
- appendix
- archives
- author
- bookmark
- canonical
- chapter
- collection
- contents
- copyright
- create-form
- current
- describedby
- describes
- disclosure
- duplicate
- edit
- edit-form
- edit-media
- enclosure
- first
- glossary
- help
- hosts
- hub
- icon
- index
- item
- last
- latest-version
- license
- lrdd
- monitor
- monitor-group
- next
- next-archive
- nofollow
- noreferrer
- payment
- predecessor-version
- prefetch
- prev
- preview
- previous
- prev-archive
- privacy-policy
- profile
- related
- replies
- search
- section
- self
- service
- start
- stylesheet
- subsection
- successor-version
- tag
- terms-of-service
- type
- up
- version-history
- via
- working-copy
- working-copy-of
title:
type: string
description: The title of the link
description:
type: string
description: The description of the link
itemId:
type: string
description: The ID of the linked item
attribute:
$ref: '#/components/schemas/ResourceAttribute'
description: A Link pointing to a resource
xml:
name: Link
ResourceCollectionROLinkRO:
title: Link List
type: object
properties:
pageable:
type: string
description: The pageable ID.
total:
type: integer
description: The pageable amount total
format: int32
offset:
type: integer
description: The pageable offset
format: int32
amount:
type: integer
description: The pageable amount
format: int32
elements:
type: array
description: The list of elements
xml:
wrapped: true
items:
$ref: '#/components/schemas/LinkRO'
type:
type: string
description: "This is a constant: **ResourceCollection**"
example: ResourceCollection
xml:
attribute: true
sortKeys:
uniqueItems: true
type: array
description: The keys to sort for
xml:
wrapped: true
items:
type: string
description: The keys to sort for
xml:
name: sortKey
name:
type: string
description: The name of the returned element
xml:
attribute: true
description: A list of links
xml:
name: ResourceCollection
AddressRO:
title: Address
type: object
properties:
name:
type: string
description: The name of an element
xml:
attribute: true
type:
type: string
description: 'The type of the element. This is normally a **constant** that
can be used to differentiate elements by their type. '
example: Address
xml:
attribute: true
urn:
type: string
description: the URN representation of this address
example: urn:address:customer:1234567890:0987654321
id:
type: string
description: The ID of the returned element
example: vagKAB17gg4AAAFGSkFqQASI
externalId:
type: string
description: The ID uniquely identifying the address in an external system;
required only for data objects that have already been synchronized with
the external system
readOnly: true
example: "000123456"
externalUrn:
type: string
description: The URN uniquely identifying the address in an external system;
required only for data objects that have already been synchronized with
the external system
readOnly: true
example: urn:address:MSDynamics365:MyCorp:000123456
addressName:
type: string
description: The name of the address
example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
title:
type: string
description: "The (personal) title of the contact person, like 'Mr.' or\
\ 'Ms.'"
example: Mrs.
aristocraticTitle:
type: string
description: "the aristocratic title of the contact person, like Lord\
\ or Lady"
jobTitle:
type: string
description: the job title of the contact person
example: CEO
honorific:
type: string
description: "the honorific title of the contact person that denotes the\
\ honored person's occupation, like Captain, Coach, Officer,\
\ Reverend or the academic title, like PhD"
firstName:
type: string
description: The (first) given name of the contact person
example: Patricia
secondName:
type: string
description: the second given name of the contact person
example: Luise
lastName:
type: string
description: The last name of the contact person
example: Miller
secondLastName:
type: string
description: the second last name of the contact person
companyName1:
type: string
description: the company name
example: PMiller ltd.
companyName2:
type: string
description: The second company name
addressLine1:
type: string
description: the first address line
example: Berliner Str. 20
addressLine2:
type: string
description: the second address line
example: 1st Floor
addressLine3:
type: string
description: The third address line
example: Second door on the right
postBox:
type: string
description: the post-office box
example: PO Box 42
mainDivision:
type: string
description: "the main division of the country, e. g. a state or province"
example: AL
mainDivisionName:
type: string
description: The localized display name of the main division
example: Alabama
subDivision:
type: string
description: The sub division code of the country.
example: GB-PKN
subDivisionName:
type: string
description: The localized display name of the sub division
example: Perth and Kinross
postalCode:
type: string
description: The postal code
example: "14482"
email:
type: string
description: the e-mail address of the contact person
example: pmiller@intershop.de
phoneMobile:
type: string
description: The number of the contact person's cell phone
example: +49364112677
phoneHome:
type: string
description: The phone number of the house or apartment where the contact
person lives
example: "049364112677"
phoneBusiness:
type: string
description: The phone number of the contact person's company
example: "049364112699"
phoneBusinessDirect:
type: string
description: the business phone number of the contact person that allows
an outside caller to connect directly to the contact person without any
help of an attendant or operator
example: "049364112659"
country:
type: string
description: The display name of the country in the current locale
example: Germany
countryCode:
type: string
description: The country code
example: DE
city:
type: string
description: The name of the city
example: Potsdam
fax:
type: string
description: the fax number
example: "049364112643"
usage:
type: object
properties:
empty:
type: boolean
description: " Returns usage information for the address. Every bit in the\
\ returned set marks a specific usage type, like ship-from or invoice-to\
\ address. If a bit is set, the address may be used for the specific purpose\
\ mapped to this bit. Further bits may be used for custom types. Default\
\ usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to"
description: This resource holds the details of an address.
xml:
name: Address
AppliedRebateRO:
type: object
properties:
name:
type: string
description: The name of an element
xml:
attribute: true
type:
type: string
description: 'The type of the element. This is normally a **constant** that
can be used to differentiate elements by their type. '
example: AppliedRebate
xml:
attribute: true
rebateType:
type: string
description: the type of the applied rebate
example: OrderValueOffDiscount
description:
type: string
description: The description of the applied rebate
example: "For orders over 200 USD, a 10 USD Order discount is guaranteed\
\ for the Promo Code 'INTERSHOP'."
code:
type: string
description: the code of the applied rebate
example: INTERSHOP
amount:
$ref: '#/components/schemas/MoneyRO'
description: the shipping rebates for this order
xml:
name: AppliedRebate
AppliedTaxRO:
type: object
properties:
name:
type: string
description: The name of an element
xml:
attribute: true
type:
type: string
description: 'The type of the element. This is normally a **constant** that
can be used to differentiate elements by their type. '
example: AppliedTax
xml:
attribute: true
rate:
type: number
description: "the tax rate, 100 = 100%"
example: 19
amount:
$ref: '#/components/schemas/MoneyRO'
description: The Shipping Tax Totals by tax rate for this order
xml:
name: AppliedTax
MoneyRO:
title: Money
type: object
properties:
type:
type: string
description: "This is a constant: **Money**"
readOnly: true
example: Money
xml:
attribute: true
value:
type: number
description: The monetary value.
example: 10.99
currencyMnemonic:
type: string
deprecated: true
currency:
type: string
description: Three-letter currency code (ISO 4217) of the monetary value.
example: USD
description: Money combines a currency and a money amount.
xml:
name: Money
OrderLineItemRO:
type: object
properties:
name:
type: string
description: The name of an element
xml:
attribute: true
type:
type: string
description: 'The type of the element. This is normally a **constant** that
can be used to differentiate elements by their type. '
example: OrderLineItem
xml:
attribute: true
shipToAddress:
$ref: '#/components/schemas/AddressRO'
shippingMethod:
$ref: '#/components/schemas/OrderShippingMethodRO'
quantity:
$ref: '#/components/schemas/QuantityRO'
product:
$ref: '#/components/schemas/LinkRO'
thumbnail:
$ref: '#/components/schemas/LinkRO'
giftMessage:
$ref: '#/components/schemas/LinkRO'
warranty:
$ref: '#/components/schemas/LinkRO'
id:
type: string
description: the id of the line item
example: 2hIKAB17haUAAAFG4.xU7mGD
fulfillmentStatus:
type: string
description: the fulfillment status of the line item
example: NEW
position:
type: integer
description: the position of the line item
format: int32
example: 1
isHiddenGift:
type: boolean
description: indicates if the line item is a hidden gift
example: false
isFreeGift:
type: boolean
description: indicates if the line item is a free gift
example: false
singleBasePrice:
$ref: '#/components/schemas/MoneyRO'
price:
$ref: '#/components/schemas/MoneyRO'
totals:
$ref: '#/components/schemas/OrderLineItemTotalsRO'
salesTaxes:
type: array
description: the line item's applied taxes
xml:
wrapped: true
items:
$ref: '#/components/schemas/AppliedTaxRO'
shippingTaxes:
type: array
description: the line items shipping taxes
xml:
wrapped: true
items:
$ref: '#/components/schemas/AppliedTaxRO'
itemSurcharges:
type: array
description: the line item's surcharges
xml:
wrapped: true
items:
$ref: '#/components/schemas/SurchargeRO'
itemImportSurcharges:
type: array
description: the line item's import surcharges
xml:
wrapped: true
items:
$ref: '#/components/schemas/SurchargeRO'
valueRebates:
type: array
description: the line item's value rebates
xml:
wrapped: true
items:
$ref: '#/components/schemas/AppliedRebateRO'
shippingRebates:
type: array
description: the line item's shipping rebates
xml:
wrapped: true
items:
$ref: '#/components/schemas/AppliedRebateRO'
senderName:
type: string
description: the name of the sender
example: Patricia Miller
senderEmail:
type: string
description: the senders email
example: pmiller@test.intershop.de
recipientName:
type: string
description: the name of the recipient
example: Fritz Birdo
recipientEmail:
type: string
description: the email of the recipient
example: f.birdo@test.intershop.de
greetingMessage:
type: string
description: the greeting message
example: Greetings!
availability:
type: boolean
description: indicates if the line item is available
variationProduct:
type: boolean
description: indicates if the line item is a product variation
example: false
bundleProduct:
type: boolean
description: indicates if the line item is part of a bundle
example: false
giftwrap:
$ref: '#/components/schemas/LinkRO'
description: the line items of this OrderShippingBucket as Collection of LinkROs
deprecated: true
xml:
name: OrderLineItem
OrderLineItemTotalsRO:
type: object
properties:
name:
type: string
description: The name of an element
xml:
attribute: true
type:
type: string
description: 'The type of the element. This is normally a **constant** that
can be used to differentiate elements by their type. '
readOnly: true
xml:
attribute: true
total:
$ref: '#/components/schemas/MoneyRO'
valueRebatesTotal:
$ref: '#/components/schemas/MoneyRO'
shippingTotal:
$ref: '#/components/schemas/MoneyRO'
shippingRebatesTotal:
$ref: '#/components/schemas/MoneyRO'
giftingTotal:
$ref: '#/components/schemas/MoneyRO'
salesTaxTotal:
$ref: '#/components/schemas/MoneyRO'
shippingTaxTotal:
$ref: '#/components/schemas/MoneyRO'
description: the totals of the line item as LineItemTotals
deprecated: true
xml:
name: OrderLineItemTotals
OrderPaymentRO:
type: object
properties:
name:
type: string
description: The name of an element
xml:
attribute: true
type:
type: string
description: 'The type of the element. This is normally a **constant** that
can be used to differentiate elements by their type. '
example: OrderPayment
xml:
attribute: true
attributes:
type: array
description: The list of attributes
xml:
wrapped: true
items:
$ref: '#/components/schemas/ResourceAttribute'
displayName:
type: string
description: the payment method's display name
example: Gift Card / Certificate
number:
type: string
description: the number of the payment method if applicable (e.g. CreditCardNumber)
example: '*******6241'
status:
type: string
description: the status of the payment
example: Captured
limitedTenderBalance:
$ref: '#/components/schemas/MoneyRO'
paymentTotalAmount:
$ref: '#/components/schemas/MoneyRO'
attribute:
$ref: '#/components/schemas/ResourceAttribute'
description: the payments of this order
deprecated: true
xml:
name: OrderPayment
OrderRO:
title: Order
type: object
properties:
name:
type: string
description: The name of an element
xml:
attribute: true
type:
type: string
description: 'The type of the element. This is normally a **constant** that
can be used to differentiate elements by their type. '
example: Order
xml:
attribute: true
documentNo:
type: string
description: the document number of the order
example: "00000051"
creationDate:
type: string
description: the creation date of the order
format: date-time
status:
type: string
description: the status of the order
example: NEW
department:
type: string
description: the deparment this order belongs to
example: Sales
purchaseCurrency:
type: string
description: the currencymnemonic of the order
example: USD
taxationID:
type: string
description: the taxation ID of the order
example: "99999999999"
customer:
type: string
description: The order owner customer number.
readOnly: true
user:
type: string
description: The order owner user login.
readOnly: true
taxExempt:
type: boolean
description: indicating if the order is tax exempt
example: false
subscription:
$ref: '#/components/schemas/LinkRO'
invoiceToAddress:
$ref: '#/components/schemas/AddressRO'
shippingBuckets:
type: array
description: the shipping buckets in this order
xml:
wrapped: true
items:
$ref: '#/components/schemas/OrderShippingBucketRO'
payments:
type: array
description: the payments of this order
xml:
wrapped: true
items:
$ref: '#/components/schemas/OrderPaymentRO'
valueRebates:
type: array
description: the value rebates for this order
xml:
wrapped: true
items:
$ref: '#/components/schemas/AppliedRebateRO'
shippingRebates:
type: array
description: the shipping rebates for this order
xml:
wrapped: true
items:
$ref: '#/components/schemas/AppliedRebateRO'
itemSurchargeTotalsByType:
type: array
description: The Item Surcharge Totals by type for this order
xml:
wrapped: true
items:
$ref: '#/components/schemas/SurchargeRO'
bucketSurchargeTotalsByType:
type: array
description: The Bucket Surcharge Totals by type for this order
xml:
wrapped: true
items:
$ref: '#/components/schemas/SurchargeRO'
salesTaxTotalsByTaxRate:
type: array
description: The Sales Tax Totals by tax rate for this order
xml:
wrapped: true
items:
$ref: '#/components/schemas/AppliedTaxRO'
shippingTaxTotalsByTaxRate:
type: array
description: The Shipping Tax Totals by tax rate for this order
xml:
wrapped: true
items:
$ref: '#/components/schemas/AppliedTaxRO'
affiliatePartnerID:
type: string
description: the affiliate PartnerID
example: 4bcKAB2Ykg4AAAFbjvEYRPJ7
affiliateProgramID:
type: string
description: the affiliate ProgramID
example: uzMKAB2YvKAAAAFb7DUYRPJ8
totals:
$ref: '#/components/schemas/OrderTotalsRO'
externalOrderReferenceID:
type: string
description: the external order reference id of the order
id:
type: string
description: the id of the order
example: mXAKAB17RqIAAAFGOuxU7mGD
description: This resource holds information on an order of a cost center.
deprecated: true
xml:
name: Order
OrderShippingBucketRO:
type: object
properties:
name:
type: string
description: The name of an element
xml:
attribute: true
type:
type: string
description: 'The type of the element. This is normally a **constant** that
can be used to differentiate elements by their type. '
example: OrderShippingBucket
xml:
attribute: true
shipToAddress:
$ref: '#/components/schemas/AddressRO'
shippingMethod:
$ref: '#/components/schemas/OrderShippingMethodRO'
lineItems:
type: array
description: the line items of this OrderShippingBucket as Collection of
LinkROs
xml:
wrapped: true
items:
$ref: '#/components/schemas/OrderLineItemRO'
bucketSurcharges:
type: array
description: the surcharges of this OrderShippingBucket as SurchargeRO
xml:
wrapped: true
items:
$ref: '#/components/schemas/SurchargeRO'
shippingRebates:
type: array
description: the shipping rebates of this OrderShippingBucket as AppliedRebateRO
xml:
wrapped: true
items:
$ref: '#/components/schemas/AppliedRebateRO'
packSlipMessage:
type: string
description: the pack slip message for this OrderShippingBucket
example: Your order is here!
shippingInstructions:
type: string
description: the shipping instrucations of this OrderShippingBucket
example: Keep away from water
description: the shipping buckets in this order
deprecated: true
xml:
name: OrderShippingBucket
OrderShippingMethodRO:
type: object
properties:
name:
type: string
description: The name of an element
xml:
attribute: true
type:
type: string
description: 'The type of the element. This is normally a **constant** that
can be used to differentiate elements by their type. '
example: OrderShippingMethod
xml:
attribute: true
id:
type: string
description: The id of the returned element
example: STD_GROUND
shippingTimeMin:
type: integer
description: The minimum shipping time in days
format: int32
example: 3
shippingTimeMax:
type: integer
description: The maximum shipping time in days
format: int32
example: 7
description: the shipping method for the line item as OrderShippingMethodRO
deprecated: true
xml:
name: OrderShippingMethod
OrderTotalsRO:
type: object
properties:
name:
type: string
description: The name of an element
xml:
attribute: true
type:
type: string
description: 'The type of the element. This is normally a **constant** that
can be used to differentiate elements by their type. '
example: OrderTotals
xml:
attribute: true
itemTotal:
$ref: '#/components/schemas/MoneyRO'
itemRebatesTotal:
$ref: '#/components/schemas/MoneyRO'
shippingTotal:
$ref: '#/components/schemas/MoneyRO'
itemShippingRebatesTotal:
$ref: '#/components/schemas/MoneyRO'
bucketShippingRebatesTotal:
$ref: '#/components/schemas/MoneyRO'
orderValueRebatesTotal:
$ref: '#/components/schemas/MoneyRO'
orderShippingRebatesTotal:
$ref: '#/components/schemas/MoneyRO'
taxTotal:
$ref: '#/components/schemas/MoneyRO'
dutiesAndSurchargesTotal:
$ref: '#/components/schemas/MoneyRO'
orderTotal:
$ref: '#/components/schemas/MoneyRO'
paymentCostsTotal:
$ref: '#/components/schemas/MoneyRO'
orderTotalMinusLimitedTender:
$ref: '#/components/schemas/MoneyRO'
limitedTenderTotal:
$ref: '#/components/schemas/MoneyRO'
description: the totals of this order as OrderTotalsRO
deprecated: true
xml:
name: OrderTotals
QuantityRO:
title: Quantity
type: object
properties:
type:
type: string
description: "This is a constant: **Quantity**"
readOnly: true
example: Quantity
xml:
attribute: true
value:
type: number
description: The quantity's value
example: 10.99
unit:
type: string
description: The quantity's ISO unit code.
example: PIEC
description: Quantity combines a quantity value and the ISO unit code the value
is defined in.
xml:
name: Quantity
SurchargeRO:
title: SurchargeRO
type: object
properties:
name:
type: string
description: The name of an element
xml:
attribute: true
type:
type: string
description: 'The type of the element. This is normally a **constant** that
can be used to differentiate elements by their type. '
example: Surcharge
xml:
attribute: true
amount:
$ref: '#/components/schemas/MoneyRO'
description:
type: string
description: the description of the surcharge
displayName:
type: string
description: the display name of the surcharge
taxes:
type: array
description: the taxes applied to the surcharge amount as collection of
AppliedTaxRO
xml:
wrapped: true
items:
$ref: '#/components/schemas/AppliedTaxRO'
description: This resource describes a single surcharge incurred to a shipping
bucket.
xml:
name: Surcharge
CostObjectAssignmentRO:
type: object
properties:
name:
type: string
description: The name of an element
example: "451"
type:
type: string
description: 'The type of the element. This is normally a **constant** that
can be used to differentiate elements by their type. '
example: Project
xml:
name: CostObjectAssignment
responses:
"200":
description: OK
"201":
description: Created
"202":
description: Accepted
"204":
description: No Content
"205":
description: Reset Content
"206":
description: Partial Content
"301":
description: Moved Permanently
"302":
description: Found
"303":
description: See Other
"304":
description: Not Modified
"305":
description: Use Proxy
"307":
description: Temporary Redirect
"400":
description: Bad Request
"401":
description: Unauthorized
"402":
description: Payment Required
"403":
description: Forbidden
"404":
description: Not Found
"405":
description: Method Not Allowed
"406":
description: Not Acceptable
"407":
description: Proxy Authentication Required
"408":
description: Request Timeout
"409":
description: Conflict
"410":
description: Gone
"411":
description: Length Required
"412":
description: Precondition Failed
"413":
description: Request Entity Too Large
"414":
description: Request-URI Too Long
"415":
description: Unsupported Media Type
"416":
description: Requested Range Not Satisfiable
"417":
description: Expectation Failed
"428":
description: Precondition Required
"429":
description: Too Many Requests
"431":
description: Request Header Fields Too Large
"500":
description: Internal Server Error
"501":
description: Not Implemented
"502":
description: Bad Gateway
"503":
description: Service Unavailable
"504":
description: Gateway Timeout
"505":
description: HTTP Version Not Supported
"511":
description: Network Authentication Required
parameters:
loc:
name: loc
in: path
description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\
\ If omitted, the priority is as follows (from high to low): Locale ID parameter,\
\ user's default locale, site's default locale. The available locales depend\
\ on your individual Intershop Commerce Management installation. Use IANA\
\ language definitions for languages and regions and combine them using a\
\ underscore, e. g. ```en_US```."
required: false
style: matrix
schema:
type: string
description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\
\ If omitted, the priority is as follows (from high to low): Locale ID parameter,\
\ user's default locale, site's default locale. The available locales depend\
\ on your individual Intershop Commerce Management installation. Use IANA\
\ language definitions for languages and regions and combine them using\
\ a underscore, e. g. ```en_US```."
default: en_US
examples:
en_US:
description: English (United States)
value: en_US
fr_FR:
description: French (France)
value: fr_FR
de_DE:
description: German (Germany)
value: de_DE
x-matrixParamPath: /
cur:
name: cur
in: path
description: "The currency code (submitted as optional matrix parameter ```;cur=```).\
\ If omitted, the site's or user's default currency is used."
required: false
style: matrix
schema:
type: string
description: "The currency code (submitted as optional matrix parameter ```;cur=```).\
\ If omitted, the site's or user's default currency is used."
default: USD
examples:
FJD:
description: Fiji Dollar
value: FJD
STD:
description: São Tomé / Príncipe Dobra
value: STD
MXN:
description: Mexican Peso
value: MXN
SCR:
description: Seychelles Rupee
value: SCR
LVL:
description: Latvian Lats
value: LVL
CDF:
description: Congolese Franc
value: CDF
GTQ:
description: Guatemalan Quetzal
value: GTQ
BBD:
description: Barbados Dollar
value: BBD
CLP:
description: Chilean Peso
value: CLP
UGX:
description: Ugandan Shilling
value: UGX
HNL:
description: Honduran Lempira
value: HNL
ZAR:
description: South African Rand
value: ZAR
TND:
description: Tunisian Dinar
value: TND
SLL:
description: Sierra Leonean Leone
value: SLL
BSD:
description: Bahamian Dollar
value: BSD
SDG:
description: Sudanese Pound
value: SDG
IQD:
description: Iraqi Dinar
value: IQD
GMD:
description: Gambian Dalasi
value: GMD
CUP:
description: Cuban Peso
value: CUP
TWD:
description: New Taiwan Dollar
value: TWD
RSD:
description: Serbian Dinar
value: RSD
ZRZ:
description: Zaire
value: ZRZ
DOP:
description: Dominican Peso
value: DOP
KMF:
description: Comoro Franc
value: KMF
MYR:
description: Malaysian Ringgit
value: MYR
FKP:
description: Falkland Islands Pound
value: FKP
XOF:
description: CFA Franc BCEAO
value: XOF
GEL:
description: Lari
value: GEL
UYU:
description: Uruguayan Peso
value: UYU
MAD:
description: Moroccan Dirham
value: MAD
CVE:
description: Cape Verde Escudo
value: CVE
TOP:
description: Tongan Pa'anga
value: TOP
PGK:
description: Papua New Guinean Kina
value: PGK
OMR:
description: Omani Rial
value: OMR
AZN:
description: Azerbaijanian Manat
value: AZN
SEK:
description: Swedish Krona
value: SEK
KES:
description: Kenyan Shilling
value: KES
UAH:
description: Ukrainian Hryvnia
value: UAH
BTN:
description: Ngultrum
value: BTN
GNF:
description: Guinea Franc
value: GNF
MZN:
description: Mozambican Metical
value: MZN
ERN:
description: Nakfa
value: ERN
SVC:
description: Salvadoran Colón
value: SVC
ARS:
description: Argentine Peso
value: ARS
QAR:
description: Qatari Riyal
value: QAR
NLG:
description: Dutch Guilder
value: NLG
IRR:
description: Iranian Rial
value: IRR
MRO:
description: Mauritanian Ouguiya
value: MRO
XPF:
description: CFP Franc
value: XPF
UZS:
description: Uzbekistani Som
value: UZS
THB:
description: Thai Baht
value: THB
CNY:
description: Yuan Renminbi
value: CNY
BDT:
description: Bangladeshi Taka
value: BDT
LYD:
description: Libyan Dinar
value: LYD
BMD:
description: Bermudian Dollar
value: BMD
PHP:
description: Philippine Peso
value: PHP
KWD:
description: Kuwaiti Dinar
value: KWD
RUB:
description: Russian Ruble
value: RUB
PYG:
description: Paraguayan Guarani
value: PYG
JMD:
description: Jamaican Dollar
value: JMD
ISK:
description: Iceland Krona
value: ISK
GWP:
description: Guinea Peso
value: GWP
BEF:
description: Belgian Franc
value: BEF
ESP:
description: Spanish Peseta
value: ESP
COP:
description: Colombian Peso
value: COP
USD:
description: US Dollar
value: USD
MKD:
description: Denar
value: MKD
DZD:
description: Algerian Dinar
value: DZD
PAB:
description: Panamanian Balboa
value: PAB
SGD:
description: Singapore Dollar
value: SGD
ETB:
description: Ethiopian Birr
value: ETB
VUV:
description: Vanuatu Vatu
value: VUV
VEF:
description: Venezuelan Bolivar Fuerte
value: VEF
SOS:
description: Somali Shilling
value: SOS
KGS:
description: Som
value: KGS
LAK:
description: Lao Kip
value: LAK
ZMK:
description: Zambian Kwacha
value: ZMK
BND:
description: Brunei Dollar
value: BND
XAF:
description: CFA Franc BEAC
value: XAF
LRD:
description: Liberian Dollar
value: LRD
ITL:
description: Italian Lira
value: ITL
HRK:
description: Croatian Kuna
value: HRK
CHF:
description: Swiss Franc
value: CHF
ATS:
description: Austrian Schilling
value: ATS
DJF:
description: Djibouti Franc
value: DJF
ALL:
description: Albanian Lek
value: ALL
MTL:
description: Maltese Lira
value: MTL
TZS:
description: Tanzanian Shilling
value: TZS
VND:
description: Vietnamese Dong
value: VND
AUD:
description: Australian Dollar
value: AUD
ILS:
description: New Israeli Sheqel
value: ILS
KPW:
description: North Korean Won
value: KPW
GYD:
description: Guyanese Dollar
value: GYD
GHS:
description: Ghanaian Cedi
value: GHS
MDL:
description: Moldovan Leu
value: MDL
KHR:
description: Cambodian Riel
value: KHR
BOB:
description: Boliviano
value: BOB
IDR:
description: Indonesian Rupiah
value: IDR
KYD:
description: Cayman Islands Dollar
value: KYD
AMD:
description: Armenian Dram
value: AMD
TRY:
description: Turkish Lira
value: TRY
SHP:
description: Saint Helena Pound
value: SHP
BWP:
description: Botswana Pula
value: BWP
LBP:
description: Lebanese Pound
value: LBP
CYP:
description: Cyprus Pound
value: CYP
TJS:
description: Tajikistani Somoni
value: TJS
JOD:
description: Jordanian Dinar
value: JOD
RWF:
description: Rwanda Franc
value: RWF
HKD:
description: Hong Kong Dollar
value: HKD
AED:
description: United Arab Emirates Dirham
value: AED
EUR:
description: Euro
value: EUR
LSL:
description: Lesotho Loti
value: LSL
DKK:
description: Danish Krone
value: DKK
CAD:
description: Canadian Dollar
value: CAD
BGN:
description: Bulgarian Lev
value: BGN
MMK:
description: Kyat
value: MMK
EEK:
description: Estonian Kroon
value: EEK
SYP:
description: Syrian Pound
value: SYP
NOK:
description: Norwegian Krone
value: NOK
MUR:
description: Mauritian Rupee
value: MUR
ZWL:
description: Zimbabwean Dollar
value: ZWL
GIP:
description: Gibraltar Pound
value: GIP
RON:
description: Romanian New Leu
value: RON
LKR:
description: Sri Lankan Rupee
value: LKR
NGN:
description: Nigerian Naira
value: NGN
IEP:
description: Irish Pound
value: IEP
CZK:
description: Czech Koruna
value: CZK
CRC:
description: Costa Rican Colon
value: CRC
PKR:
description: Pakistani Rupee
value: PKR
XCD:
description: East Carribean Dollar
value: XCD
GRD:
description: Greek Drachma
value: GRD
HTG:
description: Haitian Gourde
value: HTG
ANG:
description: Netherlands Antillian Guilder
value: ANG
SIT:
description: Slovenian Tolar
value: SIT
BHD:
description: Bahraini Dinar
value: BHD
PTE:
description: Portuguese Escudo
value: PTE
BPP:
description: Bonus Point Price
value: BPP
SZL:
description: Swazi Lilangeni
value: SZL
SRD:
description: Surinam Dollar
value: SRD
KZT:
description: Kazakhstani Tenge
value: KZT
TTD:
description: Trinidad and Tobago Dollar
value: TTD
SAR:
description: Saudi Riyal
value: SAR
LTL:
description: Lithuanian Litas
value: LTL
YER:
description: Yemeni Rial
value: YER
MVR:
description: Maldivian Rufiyaa
value: MVR
BPV:
description: Bonus Point Value
value: BPV
AFN:
description: Afghani
value: AFN
INR:
description: Indian Rupee
value: INR
NPR:
description: Nepalese Rupee
value: NPR
KRW:
description: South Korean Won
value: KRW
AWG:
description: Aruban Florin
value: AWG
MNT:
description: Mongolian Tugrik
value: MNT
JPY:
description: Japanese Yen
value: JPY
PLN:
description: Polish Złoty
value: PLN
AOA:
description: Angolan Kwanza
value: AOA
SBD:
description: Solomon Islands Dollar
value: SBD
GBP:
description: Pound Sterling
value: GBP
HUF:
description: Hungarian Forint
value: HUF
BYR:
description: Belarussian Ruble
value: BYR
LUF:
description: Luxembourgian Franc
value: LUF
BIF:
description: Burundi Franc
value: BIF
MWK:
description: Malawian Kwacha
value: MWK
MGA:
description: Malagasy Ariary
value: MGA
FIM:
description: Finnish Mark
value: FIM
DEM:
description: Deutsche Mark
value: DEM
BZD:
description: Belize Dollar
value: BZD
BAM:
description: Convertible Marks
value: BAM
MOP:
description: Macanese Pataca
value: MOP
EGP:
description: Egyptian Pound
value: EGP
NAD:
description: Namibian Dollar
value: NAD
SKK:
description: Slovakian Krona
value: SKK
NIO:
description: Cordoba Oro
value: NIO
PEN:
description: Peruvian Nuevo Sol
value: PEN
WST:
description: Samoan Tala
value: WST
NZD:
description: New Zealand Dollar
value: NZD
TMT:
description: Turkmenistani Manat
value: TMT
FRF:
description: French Franc
value: FRF
BRL:
description: Brazilian Real
value: BRL
x-matrixParamPath: /
regionals:
name: regionals
in: path
required: false
style: matrix
schema:
type: object
properties:
loc:
type: string
description: The locale ID
example: en_US
cur:
type: string
description: The currency code
example: EUR
x-matrixParamPath: /
pgid:
name: pgid
in: path
description: "The personalization group identifier, submitted as matrix parameter\
\ ```;pgid=```. Required if you want to work with customer-specific\
\ content."
required: false
style: matrix
schema:
type: string
description: "The personalization group identifier, submitted as matrix parameter\
\ ```;pgid=```. Required if you want to work with customer-specific\
\ content."
example: FUOGrzQ_VjORpGaN8DRGmLLE0000
example: FUOGrzQ_VjORpGaN8DRGmLLE0000
spgid:
name: spgid
in: path
description: "The secure personalization group identifier, submitted as matrix\
\ parameter ```;spgid=```. Required if you want to work with customer-specific\
\ content."
required: false
style: matrix
schema:
type: string
description: "The secure personalization group identifier, submitted as matrix\
\ parameter ```;spgid=```. Required if you want to work with customer-specific\
\ content."
example: FUOGrzQ_VjORpGaN8DRGmLLE0000
example: FUOGrzQ_VjORpGaN8DRGmLLE0000
securitySchemes:
basicAuth:
type: http
description: "Basic access authentication. In basic authentication, a request\
\ contains a header field in the form of authorization: ```Basic ```,\
\ where credentials is the Base64 encoding of ID and password joined by a\
\ single colon :."
scheme: basic
authToken:
type: apiKey
description: User authentication token to authenticate the request. The token
is a string generated by the ICM server in the same header in every response
of an REST endpoint.
name: authentication-token
in: header
bearerAuth:
type: http
description: "Bearer token authentication. A request contains a header field\
\ in the form of authorization: ```Bearer ```, where is a string\
\ generated by an authentication service in response to a login request."
scheme: bearer
bearerFormat: JWT
x-apiID: order_v010
x-origin-class: "com.intershop.component.rest.capi.resource.RootResource,com.intershop.sellside.rest.common.capi.resource.order.OrderResource,com.intershop.sellside.rest.common.capi.resource.order.OrderResource,com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.OrderCostObjectAssignmentItemResource,com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.OrderCostObjectAssignmentItemResource"