POST v1/api/Standard/Asn

Processes ASN requests from a Brand to EShopWorld.

Request Information

URI Parameters

None.

Body Parameters

A object containing ASN request details.

esw.Common.Model.Published.ASN.AsnRequest

Name	Description	Type	Additional information
Header	ASN details containing controlling parameters for the request. Required: Yes	esw.Common.Model.Published.ASN.AsnRequestHeader	None.
Packages	A list of packages contained within the ASN request.	Collection of esw.Common.Model.Published.ASN.AsnPackage	None.

Request Formats

application/json, text/json

Sample:

{
  "Header": {
    "BrandCode": "sample string 1",
    "BrandWarehouse": "sample string 2"
  },
  "Packages": [
    {
      "OrderNumber": "sample string 1",
      "PackageId": "sample string 2",
      "AsnPackageStatus": "New",
      "Weight": 4.1,
      "WeightUnit": "Lb",
      "GoodsDescription": "sample string 6",
      "ServiceLevel": "sample string 7",
      "IsOrderPackageEddu": "True",
      "TrackingNumber": "sample string 9",
      "Customer": {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Gender": "Unknown",
        "Email": "sample string 4",
        "Telephone": "sample string 5",
        "Address1": "sample string 6",
        "Address2": "sample string 7",
        "City": "sample string 8",
        "Country": "sample string 9",
        "POBox": "sample string 10",
        "PostalCode": "sample string 11",
        "Region": "sample string 12",
        "Unit": "sample string 13"
      },
      "Items": [
        null,
        {
          "ProductCode": "sample string 1",
          "OrderItemLineId": 2,
          "Quantity": null,
          "CountryOfOrigin": null,
          "Weight": 0.0,
          "WeightUnit": null,
          "UnitPrice": null,
          "EdduPackageItemDetails": {
            "ProductDescription": null,
            "ProductCustomsDescription": null,
            "Currency": null,
            "HsCode": null
          }
        }
      ],
      "CarrierPackageReference": "sample string 11",
      "DimHeight": 12.0,
      "OriginWarehouse": "sample string 16",
      "DimWidth": 13.0,
      "DimLength": 14.0,
      "DimUnit": "sample string 15"
    },
    {
      "OrderNumber": "sample string 1",
      "PackageId": "sample string 2",
      "AsnPackageStatus": "New",
      "Weight": 4.1,
      "WeightUnit": "Lb",
      "GoodsDescription": "sample string 6",
      "ServiceLevel": "sample string 7",
      "IsOrderPackageEddu": "True",
      "TrackingNumber": "sample string 9",
      "Customer": {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Gender": "Unknown",
        "Email": "sample string 4",
        "Telephone": "sample string 5",
        "Address1": "sample string 6",
        "Address2": "sample string 7",
        "City": "sample string 8",
        "Country": "sample string 9",
        "POBox": "sample string 10",
        "PostalCode": "sample string 11",
        "Region": "sample string 12",
        "Unit": "sample string 13"
      },
      "Items": [
        null,
        {
          "ProductCode": "sample string 1",
          "OrderItemLineId": 2,
          "Quantity": null,
          "CountryOfOrigin": null,
          "Weight": 0.0,
          "WeightUnit": null,
          "UnitPrice": null,
          "EdduPackageItemDetails": {
            "ProductDescription": null,
            "ProductCustomsDescription": null,
            "Currency": null,
            "HsCode": null
          }
        }
      ],
      "CarrierPackageReference": "sample string 11",
      "DimHeight": 12.0,
      "OriginWarehouse": "sample string 16",
      "DimWidth": 13.0,
      "DimLength": 14.0,
      "DimUnit": "sample string 15"
    }
  ]
}

application/xml, text/xml

Sample:

<AsnRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">
  <Header>
    <BrandCode>sample string 1</BrandCode>
    <BrandWarehouse>sample string 2</BrandWarehouse>
  </Header>
  <Packages>
    <AsnPackage>
      <OrderNumber>sample string 1</OrderNumber>
      <PackageId>sample string 2</PackageId>
      <AsnPackageStatus>New</AsnPackageStatus>
      <Weight>4.1</Weight>
      <WeightUnit>Lb</WeightUnit>
      <GoodsDescription>sample string 6</GoodsDescription>
      <ServiceLevel>sample string 7</ServiceLevel>
      <IsOrderPackageEddu>True</IsOrderPackageEddu>
      <TrackingNumber>sample string 9</TrackingNumber>
      <Customer>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
        <Gender>Unknown</Gender>
        <Email>sample string 4</Email>
        <Telephone>sample string 5</Telephone>
        <Address1>sample string 6</Address1>
        <Address2>sample string 7</Address2>
        <City>sample string 8</City>
        <Country>sample string 9</Country>
        <POBox>sample string 10</POBox>
        <PostalCode>sample string 11</PostalCode>
        <Region>sample string 12</Region>
        <Unit>sample string 13</Unit>
      </Customer>
      <Items>
        <AsnPackageItem i:nil="true" />
        <AsnPackageItem>
          <ProductCode>sample string 1</ProductCode>
          <OrderItemLineId>2</OrderItemLineId>
          <Quantity i:nil="true" />
          <CountryOfOrigin i:nil="true" />
          <Weight>0</Weight>
          <WeightUnit i:nil="true" />
          <UnitPrice i:nil="true" />
          <EdduPackageItemDetails>
            <ProductDescription i:nil="true" />
            <ProductCustomsDescription i:nil="true" />
            <Currency i:nil="true" />
            <HsCode i:nil="true" />
          </EdduPackageItemDetails>
        </AsnPackageItem>
      </Items>
      <CarrierPackageReference>sample string 11</CarrierPackageReference>
      <DimHeight>12</DimHeight>
      <OriginWarehouse>sample string 16</OriginWarehouse>
      <DimWidth>13</DimWidth>
      <DimLength>14</DimLength>
      <DimUnit>sample string 15</DimUnit>
    </AsnPackage>
    <AsnPackage>
      <OrderNumber>sample string 1</OrderNumber>
      <PackageId>sample string 2</PackageId>
      <AsnPackageStatus>New</AsnPackageStatus>
      <Weight>4.1</Weight>
      <WeightUnit>Lb</WeightUnit>
      <GoodsDescription>sample string 6</GoodsDescription>
      <ServiceLevel>sample string 7</ServiceLevel>
      <IsOrderPackageEddu>True</IsOrderPackageEddu>
      <TrackingNumber>sample string 9</TrackingNumber>
      <Customer>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
        <Gender>Unknown</Gender>
        <Email>sample string 4</Email>
        <Telephone>sample string 5</Telephone>
        <Address1>sample string 6</Address1>
        <Address2>sample string 7</Address2>
        <City>sample string 8</City>
        <Country>sample string 9</Country>
        <POBox>sample string 10</POBox>
        <PostalCode>sample string 11</PostalCode>
        <Region>sample string 12</Region>
        <Unit>sample string 13</Unit>
      </Customer>
      <Items>
        <AsnPackageItem i:nil="true" />
        <AsnPackageItem>
          <ProductCode>sample string 1</ProductCode>
          <OrderItemLineId>2</OrderItemLineId>
          <Quantity i:nil="true" />
          <CountryOfOrigin i:nil="true" />
          <Weight>0</Weight>
          <WeightUnit i:nil="true" />
          <UnitPrice i:nil="true" />
          <EdduPackageItemDetails>
            <ProductDescription i:nil="true" />
            <ProductCustomsDescription i:nil="true" />
            <Currency i:nil="true" />
            <HsCode i:nil="true" />
          </EdduPackageItemDetails>
        </AsnPackageItem>
      </Items>
      <CarrierPackageReference>sample string 11</CarrierPackageReference>
      <DimHeight>12</DimHeight>
      <OriginWarehouse>sample string 16</OriginWarehouse>
      <DimWidth>13</DimWidth>
      <DimLength>14</DimLength>
      <DimUnit>sample string 15</DimUnit>
    </AsnPackage>
  </Packages>
</AsnRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'esw.Common.Model.Published.ASN.AsnRequest'.

Response Information

Resource Description

An object containing the response object.

esw.Common.Model.Published.ASN.AsnResponse

Name	Description	Type	Additional information
Status	The overall response status for the processed ASN request. SeeAlso: StatusMessages	esw.Common.Model.Published.ASN.ValidationMessages+AsnResponseStatus	None.
StatusMessages	A list of descriptive messages describing any non successful Status. Note: Empty if Status = Success SeeAlso: Status.	Collection of string	None.
Packages	A list containing a Package response for every package in the asscoiated ASN request.	Collection of esw.Common.Model.Published.ASN.AsnPackageResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": 0,
  "StatusMessages": [
    "sample string 1",
    "sample string 2"
  ],
  "Packages": [
    {
      "PackageId": "sample string 1",
      "eShopWorldPackageReference": "sample string 2",
      "Status": 0,
      "StatusMessages": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "PackageId": "sample string 1",
      "eShopWorldPackageReference": "sample string 2",
      "Status": 0,
      "StatusMessages": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<AsnResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">
  <Packages>
    <AsnPackageResponse>
      <PackageId>sample string 1</PackageId>
      <Status>Success</Status>
      <StatusMessages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </StatusMessages>
      <eShopWorldPackageReference>sample string 2</eShopWorldPackageReference>
    </AsnPackageResponse>
    <AsnPackageResponse>
      <PackageId>sample string 1</PackageId>
      <Status>Success</Status>
      <StatusMessages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </StatusMessages>
      <eShopWorldPackageReference>sample string 2</eShopWorldPackageReference>
    </AsnPackageResponse>
  </Packages>
  <Status>Success</Status>
  <StatusMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </StatusMessages>
</AsnResponse>