POST api/Checkout/CreateAlternateShip

Module : Checkout; BE JIRA: ADINA-7985; This method is called for Creating alternate shipping address in checkout page.

Request Information

URI Parameters

None.

Body Parameters

ShipmentAddressRequestEntity
NameDescriptionTypeAdditional information
address1

string

None.

address2

string

None.

city

string

None.

companyName

string

None.

customerNumber

string

None.

firstName

string

None.

lastName

string

None.

id

string

None.

isNew

boolean

None.

postalCode

string

None.

uri

string

None.

country

Country

None.

state

State

None.

properties

BaseProperties

None.

Request Formats

application/json, text/json

Sample:
{
  "address1": "sample string 1",
  "address2": "sample string 2",
  "city": "sample string 3",
  "companyName": "sample string 4",
  "customerNumber": "sample string 5",
  "firstName": "sample string 6",
  "lastName": "sample string 7",
  "id": "sample string 8",
  "isNew": true,
  "postalCode": "sample string 10",
  "uri": "sample string 11",
  "country": {
    "uri": "sample string 1",
    "id": "f3feab00-77f7-4f82-b55f-8d02077bfa3d",
    "abbreviation": "sample string 3",
    "name": "sample string 4",
    "states": [
      {
        "id": "14632428-aef4-4186-a49e-26411476fa7d",
        "abbreviation": "sample string 2",
        "name": "sample string 3",
        "uri": "sample string 4"
      },
      {
        "id": "14632428-aef4-4186-a49e-26411476fa7d",
        "abbreviation": "sample string 2",
        "name": "sample string 3",
        "uri": "sample string 4"
      }
    ]
  },
  "state": {
    "id": "14632428-aef4-4186-a49e-26411476fa7d",
    "abbreviation": "sample string 2",
    "name": "sample string 3",
    "uri": "sample string 4"
  },
  "properties": {
    "nickname": "sample string 1",
    "postalcode1": "sample string 2",
    "selectasalternate": "sample string 3",
    "removeinfuture": "sample string 4",
    "dropship": "sample string 5",
    "isactive": "sample string 6"
  }
}

application/xml, text/xml

Sample:
<ShipmentAddressRequestEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Adi.BusinessEntities.Product">
  <address1>sample string 1</address1>
  <address2>sample string 2</address2>
  <city>sample string 3</city>
  <companyName>sample string 4</companyName>
  <country>
    <abbreviation>sample string 3</abbreviation>
    <id>f3feab00-77f7-4f82-b55f-8d02077bfa3d</id>
    <name>sample string 4</name>
    <states>
      <State>
        <abbreviation>sample string 2</abbreviation>
        <id>14632428-aef4-4186-a49e-26411476fa7d</id>
        <name>sample string 3</name>
        <uri>sample string 4</uri>
      </State>
      <State>
        <abbreviation>sample string 2</abbreviation>
        <id>14632428-aef4-4186-a49e-26411476fa7d</id>
        <name>sample string 3</name>
        <uri>sample string 4</uri>
      </State>
    </states>
    <uri>sample string 1</uri>
  </country>
  <customerNumber>sample string 5</customerNumber>
  <firstName>sample string 6</firstName>
  <id>sample string 8</id>
  <isNew>true</isNew>
  <lastName>sample string 7</lastName>
  <postalCode>sample string 10</postalCode>
  <properties>
    <dropship>sample string 5</dropship>
    <isactive>sample string 6</isactive>
    <nickname>sample string 1</nickname>
    <postalcode1>sample string 2</postalcode1>
    <removeinfuture>sample string 4</removeinfuture>
    <selectasalternate>sample string 3</selectasalternate>
  </properties>
  <state>
    <abbreviation>sample string 2</abbreviation>
    <id>14632428-aef4-4186-a49e-26411476fa7d</id>
    <name>sample string 3</name>
    <uri>sample string 4</uri>
  </state>
  <uri>sample string 11</uri>
</ShipmentAddressRequestEntity>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ShipmentAddressRequestEntity'.

Response Information

Resource Description

CustomActionResultOfShipmentAddressResponseEntity
NameDescriptionTypeAdditional information
StatusCode

HttpStatusCode

None.

_data

ShipmentAddressResponseEntity

None.

Response Formats

application/json, text/json

Sample:

Sample not available.