Mercedes.Agency.Orchestration.API

<back to all web services

LinkedBackOrderCommAudit

Requires Authentication
The following routes are available for this service:
POST/v1/BackOrderLinkedCommsGet the audit for back orders linked comms
LinkedBackOrderCommAudit Parameters:
NameParameterData TypeRequiredDescription
GssnIdsbodyList<string>No
DateCriteriabodyBackOrderLinkedCommsAuditDateCriteriaNo
BackOrderLinkedCommsAuditDateCriteria Parameters:
NameParameterData TypeRequiredDescription
FromformDateTime?No
ToformDateTime?No
LinkedBackOrderCommAuditResponse Parameters:
NameParameterData TypeRequiredDescription
AuditsformList<BackOrderLinkedCommsAudit>Yes
BackOrderLinkedCommsAudit Parameters:
NameParameterData TypeRequiredDescription
GuidformstringYes
BackOrderReferenceformstringYes
UserIdformstringYes
ShowroomformstringYes
CommLinkedformstringYes
SalesDescriptionformstringYes
ColourformstringYes
UpholsteryformstringYes
SellableformboolNo
LinkedDateformstringYes
StatusformBackOrderStatusNo
BackOrderStatus Enum:
NameValue
Submitted1
Acknowledged2
Cancelled3
Completed4
Confirmed5

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/BackOrderLinkedComms HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	GssnIds: 
	[
		String
	],
	DateCriteria: 
	{
		From: 0001-01-01,
		To: 0001-01-01
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Audits: 
	[
		{
			Guid: String,
			BackOrderReference: String,
			UserId: String,
			Showroom: String,
			CommLinked: String,
			SalesDescription: String,
			Colour: String,
			Upholstery: String,
			Sellable: False,
			LinkedDate: String,
			Status: Submitted
		}
	]
}