Create a return line item

How to create a return line item via API

To create a new return line item, send a POST request to the /api/return_line_items endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/return_line_items

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.quantity	integer	Required
attributes.return_reason	object	Optional
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional
relationships.return	object	Required
relationships.line_item	object	Required

Example

Request

The following request creates a new return line item:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/return_line_items' \
  -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",
    "attributes": {
      "quantity": 4
    },
    "relationships": {
      "return": {
        "data": {
          "type": "returns",
          "id": "ABCRtyUpBa"
        }
      },
      "line_item": {
        "data": {
          "type": "line_items",
          "id": "BCDRtyUpBa"
        }
      }
    }
  }
}'

Response

On success, the API responds with a 201 Created status code, returning the created 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": "Men's Black T-shirt with White Logo (XL)",
      "image_url": "https://img.yourdomain.com/skus/xYZkjABcde.png",
      "total_amount_cents": 8800,
      "total_amount_float": 88.0,
      "formatted_total_amount": "€88,00",
      "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",
      "organization_id": "xRRkjDFafe",
      "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
    }
  }
}