POST cart/checkoutinfo/{cartCollectionKey}?cartId={cartId}

Add or update checkout info to current cart or cart specified by cartId

Request Information

URI Parameters

NameDescriptionTypeAdditional information
cartCollectionKey

Cart collection key

string

Required

cartId

Optional cart id

integer

None.

Body Parameters

Checkout state

CartCheckoutInfoModel
NameDescriptionTypeAdditional information
PONumber

Your Purchase Order Number

string

None.

EndUserPO

Your customer’s PO Number

string

None.

RequestedDeliveryDate

Future shipping date

date

None.

ShipMethodServiceLevelCode

Specifies shipping method for order
NOTE: List of shipping options with freight amounts can be obtained using the GetShipQuote method

string

None.

ServiceLevelDescription

Service Level Description

string

None.

ShippingAccountNumber

If third party shipping option is specified, include your carrier account number to be charged freight

string

None.

FreightForwarderNumber

Freight forwarder

string

None.

ShipComplete

Flag indicating all items need to be in the same shipment

boolean

None.

Memo

Additional notes about this order.

string

None.

PayorId

Payer for this order. Used to bill against other accounts. Typically the same as customer #.
NOTE: List of Payers can be obtained using the GetPayers method

string

None.

ShippingAddress

Ship address for order

CartAddressModel

None.

Carrier

Non-standard carrier specify the phone # / address

CartCarrierModel

None.

Created

Created DateTime stamp

date

None.

Updated

Updated DateTime stamp

date

None.

Request Formats

application/json, text/json

Sample:
{
  "PONumber": "sample string 1",
  "EndUserPO": "sample string 2",
  "RequestedDeliveryDate": "2021-05-13T16:56:02.0101347-04:00",
  "ShipMethodServiceLevelCode": "sample string 3",
  "ServiceLevelDescription": "sample string 4",
  "ShippingAccountNumber": "sample string 5",
  "FreightForwarderNumber": "sample string 6",
  "ShipComplete": true,
  "Memo": "sample string 8",
  "PayorId": "sample string 9",
  "ShippingAddress": {
    "Name": "sample string 1",
    "Street1": "sample string 2",
    "Street2": "sample string 3",
    "City": "sample string 4",
    "State": "sample string 5",
    "PostalCode": "sample string 6",
    "Country": "sample string 7"
  },
  "Carrier": {
    "CarrierAddress": {
      "Name": "sample string 1",
      "Street1": "sample string 2",
      "Street2": "sample string 3",
      "City": "sample string 4",
      "State": "sample string 5",
      "PostalCode": "sample string 6",
      "Country": "sample string 7"
    },
    "Phone": "sample string 1"
  },
  "Created": "2021-05-13T16:56:02.0101347-04:00",
  "Updated": "2021-05-13T16:56:02.0101347-04:00"
}

application/xml, text/xml

Sample:
<CartCheckoutInfoModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PONumber>sample string 1</PONumber>
  <EndUserPO>sample string 2</EndUserPO>
  <RequestedDeliveryDate>2021-05-13T16:56:02.0101347-04:00</RequestedDeliveryDate>
  <ShipMethodServiceLevelCode>sample string 3</ShipMethodServiceLevelCode>
  <ServiceLevelDescription>sample string 4</ServiceLevelDescription>
  <ShippingAccountNumber>sample string 5</ShippingAccountNumber>
  <FreightForwarderNumber>sample string 6</FreightForwarderNumber>
  <ShipComplete>true</ShipComplete>
  <Memo>sample string 8</Memo>
  <PayorId>sample string 9</PayorId>
  <ShippingAddress>
    <Name>sample string 1</Name>
    <Street1>sample string 2</Street1>
    <Street2>sample string 3</Street2>
    <City>sample string 4</City>
    <State>sample string 5</State>
    <PostalCode>sample string 6</PostalCode>
    <Country>sample string 7</Country>
  </ShippingAddress>
  <Carrier>
    <CarrierAddress>
      <Name>sample string 1</Name>
      <Street1>sample string 2</Street1>
      <Street2>sample string 3</Street2>
      <City>sample string 4</City>
      <State>sample string 5</State>
      <PostalCode>sample string 6</PostalCode>
      <Country>sample string 7</Country>
    </CarrierAddress>
    <Phone>sample string 1</Phone>
  </Carrier>
  <Created>2021-05-13T16:56:02.0101347-04:00</Created>
  <Updated>2021-05-13T16:56:02.0101347-04:00</Updated>
</CartCheckoutInfoModel>

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

Response Information

Resource Description

None.