Comment on page

Update a return line item

How to update an existing return line item via API

To update an existing return line item, send a PATCH request to the /api/return_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/return_line_items/:id
Arguments
Body Parameter
Type
Required
type
string
Required
id
string
Required
attributes.quantity
integer
Optional
attributes._restock
boolean
Optional
attributes.return_reason
object
Optional
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
Example
Request
Response
The following request updates the return line item identified by the ID "xYZkjABcde":
curl -g -X PATCH \
  'https://yourdomain.commercelayer.io/api/return_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": "return_line_items",
    "id": "xYZkjABcde",
    "attributes": {
      "_restock": true
    }
  }
}'
On success, the API responds with a 200 OK status code, returning the updated resource object:
{
  "data": {
    "id": "xYZkjABcde",
    "type": "return_line_items",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/return_line_items/xYZkjABcde"
    },
    "attributes": {
      "sku_code": "TSHIRTMM000000FFFFFFXLXX",
      "bundle_code": "BUNDLEMM000000FFFFFFXLXX",
      "quantity": 4,
      "name": "Black Men T-shirt with White Logo (XL)",
      "image_url": "https://img.yourdomain.com/skus/xYZkjABcde.png",
      "return_reason": {
        "size": "was wrong"
      },
      "restocked_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",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "return": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/return_line_items/xYZkjABcde/relationships/return",
          "related": "https://yourdomain.commercelayer.io/api/return_line_items/xYZkjABcde/return"
        }
      },
      "line_item": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/return_line_items/xYZkjABcde/relationships/line_item",
          "related": "https://yourdomain.commercelayer.io/api/return_line_items/xYZkjABcde/line_item"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

Body Parameter	Type	Required
type	`string`	Required
id	`string`	Required
attributes.quantity	`integer`	Optional
attributes._restock	`boolean`	Optional
attributes.return_reason	`object`	Optional
attributes.reference	`string`	Optional
attributes.reference_origin	`string`	Optional
attributes.metadata	`object`	Optional

Retrieve a return line item

Delete a return line item

Last modified 4mo ago