Update a free shipping promotion

How to update an existing free shipping promotion via API

To update an existing free shipping promotion, send a PATCH request to the /api/free_shipping_promotions/: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/free_shipping_promotions/:id

Arguments

Body ParameterTypeRequired

type

string

Required

id

string

Required

attributes.name

string

Optional

attributes.currency_code

string

Optional

attributes.exclusive

boolean

Optional

attributes.priority

integer

Optional

attributes.starts_at

datetime

Optional

attributes.expires_at

datetime

Optional

attributes.total_usage_limit

integer

Optional

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

attributes._disable

boolean

Optional

attributes._enable

boolean

Optional

relationships.market

object

Optional

relationships.order_amount_promotion_rule

object

Optional

relationships.sku_list_promotion_rule

object

Optional

relationships.coupon_codes_promotion_rule

object

Optional

relationships.custom_promotion_rule

object

Optional

relationships.sku_list

object

Optional

relationships.tags

array

Optional

Example

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

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

Last updated