POST api/OmsInboundAsn

API endpoint to submit a single ASN

Request Information

URI Parameters

None.

Body Parameters

Complex object representation of ASN

Name	Type	Additional Information
CustomerPoRef	string	None.
ShipmentNumber	integer	None.
InternalSalesNumber	string	None.
OrderTransactionIdentifier	integer	None.
PONumber	string	None.
InvoiceNumber	string	None.
InvoiceNumberType	InvoiceNumberTypes	None.
ShipDate	date	None.
CarrierCode	string	None.
ExpectedDeliveryDate	date	None.
Items	Collection of ASNInputItem	None.
ShippingTax	Collection of ASNTaxItem	None.
SiteCode	string	None.
VerificationKey	string	None.
TimestampUTC	string	None.
ResponseCallbackUri	string	None.
APIUsername	string	None.
IDToken	string	None.
UserAccount	Account	None.
UserdID	integer	None.
IsValidJwtToken	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerPoRef": "sample string 1",
  "ShipmentNumber": 2,
  "InternalSalesNumber": "sample string 3",
  "OrderTransactionIdentifier": 4,
  "PONumber": "sample string 5",
  "InvoiceNumber": "sample string 6",
  "InvoiceNumberType": 1,
  "ShipDate": "2025-12-20T19:59:01.6188471+00:00",
  "CarrierCode": "sample string 8",
  "ExpectedDeliveryDate": "2025-12-20T19:59:01.6188471+00:00",
  "Items": [
    {
      "GTIN": "sample string 1",
      "SKU": "sample string 2",
      "Id": 3,
      "UnitsShipped": 4,
      "TrackingNumber": "sample string 5",
      "MultipleTrackingNumbers": [
        {
          "TrackingNumber": "sample string 1",
          "Quantity": 2
        },
        {
          "TrackingNumber": "sample string 1",
          "Quantity": 2
        }
      ],
      "Custom1": "sample string 6",
      "Custom2": "sample string 7",
      "Custom3": "sample string 8",
      "Custom4": "sample string 9",
      "Custom5": "sample string 10",
      "Extended": [
        {
          "ID": 2,
          "Key": "sample string 3",
          "Value": "sample string 4",
          "Additional": "sample string 5",
          "ReadOnly": true
        },
        {
          "ID": 2,
          "Key": "sample string 3",
          "Value": "sample string 4",
          "Additional": "sample string 5",
          "ReadOnly": true
        }
      ],
      "ExternalItemId": "sample string 11",
      "Tax": [
        {
          "TaxType": 1,
          "Amount": 1.0
        },
        {
          "TaxType": 1,
          "Amount": 1.0
        }
      ],
      "GiftCards": [
        {
          "GiftCardNumber": "sample string 1",
          "GiftCardPinNumber": "sample string 2",
          "Amount": 3.0,
          "Applied": true,
          "GiftCardCode": "sample string 5"
        },
        {
          "GiftCardNumber": "sample string 1",
          "GiftCardPinNumber": "sample string 2",
          "Amount": 3.0,
          "Applied": true,
          "GiftCardCode": "sample string 5"
        }
      ],
      "EstimatedDeliveryDateUTC": "2025-12-20T19:59:01.6188471+00:00",
      "EndEstimatedDeliveryDateUTC": "2025-12-20T19:59:01.6188471+00:00"
    },
    {
      "GTIN": "sample string 1",
      "SKU": "sample string 2",
      "Id": 3,
      "UnitsShipped": 4,
      "TrackingNumber": "sample string 5",
      "MultipleTrackingNumbers": [
        {
          "TrackingNumber": "sample string 1",
          "Quantity": 2
        },
        {
          "TrackingNumber": "sample string 1",
          "Quantity": 2
        }
      ],
      "Custom1": "sample string 6",
      "Custom2": "sample string 7",
      "Custom3": "sample string 8",
      "Custom4": "sample string 9",
      "Custom5": "sample string 10",
      "Extended": [
        {
          "ID": 2,
          "Key": "sample string 3",
          "Value": "sample string 4",
          "Additional": "sample string 5",
          "ReadOnly": true
        },
        {
          "ID": 2,
          "Key": "sample string 3",
          "Value": "sample string 4",
          "Additional": "sample string 5",
          "ReadOnly": true
        }
      ],
      "ExternalItemId": "sample string 11",
      "Tax": [
        {
          "TaxType": 1,
          "Amount": 1.0
        },
        {
          "TaxType": 1,
          "Amount": 1.0
        }
      ],
      "GiftCards": [
        {
          "GiftCardNumber": "sample string 1",
          "GiftCardPinNumber": "sample string 2",
          "Amount": 3.0,
          "Applied": true,
          "GiftCardCode": "sample string 5"
        },
        {
          "GiftCardNumber": "sample string 1",
          "GiftCardPinNumber": "sample string 2",
          "Amount": 3.0,
          "Applied": true,
          "GiftCardCode": "sample string 5"
        }
      ],
      "EstimatedDeliveryDateUTC": "2025-12-20T19:59:01.6188471+00:00",
      "EndEstimatedDeliveryDateUTC": "2025-12-20T19:59:01.6188471+00:00"
    }
  ],
  "ShippingTax": [
    {
      "TaxType": 1,
      "Amount": 1.0
    },
    {
      "TaxType": 1,
      "Amount": 1.0
    }
  ],
  "SiteCode": "sample string 9",
  "VerificationKey": "sample string 10",
  "TimestampUTC": "sample string 11",
  "ResponseCallbackUri": "sample string 12",
  "APIUsername": "sample string 13",
  "IDToken": "sample string 14",
  "UserAccount": {
    "UserID": 1,
    "Username": "sample string 2",
    "CreateDate": "2025-12-20T19:59:01.6188471+00:00",
    "ConfirmationToken": "sample string 4",
    "IsConfirmed": true,
    "LastPasswordFailureDate": "2025-12-20T19:59:01.6188471+00:00",
    "PasswordFailuresSinceLastSuccess": 7,
    "Password": "sample string 8",
    "PasswordChangedDate": "2025-12-20T19:59:01.6188471+00:00",
    "PasswordSalt": "sample string 10",
    "PasswordVerificationToken": "sample string 11",
    "PasswordVerificationTokenExpirationDate": "2025-12-20T19:59:01.6188471+00:00",
    "SecurityQuestion": "sample string 13",
    "SecurityAnswer": "sample string 14",
    "SecurityFailuresSinceLastSuccess": 15,
    "LastSecurityFailureDate": "2025-12-20T19:59:01.6188471+00:00",
    "IsAuthorized": true,
    "IsArchived": true,
    "LoginToken": "sample string 19",
    "LoginTokenExpirationDate": "2025-12-20T19:59:01.6188471+00:00",
    "ApiKey": "sample string 21",
    "FederatedID": "sample string 22",
    "FirstName": "sample string 23",
    "LastName": "sample string 24",
    "FullName": "sample string 23sample string 24"
  },
  "UserdID": 15,
  "IsValidJwtToken": true
}

