| POST | /v1/BackOrderLinkedComms | Get the audit for back orders linked comms | Get the audit for back orders linked comms |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GssnIds | body | List<string> | No | |
| DateCriteria | body | BackOrderLinkedCommsAuditDateCriteria | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| From | form | DateTime? | No | |
| To | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Audits | form | List<BackOrderLinkedCommsAudit> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | string | Yes | |
| BackOrderReference | form | string | Yes | |
| UserId | form | string | Yes | |
| Showroom | form | string | Yes | |
| CommLinked | form | string | Yes | |
| SalesDescription | form | string | Yes | |
| Colour | form | string | Yes | |
| Upholstery | form | string | Yes | |
| Sellable | form | bool | No | |
| LinkedDate | form | string | Yes | |
| Status | form | BackOrderStatus | No |
| Name | Value | |
|---|---|---|
| Submitted | 1 | |
| Acknowledged | 2 | |
| Cancelled | 3 | |
| Completed | 4 | |
| Confirmed | 5 |
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/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
}
]
}