POST api/PurchaseCart

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SessionKey	string	Required
CheckoutAsGuest	boolean	Required
NoPaymentRequired	boolean	Required
FirstName	string	Required
LastName	string	Required
Address1	string	Required
Address2	string
City	string	Required
StateId	string	Required
CountryId	integer	Required
PostalCode	string	Required
Email	string	Required
Phone	string	Required
StoredCreditCardId	integer
CreditCardNumber	string	Required
CreditCardType	integer	Required
CreditCardName	string	Required
CreditCardCVV	string	Required
CreditCardExpirationMonth	integer	Required Range: inclusive between 1 and 12
CreditCardExpirationYear	integer	Required
SaveCard	boolean	Required

Request Formats

application/json, text/json

Sample:

{
  "SessionKey": "sample string 1",
  "CheckoutAsGuest": true,
  "NoPaymentRequired": true,
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "Address1": "sample string 6",
  "Address2": "sample string 7",
  "City": "sample string 8",
  "StateId": "sample string 9",
  "CountryId": 10,
  "PostalCode": "sample string 11",
  "Email": "sample string 12",
  "Phone": "sample string 13",
  "StoredCreditCardId": 14,
  "CreditCardNumber": "sample string 15",
  "CreditCardType": 16,
  "CreditCardName": "sample string 17",
  "CreditCardCVV": "sample string 18",
  "CreditCardExpirationMonth": 19,
  "CreditCardExpirationYear": 20,
  "SaveCard": true
}

application/xml, text/xml

Sample:

<PurchaseCartRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">
  <Address1>sample string 6</Address1>
  <Address2>sample string 7</Address2>
  <CheckoutAsGuest>true</CheckoutAsGuest>
  <City>sample string 8</City>
  <CountryId>10</CountryId>
  <CreditCardCVV>sample string 18</CreditCardCVV>
  <CreditCardExpirationMonth>19</CreditCardExpirationMonth>
  <CreditCardExpirationYear>20</CreditCardExpirationYear>
  <CreditCardName>sample string 17</CreditCardName>
  <CreditCardNumber>sample string 15</CreditCardNumber>
  <CreditCardType>16</CreditCardType>
  <Email>sample string 12</Email>
  <FirstName>sample string 4</FirstName>
  <LastName>sample string 5</LastName>
  <NoPaymentRequired>true</NoPaymentRequired>
  <Phone>sample string 13</Phone>
  <PostalCode>sample string 11</PostalCode>
  <SaveCard>true</SaveCard>
  <SessionKey>sample string 1</SessionKey>
  <StateId>sample string 9</StateId>
  <StoredCreditCardId>14</StoredCreditCardId>
</PurchaseCartRequest>

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

Response Information

Resource Description

ApiSuccessOfPurchaseCartResult

Name	Description	Type	Additional information
Success		boolean
Data		PurchaseCartResult

Response Formats

application/json

Sample:

{
  "Success": true,
  "Data": {
    "NewAccountCreated": true,
    "PurchaseCompleted": true,
    "OrderEmailSent": true,
    "OrderNumber": 4,
    "PrimaryAddressError": true,
    "NewSessionKey": "ODBwV/KrLZySYRl1juGRrVuyEEaEa/PDmJQU166b3NQZTBs8jVggakl3ELE+0q94ub6fGobTp+v+6IVS+NCSqzKsyqXZSvFci5LgX3TtOQI=",
    "Error": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

text/json

Sample:

{
  "Success": true,
  "Data": {
    "NewAccountCreated": true,
    "PurchaseCompleted": true,
    "OrderEmailSent": true,
    "OrderNumber": 4,
    "PrimaryAddressError": true,
    "NewSessionKey": "M42c3jqckFeDKOSXPi33yyrHDX34wCKoGQ6qY9pAWsQgc/0SFdWZowcWXDZT+Y1CfXTWjumutcMZNWPWECMg0R8Dxv3K4E3fRoH9ocjU8sQ=",
    "Error": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<ApiSuccessOfPurchaseCartResultlnV6n2FW xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Api">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">
    <d2p1:Error xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:Error>
    <d2p1:NewSessionKey>sample string 6</d2p1:NewSessionKey>
    <d2p1:OrderEmailSent>true</d2p1:OrderEmailSent>
    <d2p1:OrderNumber>4</d2p1:OrderNumber>
    <d2p1:PrimaryAddressError>true</d2p1:PrimaryAddressError>
    <d2p1:PurchaseCompleted>true</d2p1:PurchaseCompleted>
    <d2p1:NewAccountCreated>true</d2p1:NewAccountCreated>
  </Data>
</ApiSuccessOfPurchaseCartResultlnV6n2FW>