PurchaseOrderInterfaceStatusUpdate (POST)

Overview

This API endpoint processes an order asynchronously. It accepts a JSON payload containing details about the order, including the document number, line of business, status, error messages, ERP number, subtype, and line information. The endpoint is designed to handle order processing requests and return the results asynchronously.

URL: https://{APIBaseUrl}/leo-order-domaingateway-api/api/v2/Order/processAsync

Request
{
    "documentNumber": "string",
    "lob": "string",
    "status": "string",
    "errorMessage": "string",
    "erpNumber": "string",
    "subType": "string",
    "lineInfo": [
        {
            "lineNumber": "string",
            "status": "string",
            "scheduleInfo": [
                {
                    "scheduleNumber": "string",
                    "status": "string"
                }
            ]
        }
    ]
}'
Response
{
    "exception": object,
    "data": object,
    "hasData": boolean,
    "hasException": boolean,
}
Data Elements

Request Body

 

Property

Required?

Data type

Description

Validations / Exceptions

documentNumber

 

 string

Unique identifier for the document.

 

lob

 

 string

Line of business associated with the document.

 

status

 

 string

Current status of the document.

 

errorMessage

 

 string

Error message if any issues occurred.

 

erpNumber

 

 string

ERP system number associated with the document.

 

subType

 

 string

Subtype of the document.

 

 

 

lineInfo

 

Property

Required?

Data type

Description

Validations / Exceptions

lineNumber

 

 string

Line number within the document.

 

status

 

 string

Status of the line item.

 

 

scheduleInfo

 

Property

Required?

Data type

Description

Validations / Exceptions

scheduleNumber

 

 string

Schedule number within the line item.

 

status

 

 string

Status of the schedule

 

 

 

Request Headers

 

Property

Required?

Data type

Description

Validations / Exceptions

Authorization

 

string

Contains the Bearer token for authentication.

 

Content-Type

 

string

Indicates the media type of the response being sent to the server.

 

subtypeAppId

 

string

A unique identifier for the subtype application

 

event

 

string

Represents the command

 

 

 

Response Body

 

Property

Required?

Data type

Description

Validations / Exceptions

exception

 

object

Error details if any

 

data

 

object

Data returned by API

 

hasData

 

boolean

Flag indicating whether response has data

 

hasException

 

boolean

Flag indicating whether response has exception