Get order status

GET

/order/batch/{batchId}

OrderBatch

Purpose and usage

This method returns the processing status of the order.

To successfully call this method, you must use the batchId obtained from the Location header in the response to the POST order/batch request.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/order/batch/' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;'

Response Example

200 - Example 1

{
  "items": [
    {
      "referenceId": "string",
      "importState": "Accepted",
      "errorMessage": "string",
      "errorCode": "string"
    }
  ]
}

Request

Path Params

batchId

string <uuid>

required

The batch id

Header Params

Accept-Language

string

optional

Language specification, default language: cs-CZ

X-Correlation-ID

string

optional

Correlation Id of request

X-LogLevel

enum<string>

optional

The forced log level

Allowed values:

TraceDebugInformationWarningErrorCritical

Responses

🟢200OK

application/json

Success

Headers

X-Correlation-ID

string

optional

Correlation Id of request otherwise id of response

Body

Order batch result model

items

array[object (Eps.Api.MyApi2.Web.Models.OrderBatch.OrderResultItemModel) {4}] | null

optional

Items

referenceId

string

required

Reference id

>= 1 characters<= 50 characters

importState

enum<string>

required

Allowed values:

AcceptedInProcessCompleteError

errorMessage

string | null

optional

Error message

errorCode

string | null

optional

Error code

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

🔴503Service Unavailable

Modified at 2025-02-07 13:55:16

Create an order

Order cancel

Get order status

Purpose and usage#

Request

Responses

Purpose and usage