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
"use strict";
export class BackOrderLinkedCommsAuditDateCriteria {
    /** @param {{From?:string,To?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    From;
    /** @type {?string} */
    To;
}
export class LinkedBackOrderCommAudit {
    /** @param {{GssnIds?:string[],DateCriteria?:BackOrderLinkedCommsAuditDateCriteria}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string[]} */
    GssnIds;
    /** @type {?BackOrderLinkedCommsAuditDateCriteria} */
    DateCriteria;
}
/** @typedef {number} */
export var BackOrderStatus;
(function (BackOrderStatus) {
    BackOrderStatus[BackOrderStatus["Submitted"] = 1] = "Submitted"
    BackOrderStatus[BackOrderStatus["Acknowledged"] = 2] = "Acknowledged"
    BackOrderStatus[BackOrderStatus["Cancelled"] = 3] = "Cancelled"
    BackOrderStatus[BackOrderStatus["Completed"] = 4] = "Completed"
    BackOrderStatus[BackOrderStatus["Confirmed"] = 5] = "Confirmed"
})(BackOrderStatus || (BackOrderStatus = {}));
export class BackOrderLinkedCommsAudit {
    /** @param {{Guid?:string,BackOrderReference?:string,UserId?:string,Showroom?:string,CommLinked?:string,SalesDescription?:string,Colour?:string,Upholstery?:string,Sellable?:boolean,LinkedDate?:string,Status?:BackOrderStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    BackOrderReference;
    /** @type {string} */
    UserId;
    /** @type {string} */
    Showroom;
    /** @type {string} */
    CommLinked;
    /** @type {string} */
    SalesDescription;
    /** @type {string} */
    Colour;
    /** @type {string} */
    Upholstery;
    /** @type {boolean} */
    Sellable;
    /** @type {string} */
    LinkedDate;
    /** @type {BackOrderStatus} */
    Status;
}
export class LinkedBackOrderCommAuditResponse {
    /** @param {{Audits?:BackOrderLinkedCommsAudit[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BackOrderLinkedCommsAudit[]} */
    Audits = [];
}

JavaScript LinkedBackOrderCommAudit DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"GssnIds":["String"],"DateCriteria":{"From":"\/Date(-62135596800000-0000)\/","To":"\/Date(-62135596800000-0000)\/"}}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}]}