Update a price

How to update an existing price via API

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

Arguments

Body Parameter	Type	Required
type	string	Required
id	string	Required
attributes.sku_code	string	Optional
attributes.amount_cents	integer	Optional
attributes.compare_at_amount_cents	integer	Optional
attributes.processed_at	datetime	Optional
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.rules	object	Optional
attributes.metadata	object	Optional
relationships.price_list	object	Optional
relationships.sku	object	Optional
relationships.price_tiers	array	Optional

Example

Request

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

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

Response

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

{
  "data": {
    "id": "xYZkjABcde",
    "type": "prices",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde"
    },
    "attributes": {
      "currency_code": "EUR",
      "sku_code": "TSHIRTMM000000FFFFFFXLXX",
      "amount_cents": 10000,
      "amount_float": 100.0,
      "formatted_amount": "€100,00",
      "original_amount_cents": 10000,
      "formatted_original_amount": "€100,00",
      "compare_at_amount_cents": 13000,
      "compare_at_amount_float": 130.0,
      "formatted_compare_at_amount": "€130,00",
      "rule_outcomes": [],
      "processed_at": "2018-01-01T12:00:00.000Z",
      "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",
      "rules": {},
      "resource_payload": {},
      "jwt_custom_claim": {},
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "price_list": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/relationships/price_list",
          "related": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/price_list"
        }
      },
      "sku": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/relationships/sku",
          "related": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/sku"
        }
      },
      "price_tiers": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/relationships/price_tiers",
          "related": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/price_tiers"
        }
      },
      "price_volume_tiers": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/relationships/price_volume_tiers",
          "related": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/price_volume_tiers"
        }
      },
      "price_frequency_tiers": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/relationships/price_frequency_tiers",
          "related": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/price_frequency_tiers"
        }
      },
      "attachments": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/relationships/attachments",
          "related": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/attachments"
        }
      },
      "versions": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/relationships/versions",
          "related": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/versions"
        }
      },
      "jwt_customer": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/relationships/jwt_customer",
          "related": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/jwt_customer"
        }
      },
      "jwt_markets": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/relationships/jwt_markets",
          "related": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/jwt_markets"
        }
      },
      "jwt_stock_locations": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/relationships/jwt_stock_locations",
          "related": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/jwt_stock_locations"
        }
      }
    },
    "meta": {
      "mode": "test",
      "organization_id": "xRRkjDFafe",
      "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
    }
  }
}