Mercedes.Agency.Orchestration.API

ValidateBackOrderBulkStatusAllocationsRequest

BackOrder

The following routes are available for this service:
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.

**BackOrderBulkStatusAllocationsResponse** Parameters:
Name	Parameter	Data Type	Required
Message	form	string	Yes
BackOrders	form	BackOrderBulkStatusAllocation	Yes
Successful	form	bool	No
Filename	form	string	Yes

**BackOrderBulkStatusAllocation** Parameters:
Name	Parameter	Data Type	Required
TotalBackOrders	form	int	No
ValidBackOrders	form	int	No
InvalidBackOrders	form	int	No
Valid	form	List<BackOrderStatusAllocation>	Yes
Invalid	form	List<InvalidBackOrderStatusAllocation>	Yes

**BackOrderStatusAllocation** Parameters:
Name	Parameter	Data Type	Required
Row	form	int	No
BackOrderReference	form	string	No
Status	form	string	No
Message	form	string	No

**InvalidBackOrderStatusAllocation** Parameters:
Name	Parameter	Data Type	Required	Description
ValidationMessage	form	string	Yes

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
}