IntershopIOM - 1.0 - Order State
Documentation Powered by ReDoc

IOM Order State REST API (1.0)

Download OpenAPI specification:Download

URL: http://intershop.com

The IOM Order State REST API supports the obtaining of order details and order status information.

Authentication

basicAuth

Basic Authentication

Security Scheme Type HTTP
HTTP Authorization Scheme basic

bearerAuth

JWT Bearer token

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Order State Service

Get orders states by search criteria

Obtain the order states of the orders which are matching the given search criterias

Authorizations:
basicAuthbearerAuth
query Parameters
shopId
required
integer <int64>
Example: shopId=200

The id of the IOM shop instance

orderNumber
Array of strings
Example: orderNumber=2019-17891,2019-21432

Order number as used by the shop

customerNumber
Array of strings
Example: customerNumber=CUST-930293,283102

Customer number as used by the shop

productNumber
Array of strings
Example: productNumber=100120,200230

Product number as used by the shop

orderState
Array of strings
Example: orderState=[STATE_COMMISSIONED, STATE_DISPATCHED]

Order state as used by the shop if configured, otherweise the IOM internal names of order states

orderCreationDate[gte]
string <date>
Example: orderCreationDate[gte]=

The earliest 'shop order creation date' of an order

orderCreationDate[lte]
string <date>
Example: orderCreationDate[lte]=

The latest 'shop order creation date' of an order

orderBy
string
Enum: "ORDER_ID" "ORDER_NUMBER" "CUSTOMER_NUMBER" "CREATION_DATE"
Example: orderBy=ORDER_NUMBER

The attribute on which should be sorted. 'ORDER_ID' - Sort by the id of the order. 'ORDER_NUMBER' - Sort by the shop order number. 'CUSTOMER_NUMBER' - Sort by the shop customer number. 'CREATION_DATE' - Sort by the shop order creation date.

sortDirection
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sortDirection=ASC

The sort direction the attribute should be sorted with. 'ASC' - Sort by the attribute ascending. 'DESC' - Sort by the attribute descending.

offset
integer <int32>
Default: 0
Example: offset=50

The starting row (index) of the first element to return

limit
integer <int32>
Default: 50
Example: limit=25

The number of items to return

Responses

200

OK

400

Bad Request

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

500

An unexpected error occured

get /states
{protocol}://{domain}:{port}/rest/order-state/states

Response samples

Content type
application/vnd.intershop.order-state.v1+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    },
  • "links":
    {}
}