> ## Documentation Index > Fetch the complete documentation index at: https://developers.redo.com/llms.txt > Use this file to discover all available pages before exploring further. # Update shipping method > Replace a shipping method's configuration. The request replaces the whole method, so read it from the experience first and send it back with your changes applied. Configuration the API does not expose, such as shipping discount rules, is kept from the existing method, as is `priceConstraints` when you omit it. Any other optional field you leave out is cleared. A method's `type` can be changed between `fixed` and `dynamic`. Script-priced (`custom`) methods cannot be edited through the API. Requires the [`checkout_write`](/docs/api-reference/scopes) scope. ## OpenAPI ````yaml /api-schema/openapi.yaml put /stores/{storeId}/checkout-experiences/{checkoutExperienceId}/shipping-methods/{shippingMethodId} openapi: 3.1.0 info: contact: email: engineering-admin@getredo.com name: Redo Engineering description: | ## Endpoints Endpoints are authenticated using the Bearer authorization scheme, using the REDO_API_SECRET. ```txt GET /v2.2/resource HTTP/1.1 Authorization: Bearer 77bb7598b7a972475cc7c7e171ec33af Host: api.getredo.com ``` ## Webhooks Webhooks are authenticated using the Bearer authorization scheme, using a secret supplied by the subscriber. ```txt POST /events HTTP/1.1 Authorization: Bearer subscriberauth123 Host: subscriber.example.com ``` Webhook events are delivered in order for each individual subject (e.g. return). If the response is not a 2xx status code, the event will be retried multiple times before discarding it. title: Redo API version: 2.2.1 servers: - url: https://api.getredo.com/v2.2 security: [] tags: - description: >- Group several products under one product shoppers buy, so a returned bundle can be broken back into the products it contains. name: Bundles - name: Checkout Buttons - description: >- Manage the shipping methods shown at checkout. A checkout experience is a named group of shipping methods; the store's checkout tree decides which shoppers see which experience. name: Checkout Experiences - name: Coverage Info - name: Coverage Products - name: Custom Events - name: Customer Portal - name: Customer Subscriptions - name: Customers - name: Inbound Shipments - name: Inventory Items - name: Inventory Levels - name: Invoices - name: Merchant Admin - name: Orders - name: Products - name: Returns - description: >- Push orders into Redo from a commerce platform Redo does not support directly, so shoppers can return them. name: Returns Custom Integration - name: Storefront - name: Webhooks paths: /stores/{storeId}/checkout-experiences/{checkoutExperienceId}/shipping-methods/{shippingMethodId}: summary: Shipping Method description: Shipping method. parameters: - $ref: '#/components/parameters/store-id.param' - $ref: '#/components/parameters/checkout-experience-id.param' - $ref: '#/components/parameters/checkout-shipping-method-id.param' put: tags: - Checkout Experiences summary: Update shipping method description: > Replace a shipping method's configuration. The request replaces the whole method, so read it from the experience first and send it back with your changes applied. Configuration the API does not expose, such as shipping discount rules, is kept from the existing method, as is `priceConstraints` when you omit it. Any other optional field you leave out is cleared. A method's `type` can be changed between `fixed` and `dynamic`. Script-priced (`custom`) methods cannot be edited through the API. Requires the [`checkout_write`](/docs/api-reference/scopes) scope. operationId: Checkout shipping method update requestBody: content: application/json: schema: $ref: '#/components/schemas/checkout-shipping-method-input.schema' examples: reprice: summary: Reprice a flat-rate method value: type: fixed name: Standard description: 5-8 business days rates: - price: '6.49' currency: USD required: true responses: '200': content: application/json: schema: $ref: >- #/components/schemas/checkout-shipping-method-write-response.schema examples: updated: summary: The updated shipping method's ID value: checkoutExperienceId: 66b2f1c9e4b0a1d2c3f4a5b6 shippingMethodId: 66b2f1c9e4b0a1d2c3f4a5c7 description: Updated '400': content: application/problem+json: schema: $ref: '#/components/schemas/error.schema' description: >- Invalid shipping method: a missing or inconsistent field, a carrier the store cannot quote, a fulfillment delay that is not a whole number of days zero or more, or a configuration incompatible with landed costs. Returned with type `com.getredo.api:checkout/invalid-request`. '404': content: application/problem+json: schema: $ref: '#/components/schemas/error.schema' description: >- No checkout experience or shipping method with this ID exists for the store. Returned with type `com.getredo.api:checkout/not-found`. default: content: application/problem+json: schema: $ref: '#/components/schemas/error.schema' description: Error security: - Bearer: [] components: parameters: store-id.param: description: Store ID in: path name: storeId required: true schema: example: 64e5a8a1af49a89df37e4ee7 type: string checkout-experience-id.param: description: Checkout experience ID. in: path name: checkoutExperienceId required: true schema: example: 66b2f1c9e4b0a1d2c3f4a5b6 type: string checkout-shipping-method-id.param: description: Shipping method ID, from the checkout experience's `methods`. in: path name: shippingMethodId required: true schema: example: 66b2f1c9e4b0a1d2c3f4a5c7 type: string schemas: checkout-shipping-method-input.schema: properties: type: description: >- How the price is produced. 'fixed' is a merchant-set price served by Redo with no carrier involved and requires `rates`. 'dynamic' quotes live carrier rates through Redo and requires either `carrierServices` or `serviceLevel`. Custom (script-priced) methods cannot be created or edited here. enum: - fixed - dynamic type: string name: description: >- Shopper-facing name of the shipping method as it appears at checkout, e.g. 'Standard'. May contain customer-name template variables — '{customer_name}', '{customer_name:first}', '{customer_name:last}' — which are substituted per shopper. Send them back verbatim when you are not deliberately changing them, or you will silently strip the merchant's personalization. example: Standard type: string description: description: >- Shopper-facing description shown next to the method at checkout. Like `name`, it may contain customer-name template variables. example: 5-8 business days type: string fallbackName: description: >- Shopper-facing name used in place of `name` when `name` contains customer-name template variables and the shopper's name is not available at quote time. Ignored when `name` has no variables. type: string fallbackDescription: description: >- Shopper-facing description used in place of `description` under the same condition as `fallbackName`. type: string serviceCode: description: >- Identifier the storefront platform uses for this shipping option at checkout. type: string coverageTypes: description: Redo coverage bundled into this shipping method. properties: return: description: Include return coverage with this method. type: boolean packageProtection: description: Include package protection with this method. type: boolean type: object orderTags: description: Tags applied to the order when this method is bought. items: type: string type: array addLandedCostsOverride: description: >- Add landed costs (duties and import fees) to this method's price, overriding the experience-level setting. type: boolean rates: description: >- Fixed methods only, and required for them. One entry per price. A single entry with no `conditions` is a flat price; multiple entries express weight or cart-value ranges and free-shipping thresholds. items: properties: price: description: >- Price for this rate as a decimal string, e.g. '5.99'. Use '0' for free shipping. example: '5.99' type: string currency: description: ISO currency code for `price`, e.g. 'USD'. example: USD type: string enabled: description: Whether this rate is active. Defaults to true. type: boolean conditions: description: >- Cart weight or cart value ranges this rate applies to. Omit or pass an empty array for a flat price that applies to every cart. items: properties: type: description: >- What this condition is measured against: 'weight' for cart weight, 'price' for cart value. enum: - weight - price type: string minGrams: description: >- Inclusive lower bound of cart weight. Weight conditions only. type: number maxGrams: description: >- Inclusive upper bound of cart weight. Weight conditions only. type: number minPrice: description: >- Inclusive lower bound of cart value. Price conditions only. type: number maxPrice: description: >- Inclusive upper bound of cart value. Price conditions only. type: number currency: description: >- Currency of the cart value bounds. Price conditions only. type: string required: - type type: object type: array required: - price - currency type: object type: array carrierServices: description: >- Dynamic methods only. The carrier services to quote live rates from. Required unless `serviceLevel` is set. items: properties: carrier: description: >- Carrier to quote live rates from. Values are display-cased, e.g. 'FedEx', 'UPS', 'USPS'. enum: - FedEx - UPS - UPSSurePost - USPS - USPSReturns - UspsShip - FedExSmartPost - AmazonShipping - DHLExpress - DhlEcs - Veho - APC - FirstMile - AustraliaPost - CanadaPost - GSO - AsendiaUsa - RoyalMailV3 - SpeeDee - PassportGlobal - ePostGlobal - LandmarkGlobal - ETA Express - OnTracV3 - GlobalE - UPSMailInnovations - Purolator - UniUni - StallionExpress - EcomExpress - ChitChats - PostNL - Intelcom - FleetOptics - ICS - WhizDelivery - Tik Tok - CanparExpress - GOFO - P2P example: FedEx type: string service: description: >- Carrier-specific service code, e.g. 'FEDEX_GROUND' for FedEx or 'Ground' for UPS. The valid set differs per carrier; read an existing dynamic method with `GET /stores/{storeId}/checkout-experiences/{checkoutExperienceId}` to see the codes this store already uses. example: FEDEX_GROUND type: string enabled: description: Whether this carrier service is quoted. Defaults to true. type: boolean markup: description: Markup applied to this carrier service specifically. properties: amount: description: Flat markup for this service, as a decimal string. type: string percentage: description: Percentage markup for this service, as a decimal string. type: string type: object required: - carrier - service type: object type: array rateSelection: description: >- Dynamic methods only. Which of the eligible live rates to show the shopper. Values are lowercase: 'cheapest', 'fastest'. enum: - cheapest - fastest - custom type: string serviceLevel: description: >- Dynamic methods only. Quote the cheapest carrier service delivering within this service level's window instead of pinning carrier services. enum: - Standard - Plus - Express type: string excludedCarriers: description: >- Dynamic methods only. Carriers excluded from this method's candidate set. items: enum: - FedEx - UPS - UPSSurePost - USPS - USPSReturns - UspsShip - FedExSmartPost - AmazonShipping - DHLExpress - DhlEcs - Veho - APC - FirstMile - AustraliaPost - CanadaPost - GSO - AsendiaUsa - RoyalMailV3 - SpeeDee - PassportGlobal - ePostGlobal - LandmarkGlobal - ETA Express - OnTracV3 - GlobalE - UPSMailInnovations - Purolator - UniUni - StallionExpress - EcomExpress - ChitChats - PostNL - Intelcom - FleetOptics - ICS - WhizDelivery - Tik Tok - CanparExpress - GOFO - P2P type: string type: array markup: description: >- Dynamic methods only. Markup applied to every live carrier rate on this method. properties: amount: description: Flat markup as a decimal string. type: string currency: description: Currency of the flat markup. Required when `amount` is set. enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWG - ZWL - BYR - HRK - JEP - KID - LTL - LVL - SLL - STD - USDC - VEF type: string percentage: description: Percentage markup as a decimal string, e.g. '10' for +10%. example: '10' type: string type: object rounding: description: >- Dynamic methods only. How to round the marked-up price before showing it. enum: - NEAREST_WHOLE - NEAREST_WHOLE_MINUS_ONE - NEAREST_WHOLE_MINUS_FIVE - NEAREST_HALF - NEAREST_QUARTER - NEAREST_TENTH - NEAREST_TWENTIETH type: string priceBounds: description: Dynamic methods only. Hard clamp applied after markup and rounding. properties: currency: description: Currency of the bounds. enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWG - ZWL - BYR - HRK - JEP - KID - LTL - LVL - SLL - STD - USDC - VEF type: string minimum: description: Lowest price ever shown, as a decimal string. type: string maximum: description: Highest price ever shown, as a decimal string. type: string required: - currency type: object fulfillmentDelayDaysOverride: description: >- Dynamic methods only. Days Redo assumes an order takes to ship when it estimates delivery dates for this method, overriding the experience's `fulfillmentDelayDaysOverride`. Omit it to use the experience's value. A whole number of days, zero or more. example: 3 minimum: 0 type: integer priceConstraints: description: >- Bounds the final price this method may be sold at, after every other pricing rule has run. Omit to leave the method's existing constraint untouched; send one to replace it outright. There is no way to clear a constraint through this API. properties: kind: description: >- How the bounds are expressed: 'DEFAULT' bounds the price absolutely, 'RELATIVE_TO_OTHER_RATE_TABLE' bounds it against another shipping method's price. enum: - DEFAULT - RELATIVE_TO_OTHER_RATE_TABLE type: string currency: description: Currency all bounds are expressed in. enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWG - ZWL - BYR - HRK - JEP - KID - LTL - LVL - SLL - STD - USDC - VEF type: string minPrice: description: >- Lowest price this method may be sold at. 'DEFAULT' constraints only. type: number maxPrice: description: >- Highest price this method may be sold at. 'DEFAULT' constraints only. type: number marginAtLeast: description: Suggested lower margin bound. Omit when there is none. properties: amount: description: Absolute amount of the bound. Omit when unset. type: number percentage: description: Percentage form of the bound. Omit when unset. type: number type: object marginAtMost: description: Suggested upper margin bound. Omit when there is none. properties: amount: description: Absolute amount of the bound. Omit when unset. type: number percentage: description: Percentage form of the bound. Omit when unset. type: number type: object relativeToMethodId: description: >- ID of the shipping method this method's price is bounded against, from the same checkout experience. Required for, and only valid on, 'RELATIVE_TO_OTHER_RATE_TABLE' constraints. type: string byAtLeast: description: >- How far above the referenced method's price this method must sit. 'RELATIVE_TO_OTHER_RATE_TABLE' constraints only. properties: amount: description: Absolute amount of the bound. Omit when unset. type: number percentage: description: Percentage form of the bound. Omit when unset. type: number type: object byAtMost: description: >- How far above the referenced method's price this method may sit. 'RELATIVE_TO_OTHER_RATE_TABLE' constraints only. properties: amount: description: Absolute amount of the bound. Omit when unset. type: number percentage: description: Percentage form of the bound. Omit when unset. type: number type: object absoluteMinimumPrice: description: >- Floor applied after the relative bound: the effective minimum is the greater of this and the referenced price plus `byAtLeast`. 'RELATIVE_TO_OTHER_RATE_TABLE' constraints only. type: number required: - kind - currency type: object required: - type - name - description title: Shipping method input type: object checkout-shipping-method-write-response.schema: properties: checkoutExperienceId: description: The checkout experience the method belongs to. example: 66b2f1c9e4b0a1d2c3f4a5b6 type: string shippingMethodId: description: >- The shipping method that was written. Read it back with `GET /stores/{storeId}/checkout-experiences/{checkoutExperienceId}`. example: 66b2f1c9e4b0a1d2c3f4a5c7 type: string required: - checkoutExperienceId - shippingMethodId title: Shipping method write result type: object error.schema: description: >- Problem details. See [RFC 7807 Section 3](https://datatracker.ietf.org/doc/html/rfc7807#section-3). properties: detail: description: Human-readable description of the problem. title: Detail type: string instance: description: A URI reference that identifies this problem. format: uri-reference type: string title: description: Human-readable summary of the problem type. title: Title type: string type: default: about:blank description: A URI reference that identifies the problem type. format: uri-reference type: string title: Problem details type: object securitySchemes: Bearer: scheme: bearer type: http ````