Update a line item

How to update an existing line item via API

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

Arguments

Body ParameterTypeRequired

type

string

Required

id

string

Required

attributes.sku_code

string

Optional

attributes.bundle_code

string

Optional

attributes.quantity

integer

Optional

attributes._external_price

boolean

Optional

attributes._reserve_stock

boolean

Optional

attributes.unit_amount_cents

integer

Optional

attributes.compare_at_amount_cents

integer

Optional

attributes.name

string

Optional

attributes.image_url

string

Optional

attributes.frequency

string

Optional

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

attributes._reset_circuit

boolean

Optional

relationships.tags

array

Optional

Example

The following request updates the line item identified by the ID "xYZkjABcde":

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

Last updated