Update delivery method (v4)

Updates the selected DeliveryMethod on a basket. The DeliveryMethod id should be taken from any valid DeliveryMethod in Checkout.DeliveryMethods.

Request
query Parameters
basketId
required
integer <int32>

The internal id of the basket to update.

pricelistSeed
string

A comma separated list of internal pricelist ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

dropPointSize
string

Maximum number of drop points to return for each DeliveryMethod. Only used for integrated DeliveryMethod providers such as ShipAdvisor.

cultureCode
string

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

currencyId
string

Internal id that specifies in which currency to display prices. If none is supplied, value is resolved from Application.

Request Body schema:

The BasketDeliveryMethodUpdate to use when updating the DeliveryMethod for the basket.

Id
integer <int32>

The internal id of the DeliveryMethod.

Price
number or null <decimal>

The Price of the DeliveryMethod, excluding VAT. Prices set here will be handled as manual prices. If not set the Price will be taken from Storm and be treated as a normal price.

object <DropPoint> (DropPoint)
Code
string

An external Code for the DeliveryMethod. This should not be set if the Code defined in Storm is to be used. MaxLength: 50.

Carrier
string

The carrier providing the delivery method MaxLength: 50.

Responses
200

Success

400

Bad Request

Key: BasketNotEditable. Gets raised when the basket is not editable or already paid for.

Key: InvalidCompanyOnBasket. Gets raised when the basket has an invalid company. The customer does not exist in this company.

Key: QuotationMissing. Gets raised when the basket is missing.

500

Internal Server Error

post/ShoppingService.svc/rest/UpdateDeliveryMethod4
Request samples
{
  • "Id": 0,
  • "Price": 0,
  • "DropPoint": {
    },
  • "Code": "string",
  • "Carrier": "string"
}
Response samples
{
  • "Basket": {
    },
  • "Buyer": {
    },
  • "Payer": {
    },
  • "ShipTo": {
    },
  • "PaymentMethods": [
    ],
  • "DeliveryMethods": [
    ],
  • "Payments": [
    ]
}