curl --request PUT \
  --url https://api.getredo.com/v2.2/stores/{storeId}/checkout-experiences/{checkoutExperienceId}/auto-selected-shipping-methods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shippingMethodIds": [
    "66b2f1c9e4b0a1d2c3f4a5c8"
  ]
}
'

{
  "checkoutExperienceId": "66b2f1c9e4b0a1d2c3f4a5b6"
}

{
  "type": "com.getredo.api:checkout/invalid-request",
  "title": "Invalid checkout configuration",
  "detail": "Shipping method 66b2f1c9e4b0a1d2c3f4a5e9 is not part of this checkout experience."
}

{
  "detail": "<string>",
  "instance": "<string>",
  "title": "<string>",
  "type": "about:blank"
}

{
  "detail": "<string>",
  "instance": "<string>",
  "title": "<string>",
  "type": "about:blank"
}

Checkout Experiences

Set auto-selected shipping methods

Choose which shipping methods are shown first at checkout, in priority order. The first one available is pre-selected for the shopper, and methods not listed follow in their usual order.

Send only the methods to put first, not every method. The list replaces the current one; send an empty list to turn auto-selection off. Read the current list from autoSelectedShippingMethodIds on the checkout experience.

Requires the checkout_write scope.

PUT

stores

{storeId}

checkout-experiences

{checkoutExperienceId}

auto-selected-shipping-methods

curl --request PUT \
  --url https://api.getredo.com/v2.2/stores/{storeId}/checkout-experiences/{checkoutExperienceId}/auto-selected-shipping-methods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shippingMethodIds": [
    "66b2f1c9e4b0a1d2c3f4a5c8"
  ]
}
'

{
  "checkoutExperienceId": "66b2f1c9e4b0a1d2c3f4a5b6"
}

{
  "type": "com.getredo.api:checkout/invalid-request",
  "title": "Invalid checkout configuration",
  "detail": "Shipping method 66b2f1c9e4b0a1d2c3f4a5e9 is not part of this checkout experience."
}

{
  "detail": "<string>",
  "instance": "<string>",
  "title": "<string>",
  "type": "about:blank"
}

{
  "detail": "<string>",
  "instance": "<string>",
  "title": "<string>",
  "type": "about:blank"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

storeId

string

required

Store ID

Example:

"64e5a8a1af49a89df37e4ee7"

checkoutExperienceId

string

required

Checkout experience ID.

Example:

"66b2f1c9e4b0a1d2c3f4a5b6"

Body

application/json

shippingMethodIds

string[]

required

Shipping method IDs to show first, highest priority first; the first available is pre-selected. Replaces the current list. Send an empty list to turn auto-selection off.

Example:

["66b2f1c9e4b0a1d2c3f4a5c8"]

Response

Updated

checkoutExperienceId

string

required

The checkout experience that was written. Read it back with GET /stores/{storeId}/checkout-experiences/{checkoutExperienceId}.

Example:

"66b2f1c9e4b0a1d2c3f4a5b6"

Getting Started

Endpoints

Set auto-selected shipping methods

Authorizations

Path Parameters

Body

Response