Update a shipping method

How to update an existing shipping method via API

To update an existing shipping method, send a PATCH request to the /api/shipping_methods/:id endpoint, where id is the ID of the resource that you want to update.

Here below the list of all the possible arguments that you can pass with the request body.

Request

PATCH https://yourdomain.commercelayer.io/api/shipping_methods/:id

Arguments

Body ParameterTypeRequired

type

string

Required

id

string

Required

attributes.name

string

Optional

attributes.scheme

string

Optional

attributes.currency_code

string

Optional

attributes.external_prices_url

string

Optional

attributes.price_amount_cents

integer

Optional

attributes.free_over_amount_cents

integer

Optional

attributes.use_subtotal

boolean

Optional

attributes.min_weight

float

Optional

attributes.max_weight

float

Optional

attributes.unit_of_weight

string

Optional

attributes._disable

boolean

Optional

attributes._enable

boolean

Optional

attributes._reset_circuit

boolean

Optional

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

relationships.market

object

Optional

relationships.shipping_zone

object

Optional

relationships.shipping_category

object

Optional

relationships.stock_location

object

Optional

relationships.shipping_method_tiers

array

Optional

Example

The following request updates the shipping method identified by the ID "xYZkjABcde":

curl -g -X PATCH \
  'https://yourdomain.commercelayer.io/api/shipping_methods/xYZkjABcde' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "shipping_methods",
    "id": "xYZkjABcde",
    "attributes": {
      "free_over_amount_cents": 9900
    },
    "relationships": {
      "market": {
        "data": {
          "type": "markets",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Last updated