Trendsic Platform Service

<back to all web services

ContainersRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/warehouse/containers
"use strict";
export class ContainerItemDto {
    /** @param {{Id?:string,Name?:string,Flag?:string,Warn?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Name;
    /** @type {string} */
    Flag;
    /** @type {boolean} */
    Warn;
}
export class RecordContainerDto {
    /** @param {{ContainerId?:number,Barcode?:string,Kind?:string,Icon?:string,Name?:string,ZoneKey?:string,Slot?:string,Status?:string,CheckoutJson?:string,Items?:ContainerItemDto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ContainerId;
    /** @type {string} */
    Barcode;
    /** @type {string} */
    Kind;
    /** @type {string} */
    Icon;
    /** @type {string} */
    Name;
    /** @type {string} */
    ZoneKey;
    /** @type {string} */
    Slot;
    /** @type {string} */
    Status;
    /** @type {string} */
    CheckoutJson;
    /** @type {ContainerItemDto[]} */
    Items = [];
}
export class ContainersResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Containers?:RecordContainerDto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {RecordContainerDto[]} */
    Containers = [];
}
export class ContainersRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript ContainersRequest 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.

GET /v1/records/warehouse/containers HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Containers":[{"ContainerId":0,"Barcode":"String","Kind":"String","Icon":"String","Name":"String","ZoneKey":"String","Slot":"String","Status":"String","CheckoutJson":"String","Items":[{"Id":"String","Name":"String","Flag":"String","Warn":false}]}]}