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 Parameter	Type	Required
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.discount_engine	object	Optional
relationships.tax_calculator	object	Optional
relationships.customer_group	object	Optional
relationships.geocoder	object	Optional
relationships.default_shipping_method	object	Optional
relationships.default_payment_method	object	Optional

Example

Request

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"
        }
      }
    }
  }
}'

Response

On success, the API responds with a 200 OK status code, returning the updated resource object:

{
  "data": {
    "id": "xYZkjABcde",
    "type": "markets",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde"
    },
    "attributes": {
      "number": 1234,
      "name": "EU Market",
      "code": "europe1",
      "facebook_pixel_id": "1234567890",
      "checkout_url": "https://checkout.yourbrand.com/:order_id",
      "external_prices_url": "https://external_prices.yourbrand.com",
      "external_order_validation_url": "https://external_validation.yourbrand.com",
      "private": true,
      "shipping_cost_cutoff": 3,
      "disabled_at": "2018-01-01T12:00:00.000Z",
      "shared_secret": "1c0994cc4e996e8c6ee56a2198f66f3c",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "merchant": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/merchant",
          "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/merchant"
        }
      },
      "price_list": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/price_list",
          "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/price_list"
        }
      },
      "base_price_list": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/base_price_list",
          "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/base_price_list"
        }
      },
      "inventory_model": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/inventory_model",
          "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/inventory_model"
        }
      },
      "subscription_model": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/subscription_model",
          "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/subscription_model"
        }
      },
      "discount_engine": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/discount_engine",
          "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/discount_engine"
        }
      },
      "tax_calculator": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/tax_calculator",
          "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/tax_calculator"
        }
      },
      "customer_group": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/customer_group",
          "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/customer_group"
        }
      },
      "geocoder": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/geocoder",
          "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/geocoder"
        }
      },
      "default_shipping_method": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/default_shipping_method",
          "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/default_shipping_method"
        }
      },
      "default_payment_method": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/default_payment_method",
          "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/default_payment_method"
        }
      },
      "stores": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/stores",
          "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/stores"
        }
      },
      "price_list_schedulers": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/price_list_schedulers",
          "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/price_list_schedulers"
        }
      },
      "attachments": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/attachments",
          "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/attachments"
        }
      },
      "versions": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/relationships/versions",
          "related": "https://yourdomain.commercelayer.io/api/markets/xYZkjABcde/versions"
        }
      }
    },
    "meta": {
      "mode": "test",
      "organization_id": "xRRkjDFafe",
      "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
    }
  }
}