Developer docs

← All endpoints

POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/carts/{cartId}/delivery_options

List delivery options for a cart Experimental

The ways the cart can be delivered to an address, priced live by the carrier on the merchant's own agreements for the cart's weight. Nothing is configured in SnowBee. Send the chosen option's carrier fields and amounts as the freight block of the payment session and the checkout; for a pickup product, also the chosen pickup point.

Parameters

tenantIdpathstringnon-nullrequired
eComStoreIdpathstringnon-nullrequired
cartIdpathstringnon-nullrequired

Request body (required)

application/jsonobjectnon-null
addressobjectnon-nullrequired
Show child fields
citystringnon-nullrequired
countryIsoCodestringnon-nullrequired

ISO 3166-1 alpha-2

Example"NO"
postCodestringnon-nullrequired
streetstringnullableoptional

Street address; improves pickup point ordering

View schema definition

Responses

200Response
application/jsonobjectnon-null
optionsarray of objectnon-nullrequired
Show item fields

A way to get the cart delivered, priced live on the merchant's carrier agreement. Pass the carrier fields and amounts on as the checkout's freight block.

carrierAgreementCodestringnon-nullrequired
carrierCodestringnon-nullrequired
carrierNamestringnon-nullrequired
carrierProductCodestringnon-nullrequired
carrierProductNamestringnon-nullrequired
expectedDeliverystringnullableoptional

Carrier's expected delivery date

freightVatRatestringnon-nullrequired

VAT rate as a percentage; the checkout's freightVatRate

  • Format: BigDecimal
Example"100.0"
grossFreightAmountstringnon-nullrequired

Freight including VAT, what the shopper pays

  • Format: BigDecimal
Example"100.0"
netFreightAmountstringnon-nullrequired

Freight excluding VAT; the checkout's netFreightAmount

  • Format: BigDecimal
Example"100.0"
pickupPointRequiredbooleannon-nullrequired

The shopper must choose a pickup point; fetch them with POST /carts/{cartId}/pickup_points and send the choice as carrierProductPayload

workingDaysintegernullableoptional

Carrier's estimate of working days to delivery

  • Format: int32

View schema definition

400Response
application/jsonobjectnon-null
errorstringnon-nullrequired

Stable error code

Example"INVALID_REQUEST"
messagestringnon-nullrequired

Human-readable error message

Example"Invalid customer ID format"
resolutionstringnon-nullrequired

Suggested next action

Example"Correct the customer ID and retry the request"

View schema definition

401Response
application/jsonobjectnon-null
errorstringnon-nullrequired

Stable error code

Example"INVALID_REQUEST"
messagestringnon-nullrequired

Human-readable error message

Example"Invalid customer ID format"
resolutionstringnon-nullrequired

Suggested next action

Example"Correct the customer ID and retry the request"

View schema definition

403Response
application/jsonobjectnon-null
errorstringnon-nullrequired

Stable error code

Example"INVALID_REQUEST"
messagestringnon-nullrequired

Human-readable error message

Example"Invalid customer ID format"
resolutionstringnon-nullrequired

Suggested next action

Example"Correct the customer ID and retry the request"

View schema definition

404Response
application/jsonobjectnon-null
errorstringnon-nullrequired

Stable error code

Example"INVALID_REQUEST"
messagestringnon-nullrequired

Human-readable error message

Example"Invalid customer ID format"
resolutionstringnon-nullrequired

Suggested next action

Example"Correct the customer ID and retry the request"

View schema definition

409The store's company has no Profrakt transport configuration

The store's company has no Profrakt transport configuration

application/jsonobjectnon-null
errorstringnon-nullrequired

Stable error code

Example"INVALID_REQUEST"
messagestringnon-nullrequired

Human-readable error message

Example"Invalid customer ID format"
resolutionstringnon-nullrequired

Suggested next action

Example"Correct the customer ID and retry the request"

View schema definition

422Response
application/jsonobjectnon-null
errorstringnon-nullrequired

Stable error code

Example"INVALID_REQUEST"
messagestringnon-nullrequired

Human-readable error message

Example"Invalid customer ID format"
resolutionstringnon-nullrequired

Suggested next action

Example"Correct the customer ID and retry the request"

View schema definition