2Service Services API

<back to all web services

GetShipment

// @ts-nocheck

export class AuthenticatedRequest
{
    /** @description Session token received from successful authentication. */
    // @ApiMember(Description="Session token received from successful authentication.", IsRequired=true, ParameterType="query")
    public SessionToken: string;

    public constructor(init?: Partial<AuthenticatedRequest>) { (Object as any).assign(this, init); }
}

export class ShipmentArticleResult
{
    /** @description Order number. */
    // @ApiMember(Description="Order number.")
    public OrderNumber?: string;

    /** @description Article number. */
    // @ApiMember(Description="Article number.")
    public ArticleNumber?: string;

    /** @description Quantity. */
    // @ApiMember(Description="Quantity.")
    public Quantity: number;

    /** @description Custom reference. */
    // @ApiMember(Description="Custom reference.")
    public CustomReference?: string;

    public constructor(init?: Partial<ShipmentArticleResult>) { (Object as any).assign(this, init); }
}

export class ShipmentPackageResult
{
    /** @description Shipment method. */
    // @ApiMember(Description="Shipment method.")
    public ShipmentMethod?: string;

    /** @description Tracking number. */
    // @ApiMember(Description="Tracking number.")
    public TrackingNumber?: string;

    /** @description Tracking URL. */
    // @ApiMember(Description="Tracking URL.")
    public TrackingUrl?: string;

    public constructor(init?: Partial<ShipmentPackageResult>) { (Object as any).assign(this, init); }
}

export class ShipmentResult
{
    /** @description ID of the shipment. */
    // @ApiMember(Description="ID of the shipment.")
    public ShipmentId: number;

    /** @description Determines of the shipment has been dispatched. */
    // @ApiMember(Description="Determines of the shipment has been dispatched.")
    public HasBeenDispatched: boolean;

    /** @description Date/time of dispatch. */
    // @ApiMember(Description="Date/time of dispatch.")
    public DispatchDate?: string;

    /** @description List of articles in shipment. */
    // @ApiMember(Description="List of articles in shipment.")
    public Articles?: ShipmentArticleResult[];

    /** @description List of packages for shipment. */
    // @ApiMember(Description="List of packages for shipment.")
    public Packages?: ShipmentPackageResult[];

    public constructor(init?: Partial<ShipmentResult>) { (Object as any).assign(this, init); }
}

export class OperationResult
{
    /** @description Specifies if the operation was successful. */
    // @ApiMember(Description="Specifies if the operation was successful.", ParameterType="model")
    public IsSuccessful: boolean;

    /** @description States error message in case of unsuccessful operation. */
    // @ApiMember(Description="States error message in case of unsuccessful operation.", ParameterType="model")
    public ErrorMessage?: string;

    public constructor(init?: Partial<OperationResult>) { (Object as any).assign(this, init); }
}

export class PartInfoResultImage
{
    /** @description Image number */
    // @ApiMember(Description="Image number")
    public ImageNumber: number;

    /** @description Image URL */
    // @ApiMember(Description="Image URL")
    public ImageUrl?: string;

    public constructor(init?: Partial<PartInfoResultImage>) { (Object as any).assign(this, init); }
}

export class PartStockQuantity
{
    /** @description Location ID */
    // @ApiMember(Description="Location ID")
    public LocationId: number;

    /** @description Location code */
    // @ApiMember(Description="Location code")
    public LocationCode?: string;

    /** @description Stock quantity in location */
    // @ApiMember(Description="Stock quantity in location")
    public StockQuantity: number;

    public constructor(init?: Partial<PartStockQuantity>) { (Object as any).assign(this, init); }
}

export class PartInfoResult
{
    /** @description Unique ID for the part. */
    // @ApiMember(Description="Unique ID for the part.")
    public Id: number;

    /** @description Part number. */
    // @ApiMember(Description="Part number.")
    public PartNumber?: string;

    /** @description Description of the part. */
    // @ApiMember(Description="Description of the part.")
    public Description?: string;

    /** @description Part manufacturer. */
    // @ApiMember(Description="Part manufacturer.")
    public Manufacturer?: string;

    /** @description Determines if the part can be ordered. */
    // @ApiMember(Description="Determines if the part can be ordered.")
    public CanBeOrdered: boolean;

