Trade Show

Bulk create order history items

POST

/OrderHistory

Create a order history items and assign each to a bucket. Only 1000 history lines can be imported per API call.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/OrderHistory' \
--header 'Content-Type: application/json' \
--data-raw '{
    "history": [
        {
            "customerid": "CUSTOMER1",
            "productid": "FORAPI",
            "orderUnit": "CS",
            "orderTypeDescription": "Single Bucket History",
            "bucket": "SINGLE BUCKET",
            "mainNumber": 85
        }
    ]
}'

Response Example

{
    "successful": 998,
    "failed": [
        {
            "ID": "MAR",
            "Message": "A maximum of 1000 history lines is allowed per session"
        },
        {
            "ID": "APR",
            "Message": "Customer Id not found"
        }
    ]
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

history

array[object (OrderHistoryItem) {6}]

required

customerid

string

required

productid

string

required

orderUnit

string

required

orderTypeDescription

string

optional

bucket

string

required

mainNumber

integer

optional

Examples

Responses

🟢200Success

application/json

Body

successful

integer

required

Number of order history items that were successfully created

failed

array[object (IdMessage) {2}]

required

Order history items that failed to be created

string

required

The name of the bucket

Message

string

required

A message explaining why the order history item failed to be created

Modified at 2025-06-13 14:13:21

Get a list of order history buckets

Get a list of order history items