COcommercelayer
price_lists

Update a price list

Changed on

Update a price list

patch/price_lists/{priceListId}

Request

  • Base URL
    https://{your_organization_slug}.commercelayer.io/api
  • URL
    https://{your_organization_slug}.commercelayer.io/api/price_lists/{priceListId}
  • Auth
    HTTP bearer

Path parameters

priceListIdstring required

The resource's id

Request body

Example request

{
  "data": {
    "id": "XAyRWNUzyN",
    "attributes": {
      "name": "EU Price list",
      "code": "europe1",
      "currency_code": "EUR",
      "tax_included": true,
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "rules": {},
      "metadata": {
        "foo": "bar"
      }
    }
  }
}

Response

The updated price list object

Changes

  • 859097ed3fe6Revision changes
    • breaking

      request property / was restricted to a list of enum values

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      the request property // became nullable

    • info

      the request property // became nullable

    • info

      the request property // became nullable

    • info

      the request property default value price_lists was removed

    • info

      added the new price_lists enum value to the request property /

    • info

      added the media type application/vnd.api+json for the response with the status