PATCH api/Checkout/EditOrDeleteAlternateShip

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

Request Information

URI Parameters

None.

Body Parameters

ShipmentAddressResponseEntity

Name	Type	Additional information
uri	string	None.
id	globally unique identifier	None.
properties	AddressProperties	None.
isNew	string	None.
label	string	None.
validation	Validation	None.
customerNumber	string	None.
customerSequence	string	None.
customerName	string	None.
firstName	string	None.
lastName	string	None.
companyName	string	None.
address1	string	None.
address2	string	None.
city	string	None.
postalCode	string	None.
state	State	None.
country	Country	None.
phone	string	None.
fullAddress	string	None.
flag	string	None.
Message	string	None.
WebApiIsSuccess	boolean	None.
WebApiResponseMessage	string	None.
WebApiErrorCode	string	None.
error_description	string	None.
CookieData	Collection of AppCookie	None.

Request Formats

application/json, text/json

Sample:

{
  "uri": "sample string 1",
  "id": "3a829ece-84e6-497f-af52-e1a8b76377e3",
  "properties": {
    "isDropShip": "sample string 1",
    "nickname": "sample string 2",
    "postalcode1": "sample string 3",
    "selectasalternate": "sample string 4",
    "removeinfuture": "sample string 5",
    "dropship": "sample string 6",
    "isactive": "sample string 7"
  },
  "isNew": "sample string 3",
  "label": "sample string 4",
  "validation": {
    "firstName": {
      "isRequired": true,
      "isDisabled": true,
      "maxLength": 3
    },
    "lastName": {
      "isRequired": true,
      "isDisabled": true,
      "maxLength": 3
    },
    "companyName": {
      "isRequired": true,
      "isDisabled": true,
      "maxLength": 3
    },
    "address1": {
      "isRequired": true,
      "isDisabled": true,
      "maxLength": 3
    },
    "address2": {
      "isRequired": true,
      "isDisabled": true,
      "maxLength": 3
    },
    "country": {
      "isRequired": true,
      "isDisabled": true,
      "maxLength": 3
    },
    "state": {
      "isRequired": true,
      "isDisabled": true,
      "maxLength": 3
    },
    "city": {
      "isRequired": true,
      "isDisabled": true,
      "maxLength": 3
    },
    "postalCode": {
      "isRequired": true,
      "isDisabled": true,
      "maxLength": 3
    },
    "phone": {
      "isRequired": true,
      "isDisabled": true,
      "maxLength": 3
    },
    "email": "sample string 1"
  },
  "customerNumber": "sample string 5",
  "customerSequence": "sample string 6",
  "customerName": "sample string 7",
  "firstName": "sample string 8",
  "lastName": "sample string 9",
  "companyName": "sample string 10",
  "address1": "sample string 11",
  "address2": "sample string 12",
  "city": "sample string 13",
  "postalCode": "sample string 14",
  "state": {
    "id": "9a23e2eb-e817-48e3-aa96-7e4fffdf3616",
    "abbreviation": "sample string 2",
    "name": "sample string 3",
    "uri": "sample string 4"
  },
  "country": {
    "uri": "sample string 1",
    "id": "a1ee101c-a10b-4d07-b495-f92c4b8991db",
    "abbreviation": "sample string 3",
    "name": "sample string 4",
    "states": [
      {
        "id": "9a23e2eb-e817-48e3-aa96-7e4fffdf3616",
        "abbreviation": "sample string 2",
        "name": "sample string 3",
        "uri": "sample string 4"
      },
      {
        "id": "9a23e2eb-e817-48e3-aa96-7e4fffdf3616",
        "abbreviation": "sample string 2",
        "name": "sample string 3",
        "uri": "sample string 4"
      }
    ]
  },
  "phone": "sample string 15",
  "fullAddress": "sample string 16",
  "flag": "sample string 17",
  "Message": "sample string 18",
  "WebApiIsSuccess": true,
  "WebApiResponseMessage": "sample string 20",
  "WebApiErrorCode": "sample string 21",
  "error_description": "sample string 22",
  "CookieData": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "NameValue": "sample string 3",
      "ExpiryDateTime": "sample string 4"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "NameValue": "sample string 3",
      "ExpiryDateTime": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<ShipmentAddressResponseEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Adi.BusinessEntities.Product">
  <CookieData xmlns="http://schemas.datacontract.org/2004/07/Adi.BusinessEntities">
    <AppCookie>
      <ExpiryDateTime>sample string 4</ExpiryDateTime>
      <Name>sample string 1</Name>
      <NameValue>sample string 3</NameValue>
      <Value>sample string 2</Value>
    </AppCookie>
    <AppCookie>
      <ExpiryDateTime>sample string 4</ExpiryDateTime>
      <Name>sample string 1</Name>
      <NameValue>sample string 3</NameValue>
      <Value>sample string 2</Value>
    </AppCookie>
  </CookieData>
  <Message xmlns="http://schemas.datacontract.org/2004/07/Adi.BusinessEntities">sample string 18</Message>
  <WebApiErrorCode xmlns="http://schemas.datacontract.org/2004/07/Adi.BusinessEntities">sample string 21</WebApiErrorCode>
  <WebApiIsSuccess xmlns="http://schemas.datacontract.org/2004/07/Adi.BusinessEntities">true</WebApiIsSuccess>
  <WebApiResponseMessage xmlns="http://schemas.datacontract.org/2004/07/Adi.BusinessEntities">sample string 20</WebApiResponseMessage>
  <error_description xmlns="http://schemas.datacontract.org/2004/07/Adi.BusinessEntities">sample string 22</error_description>
  <address1>sample string 11</address1>
  <address2>sample string 12</address2>
  <city>sample string 13</city>
  <companyName>sample string 10</companyName>
  <country>
    <abbreviation>sample string 3</abbreviation>
    <id>a1ee101c-a10b-4d07-b495-f92c4b8991db</id>
    <name>sample string 4</name>
    <states>
      <State>
        <abbreviation>sample string 2</abbreviation>
        <id>9a23e2eb-e817-48e3-aa96-7e4fffdf3616</id>
        <name>sample string 3</name>
        <uri>sample string 4</uri>
      </State>
      <State>
        <abbreviation>sample string 2</abbreviation>
        <id>9a23e2eb-e817-48e3-aa96-7e4fffdf3616</id>
        <name>sample string 3</name>
        <uri>sample string 4</uri>
      </State>
    </states>
    <uri>sample string 1</uri>
  </country>
  <customerName>sample string 7</customerName>
  <customerNumber>sample string 5</customerNumber>
  <customerSequence>sample string 6</customerSequence>
  <firstName>sample string 8</firstName>
  <flag>sample string 17</flag>
  <fullAddress>sample string 16</fullAddress>
  <id>3a829ece-84e6-497f-af52-e1a8b76377e3</id>
  <isNew>sample string 3</isNew>
  <label>sample string 4</label>
  <lastName>sample string 9</lastName>
  <phone>sample string 15</phone>
  <postalCode>sample string 14</postalCode>
  <properties>
    <dropship>sample string 6</dropship>
    <isactive>sample string 7</isactive>
    <nickname>sample string 2</nickname>
    <postalcode1>sample string 3</postalcode1>
    <removeinfuture>sample string 5</removeinfuture>
    <selectasalternate>sample string 4</selectasalternate>
    <isDropShip>sample string 1</isDropShip>
  </properties>
  <state>
    <abbreviation>sample string 2</abbreviation>
    <id>9a23e2eb-e817-48e3-aa96-7e4fffdf3616</id>
    <name>sample string 3</name>
    <uri>sample string 4</uri>
  </state>
  <uri>sample string 1</uri>
  <validation>
    <address1>
      <isDisabled>true</isDisabled>
      <isRequired>true</isRequired>
      <maxLength>3</maxLength>
    </address1>
    <address2>
      <isDisabled>true</isDisabled>
      <isRequired>true</isRequired>
      <maxLength>3</maxLength>
    </address2>
    <city>
      <isDisabled>true</isDisabled>
      <isRequired>true</isRequired>
      <maxLength>3</maxLength>
    </city>
    <companyName>
      <isDisabled>true</isDisabled>
      <isRequired>true</isRequired>
      <maxLength>3</maxLength>
    </companyName>
    <country>
      <isDisabled>true</isDisabled>
      <isRequired>true</isRequired>
      <maxLength>3</maxLength>
    </country>
    <email>sample string 1</email>
    <firstName>
      <isDisabled>true</isDisabled>
      <isRequired>true</isRequired>
      <maxLength>3</maxLength>
    </firstName>
    <lastName>
      <isDisabled>true</isDisabled>
      <isRequired>true</isRequired>
      <maxLength>3</maxLength>
    </lastName>
    <phone>
      <isDisabled>true</isDisabled>
      <isRequired>true</isRequired>
      <maxLength>3</maxLength>
    </phone>
    <postalCode>
      <isDisabled>true</isDisabled>
      <isRequired>true</isRequired>
      <maxLength>3</maxLength>
    </postalCode>
    <state>
      <isDisabled>true</isDisabled>
      <isRequired>true</isRequired>
      <maxLength>3</maxLength>
    </state>
  </validation>
</ShipmentAddressResponseEntity>

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 'ShipmentAddressResponseEntity'.

Response Information

Resource Description

CustomActionResultOfShipmentAddressResponseEntity

Name	Description	Type	Additional information
StatusCode		HttpStatusCode	None.
_data		ShipmentAddressResponseEntity	None.

Response Formats

application/json, text/json

Sample:

Sample not available.