COcommercelayer
returns

Create a return

Changed on

Create a return

post/returns

Request

  • Base URL
    https://{your_organization_slug}.commercelayer.io/api
  • URL
    https://{your_organization_slug}.commercelayer.io/api/returns
  • Auth
    HTTP bearer

Request body

Example request

{
  "data": {
    "attributes": {
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "order": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "stock_location": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "reference_capture": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "tags": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      }
    }
  }
}

Response

The created return object

Changes

  • 859097ed3fe6Revision changes
    • breaking

      added the new required request property ///

    • breaking

      added the new required request property ///

    • breaking

      request property / was restricted to a list of enum values

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      the request property default value returns was removed

    • info

      added the new returns enum value to the request property /

    • info

      added the media type application/vnd.api+json for the response with the status