Update a return

How to update an existing return via API

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

Arguments

Body ParameterTypeRequired

type

string

Required

id

string

Required

attributes._request

boolean

Optional

attributes._approve

boolean

Optional

attributes._cancel

boolean

Optional

attributes._ship

boolean

Optional

attributes._reject

boolean

Optional

attributes._receive

boolean

Optional

attributes._restock

boolean

Optional

attributes._archive

boolean

Optional

attributes._unarchive

boolean

Optional

attributes._refund

boolean

Optional

attributes._refund_amount_cents

integer

Optional

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

relationships.stock_location

object

Optional

relationships.reference_capture

object

Optional

relationships.tags

array

Optional

Example

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

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

Last updated