| 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. |
|---|
"use strict";
export class ValidateBackOrderBulkStatusAllocationsRequest {
constructor(init) { Object.assign(this, init) }
}
export class BackOrderStatusAllocation {
/** @param {{Row?:number,BackOrderReference?:string,Status?:string,Message?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Row;
/** @type {string} */
BackOrderReference;
/** @type {string} */
Status;
/** @type {string} */
Message;
}
export class InvalidBackOrderStatusAllocation extends BackOrderStatusAllocation {
/** @param {{ValidationMessage?:string,Row?:number,BackOrderReference?:string,Status?:string,Message?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
ValidationMessage;
}
export class BackOrderBulkStatusAllocation {
/** @param {{TotalBackOrders?:number,ValidBackOrders?:number,InvalidBackOrders?:number,Valid?:BackOrderStatusAllocation[],Invalid?:InvalidBackOrderStatusAllocation[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
TotalBackOrders;
/** @type {number} */
ValidBackOrders;
/** @type {number} */
InvalidBackOrders;
/** @type {BackOrderStatusAllocation[]} */
Valid = [];
/** @type {InvalidBackOrderStatusAllocation[]} */
Invalid = [];
}
export class BackOrderBulkStatusAllocationsResponse {
/** @param {{Message?:string,BackOrders?:BackOrderBulkStatusAllocation,Successful?:boolean,Filename?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Message;
/** @type {BackOrderBulkStatusAllocation} */
BackOrders;
/** @type {boolean} */
Successful;
/** @type {string} */
Filename;
}
JavaScript 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
}