application/xml, text/xml

Sample:

<InboundASNInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <APIUsername xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 13</APIUsername>
  <IDToken xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 14</IDToken>
  <IsValidJwtToken xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">true</IsValidJwtToken>
  <ResponseCallbackUri xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 12</ResponseCallbackUri>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 9</SiteCode>
  <TimestampUTC xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 11</TimestampUTC>
  <UserAccount xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.Core.Domain.Membership.Models" xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">
    <d2p1:ApiKey>sample string 21</d2p1:ApiKey>
    <d2p1:ConfirmationToken>sample string 4</d2p1:ConfirmationToken>
    <d2p1:CreateDate>2025-12-20T19:59:01.6188471+00:00</d2p1:CreateDate>
    <d2p1:FederatedID>sample string 22</d2p1:FederatedID>
    <d2p1:FirstName>sample string 23</d2p1:FirstName>
    <d2p1:IsArchived>true</d2p1:IsArchived>
    <d2p1:IsAuthorized>true</d2p1:IsAuthorized>
    <d2p1:IsConfirmed>true</d2p1:IsConfirmed>
    <d2p1:LastName>sample string 24</d2p1:LastName>
    <d2p1:LastPasswordFailureDate>2025-12-20T19:59:01.6188471+00:00</d2p1:LastPasswordFailureDate>
    <d2p1:LastSecurityFailureDate>2025-12-20T19:59:01.6188471+00:00</d2p1:LastSecurityFailureDate>
    <d2p1:LoginToken>sample string 19</d2p1:LoginToken>
    <d2p1:LoginTokenExpirationDate>2025-12-20T19:59:01.6188471+00:00</d2p1:LoginTokenExpirationDate>
    <d2p1:Password>sample string 8</d2p1:Password>
    <d2p1:PasswordChangedDate>2025-12-20T19:59:01.6188471+00:00</d2p1:PasswordChangedDate>
    <d2p1:PasswordFailuresSinceLastSuccess>7</d2p1:PasswordFailuresSinceLastSuccess>
    <d2p1:PasswordSalt>sample string 10</d2p1:PasswordSalt>
    <d2p1:PasswordVerificationToken>sample string 11</d2p1:PasswordVerificationToken>
    <d2p1:PasswordVerificationTokenExpirationDate>2025-12-20T19:59:01.6188471+00:00</d2p1:PasswordVerificationTokenExpirationDate>
    <d2p1:SecurityAnswer>sample string 14</d2p1:SecurityAnswer>
    <d2p1:SecurityFailuresSinceLastSuccess>15</d2p1:SecurityFailuresSinceLastSuccess>
    <d2p1:SecurityQuestion>sample string 13</d2p1:SecurityQuestion>
    <d2p1:UserID>1</d2p1:UserID>
    <d2p1:Username>sample string 2</d2p1:Username>
  </UserAccount>
  <UserdID xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">15</UserdID>
  <VerificationKey xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 10</VerificationKey>
  <CarrierCode>sample string 8</CarrierCode>
  <CustomerPoRef>sample string 1</CustomerPoRef>
  <ExpectedDeliveryDate>2025-12-20T19:59:01.6188471+00:00</ExpectedDeliveryDate>
  <InternalSalesNumber>sample string 3</InternalSalesNumber>
  <InvoiceNumber>sample string 6</InvoiceNumber>
  <InvoiceNumberType>Shipment</InvoiceNumberType>
  <Items>
    <ASNInputItem>
      <Custom1>sample string 6</Custom1>
      <Custom2>sample string 7</Custom2>
      <Custom3>sample string 8</Custom3>
      <Custom4>sample string 9</Custom4>
      <Custom5>sample string 10</Custom5>
      <EndEstimatedDeliveryDateUTC>2025-12-20T19:59:01.6188471+00:00</EndEstimatedDeliveryDateUTC>
      <EstimatedDeliveryDateUTC>2025-12-20T19:59:01.6188471+00:00</EstimatedDeliveryDateUTC>
      <Extended xmlns:d4p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
        <d4p1:Extended>
          <d4p1:Additional>sample string 5</d4p1:Additional>
          <d4p1:ID>2</d4p1:ID>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:ReadOnly>true</d4p1:ReadOnly>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:Extended>
        <d4p1:Extended>
          <d4p1:Additional>sample string 5</d4p1:Additional>
          <d4p1:ID>2</d4p1:ID>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:ReadOnly>true</d4p1:ReadOnly>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:Extended>
      </Extended>
      <ExternalItemId>sample string 11</ExternalItemId>
      <GTIN>sample string 1</GTIN>
      <GiftCards>
        <ASNGiftCard>
          <Amount>3</Amount>
          <Applied>true</Applied>
          <GiftCardCode>sample string 5</GiftCardCode>
          <GiftCardNumber>sample string 1</GiftCardNumber>
          <GiftCardPinNumber>sample string 2</GiftCardPinNumber>
        </ASNGiftCard>
        <ASNGiftCard>
          <Amount>3</Amount>
          <Applied>true</Applied>
          <GiftCardCode>sample string 5</GiftCardCode>
          <GiftCardNumber>sample string 1</GiftCardNumber>
          <GiftCardPinNumber>sample string 2</GiftCardPinNumber>
        </ASNGiftCard>
      </GiftCards>
      <Id>3</Id>
      <MultipleTrackingNumbers>
        <MultipleTrackingNumber>
          <Quantity>2</Quantity>
          <TrackingNumber>sample string 1</TrackingNumber>
        </MultipleTrackingNumber>
        <MultipleTrackingNumber>
          <Quantity>2</Quantity>
          <TrackingNumber>sample string 1</TrackingNumber>
        </MultipleTrackingNumber>
      </MultipleTrackingNumbers>
      <SKU>sample string 2</SKU>
      <Tax>
        <ASNTaxItem>
          <Amount>1</Amount>
          <TaxType>USSalesTotal</TaxType>
        </ASNTaxItem>
        <ASNTaxItem>
          <Amount>1</Amount>
          <TaxType>USSalesTotal</TaxType>
        </ASNTaxItem>
      </Tax>
      <TrackingNumber>sample string 5</TrackingNumber>
      <UnitsShipped>4</UnitsShipped>
    </ASNInputItem>
    <ASNInputItem>
      <Custom1>sample string 6</Custom1>
      <Custom2>sample string 7</Custom2>
      <Custom3>sample string 8</Custom3>
      <Custom4>sample string 9</Custom4>
      <Custom5>sample string 10</Custom5>
      <EndEstimatedDeliveryDateUTC>2025-12-20T19:59:01.6188471+00:00</EndEstimatedDeliveryDateUTC>
      <EstimatedDeliveryDateUTC>2025-12-20T19:59:01.6188471+00:00</EstimatedDeliveryDateUTC>
      <Extended xmlns:d4p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
        <d4p1:Extended>
          <d4p1:Additional>sample string 5</d4p1:Additional>
          <d4p1:ID>2</d4p1:ID>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:ReadOnly>true</d4p1:ReadOnly>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:Extended>
        <d4p1:Extended>
          <d4p1:Additional>sample string 5</d4p1:Additional>
          <d4p1:ID>2</d4p1:ID>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:ReadOnly>true</d4p1:ReadOnly>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:Extended>
      </Extended>
      <ExternalItemId>sample string 11</ExternalItemId>
      <GTIN>sample string 1</GTIN>
      <GiftCards>
        <ASNGiftCard>
          <Amount>3</Amount>
          <Applied>true</Applied>
          <GiftCardCode>sample string 5</GiftCardCode>
          <GiftCardNumber>sample string 1</GiftCardNumber>
          <GiftCardPinNumber>sample string 2</GiftCardPinNumber>
        </ASNGiftCard>
        <ASNGiftCard>
          <Amount>3</Amount>
          <Applied>true</Applied>
          <GiftCardCode>sample string 5</GiftCardCode>
          <GiftCardNumber>sample string 1</GiftCardNumber>
          <GiftCardPinNumber>sample string 2</GiftCardPinNumber>
        </ASNGiftCard>
      </GiftCards>
      <Id>3</Id>
      <MultipleTrackingNumbers>
        <MultipleTrackingNumber>
          <Quantity>2</Quantity>
          <TrackingNumber>sample string 1</TrackingNumber>
        </MultipleTrackingNumber>
        <MultipleTrackingNumber>
          <Quantity>2</Quantity>
          <TrackingNumber>sample string 1</TrackingNumber>
        </MultipleTrackingNumber>
      </MultipleTrackingNumbers>
      <SKU>sample string 2</SKU>
      <Tax>
        <ASNTaxItem>
          <Amount>1</Amount>
          <TaxType>USSalesTotal</TaxType>
        </ASNTaxItem>
        <ASNTaxItem>
          <Amount>1</Amount>
          <TaxType>USSalesTotal</TaxType>
        </ASNTaxItem>
      </Tax>
      <TrackingNumber>sample string 5</TrackingNumber>
      <UnitsShipped>4</UnitsShipped>
    </ASNInputItem>
  </Items>
  <OrderTransactionIdentifier>4</OrderTransactionIdentifier>
  <PONumber>sample string 5</PONumber>
  <ShipDate>2025-12-20T19:59:01.6188471+00:00</ShipDate>
  <ShipmentNumber>2</ShipmentNumber>
  <ShippingTax>
    <ASNTaxItem>
      <Amount>1</Amount>
      <TaxType>USSalesTotal</TaxType>
    </ASNTaxItem>
    <ASNTaxItem>
      <Amount>1</Amount>
      <TaxType>USSalesTotal</TaxType>
    </ASNTaxItem>
  </ShippingTax>
</InboundASNInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Generic API response

GenericResponse

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
CorrelationId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample:

<GenericResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">
  <CorrelationId>sample string 2</CorrelationId>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
</GenericResponse>