| POST | /v1/BackOrder/ValidateBulkStatusAllocations | Validates back order references and statuses provided in a csv file for allocation to active back orders. | Reads a csv file and parses a list of back order references, MBUK assistance statuses and messages for validation before allocation to active back orders. |
|---|
export class ValidateBackOrderBulkStatusAllocationsRequest
{
public constructor(init?: Partial<ValidateBackOrderBulkStatusAllocationsRequest>) { (Object as any).assign(this, init); }
}
export class BackOrderStatusAllocation
{
public Row: number;
public BackOrderReference: string;
public Status: string;
public Message: string;
public constructor(init?: Partial<BackOrderStatusAllocation>) { (Object as any).assign(this, init); }
}
export class InvalidBackOrderStatusAllocation extends BackOrderStatusAllocation
{
public ValidationMessage: string;
public constructor(init?: Partial<InvalidBackOrderStatusAllocation>) { super(init); (Object as any).assign(this, init); }
}
export class BackOrderBulkStatusAllocation
{
public TotalBackOrders: number;
public ValidBackOrders: number;
public InvalidBackOrders: number;
public Valid: BackOrderStatusAllocation[] = [];
public Invalid: InvalidBackOrderStatusAllocation[] = [];
public constructor(init?: Partial<BackOrderBulkStatusAllocation>) { (Object as any).assign(this, init); }
}
export class BackOrderBulkStatusAllocationsResponse
{
public Message: string;
public BackOrders: BackOrderBulkStatusAllocation;
public Successful: boolean;
public Filename: string;
public constructor(init?: Partial<BackOrderBulkStatusAllocationsResponse>) { (Object as any).assign(this, init); }
}
TypeScript ValidateBackOrderBulkStatusAllocationsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/BackOrder/ValidateBulkStatusAllocations HTTP/1.1
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Message: One or more errors in file,
BackOrders:
{
TotalBackOrders: 2,
ValidBackOrders: 1,
InvalidBackOrders: 1,
Valid:
[
{
Row: 0,
BackOrderReference: String,
Status: String,
Message: String
}
],
Invalid:
[
{
ValidationMessage: String,
Row: 0,
BackOrderReference: String,
Status: String,
Message: String
}
]
},
Successful: False,
Filename: String
}