Update a market

How to update an existing market via API

To update an existing market, send a PATCH request to the /api/markets/: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/markets/:id

Arguments

Body ParameterTypeRequired

type

string

Required

id

string

Required

attributes.name

string

Optional

attributes.code

string

Optional

attributes.facebook_pixel_id

string

Optional

attributes.checkout_url

string

Optional

attributes.external_prices_url

string

Optional

attributes.external_order_validation_url

string

Optional

attributes.shipping_cost_cutoff

integer

Optional

attributes._disable

boolean

Optional

attributes._enable

boolean

Optional

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

relationships.merchant

object

Optional

relationships.price_list

object

Optional

relationships.inventory_model

object

Optional

relationships.subscription_model

object

Optional

relationships.tax_calculator

object

Optional

relationships.customer_group

object

Optional

relationships.geocoder

object

Optional

Example

The following request updates the market identified by the ID "xYZkjABcde":

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

Last updated