    /** @description Textual representation of the status of the part. */
    // @ApiMember(Description="Textual representation of the status of the part.")
    public StatusText?: string;

    /** @description Available stock to order. */
    // @ApiMember(Description="Available stock to order.")
    public AvailableStockQuantity: number;

    /** @description Average days needed for delivery. */
    // @ApiMember(Description="Average days needed for delivery.")
    public AverageDeliveryInDays?: number;

    /** @description Price of a single unit, excluding VAT. */
    // @ApiMember(Description="Price of a single unit, excluding VAT.")
    public UnitPrice?: number;

    /** @description EAN number. */
    // @ApiMember(Description="EAN number.")
    public EanNumber?: string;

    /** @description Images */
    // @ApiMember(Description="Images")
    public Images?: PartInfoResultImage[];

    /** @description Secondary article numbers */
    // @ApiMember(Description="Secondary article numbers")
    public SecondaryArticleNumbers?: string[];

    /** @description Replacement article numbers */
    // @ApiMember(Description="Replacement article numbers")
    public ReplacementArticleNumbers?: string[];

    /** @description Stock quantities */
    // @ApiMember(Description="Stock quantities")
    public StockQuantities?: PartStockQuantity[];

    public constructor(init?: Partial<PartInfoResult>) { (Object as any).assign(this, init); }
}

export class PartResults
{
    /** @description Total number of parts available. */
    // @ApiMember(Description="Total number of parts available.")
    public TotalNumberOfParts: number;

    /** @description Indication if there are more parts to retrieve. */
    // @ApiMember(Description="Indication if there are more parts to retrieve.")
    public HasMoreRecords: boolean;

    /** @description Part records. */
    // @ApiMember(Description="Part records.")
    public Parts?: PartInfoResult[];

    public constructor(init?: Partial<PartResults>) { (Object as any).assign(this, init); }
}

export class OperationResult_1<T> extends OperationResult
{
    /** @description Result value */
    // @ApiMember(Description="Result value", ParameterType="model")
    public Result?: PartResults;

    public constructor(init?: Partial<OperationResult_1<T>>) { super(init); (Object as any).assign(this, init); }
}

export class ShipmentResponse extends OperationResult_1<ShipmentResult>
{

    public constructor(init?: Partial<ShipmentResponse>) { super(init); (Object as any).assign(this, init); }
}

export class GetShipment extends AuthenticatedRequest
{
    /** @description Shipment ID to retrieve the status for. */
    // @ApiMember(Description="Shipment ID to retrieve the status for.", IsRequired=true, ParameterType="path")
    public ShipmentId: number;

    public constructor(init?: Partial<GetShipment>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetShipment DTOs

GET /dealers/shipment/{ShipmentId} HTTP/1.1 
Host: services.acct.2service.nl 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ShipmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/_2Service.Webservices.ServiceModel.Dealers">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/_2Service.Webservices.ServiceModel">String</ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/_2Service.Webservices.ServiceModel">false</IsSuccessful>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/_2Service.Webservices.ServiceModel.Dealers" xmlns="http://schemas.datacontract.org/2004/07/_2Service.Webservices.ServiceModel">
    <d2p1:Articles>
      <d2p1:ShipmentArticleResult>
        <d2p1:ArticleNumber>String</d2p1:ArticleNumber>
        <d2p1:CustomReference>String</d2p1:CustomReference>
        <d2p1:OrderNumber>String</d2p1:OrderNumber>
        <d2p1:Quantity>0</d2p1:Quantity>
      </d2p1:ShipmentArticleResult>
    </d2p1:Articles>
    <d2p1:DispatchDate>0001-01-01T00:00:00</d2p1:DispatchDate>
    <d2p1:HasBeenDispatched>false</d2p1:HasBeenDispatched>
    <d2p1:Packages>
      <d2p1:ShipmentPackageResult>
        <d2p1:ShipmentMethod>String</d2p1:ShipmentMethod>
        <d2p1:TrackingNumber>String</d2p1:TrackingNumber>
        <d2p1:TrackingUrl>String</d2p1:TrackingUrl>
      </d2p1:ShipmentPackageResult>
    </d2p1:Packages>
    <d2p1:ShipmentId>0</d2p1:ShipmentId>
  </Result>
</ShipmentResponse>