Order return by order ID

POST

orders

{orderId}

actions

submit-return-request

curl --request POST \
  --url https://api.fabric.inc/v3/orders/{orderId}/actions/submit-return-request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "attributes": {
    "fraudCheckSessionId": "59f1d2b88de74aef96d3ec900ad548e0",
    "fraudStatus": "FRAUD_PASS"
  },
  "credits": [
    {
      "amount": 21.5,
      "attributes": {
        "giftCardNumber": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
      },
      "currency": "USD",
      "employeeId": "12312232",
      "note": "Credit request initiated",
      "paymentCounter": 1,
      "policyCode": "RC1",
      "reasonCode": "EC",
      "source": "CSR",
      "subReasonCode": "ACC",
      "type": "GIFT_CARD"
    }
  ],
  "employeeId": "62272e917b12209e68751d94",
  "fees": [
    {
      "amount": 34.56,
      "name": "RETURN_FEE",
      "reason": "Return fee",
      "type": "FEE"
    }
  ],
  "isExchange": false,
  "items": [
    {
      "exchange": {
        "isRefundingDisabled": true,
        "items": [
          {
            "initiateReshipment": true,
            "itemId": 1234,
            "itemUnitPrice": 10,
            "quantity": 10,
            "sku": "P1234"
          }
        ],
        "refund": {
          "amount": 34.56,
          "conversion": 1,
          "currency": "USD"
        }
      },
      "fees": [
        {
          "amount": 34.56,
          "name": "RETURN_FEE",
          "reason": "Return fee",
          "type": "FEE"
        }
      ],
      "isPolicyOverride": true,
      "orderLineItemId": "1",
      "quantity": 1,
      "reasonCode": "Incorrect order",
      "refundAmount": 21.5,
      "refunds": [
        {
          "amount": 34.56,
          "name": "RETURN_FEE",
          "reason": "Return fee",
          "type": "FEE"
        }
      ],
      "returnType": "RECEIVED",
      "scannedAt": "2022-07-11T15:03:14.642Z",
      "shipmentId": "62b37697c67b204dd18a7465",
      "shipmentLineId": "12",
      "subReasonCode": "Incorrect specification"
    }
  ],
  "reasonCode": "Incorrect item",
  "refunds": [
    {
      "amount": 34.56,
      "name": "RETURN_FEE",
      "reason": "Return fee",
      "type": "FEE"
    }
  ],
  "returnedAt": "2022-07-11T15:03:14.642Z",
  "source": "CSR",
  "totalRefundAmount": 21.5
}'

{
  "items": [
    {
      "lineItemId": "62f3dfc438bcab1951be0a19",
      "policyCode": "policyCode",
      "refundAmount": 21.5,
      "returnQuantity": 2,
      "returnStatus": "VALID"
    }
  ],
  "refundStatus": "REFUND_INITIATED",
  "totalRefundAmount": 21.5
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-fabric-tenant-id

string

required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-channel-id

string

required

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

x-fabric-request-id

string

Unique request ID

Path Parameters

orderId

string

required

24-character system-generated order ID returned in the response of Create Order - POST /orders endpoint.

Body

application/json

Return request

items

object[]

required

Item details

Return details of item

items.orderLineItemId

string

required

Unique identifier for each item in order

Example:

"1"

items.quantity

integer

required

Returned quantity of the given item

Example:

1

items.returnType

enum<string>

required

Return type

Available options:

PENDING,

PROCESSING,

REJECTED,

RECEIVED

Example:

"RECEIVED"

items.scannedAt

string

required

Scanned time of return (UTC)

Example:

"2022-07-11T15:03:14.642Z"

items.shipmentId

string

required

24-character system-generated shipment ID

Example:

"62b37697c67b204dd18a7465"

items.shipmentLineId

string

required

Unique identifier for each item in the shipment

Example:

"12"

items.exchange

object

Item exchange and return details

items.fees

object[]

Return fee details

items.isPolicyOverride

boolean

true: Disable policy check. false: Enable the policy check.

Example:

true

items.reasonCode

string

Reason code for return, varies from merchant to merchant.

Example:

"Incorrect order"

items.refundAmount

number

Merchant-defined total refund amount

Example:

21.5

items.refunds

object[]

Return fee details

items.subReasonCode

string

Sub-reason code for return, for another layer of classification

Example:

"Incorrect specification"

source

string

required

Merchant-defined source from where the return request was initiated. There are no pre-defined values; possible values are Customer Service Representative (CSR), point-of-sale (POS), etc.

Example:

"CSR"

attributes

object

Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs

Example:

{
  "fraudCheckSessionId": "59f1d2b88de74aef96d3ec900ad548e0",
  "fraudStatus": "FRAUD_PASS"
}

credits

object[]

Request for credits

credits.amount

number

required

Credits amount

Example:

21.5

credits.currency

string

required

Three-letter currency code as defined by ISO-4217

Example:

"USD"

credits.reasonCode

string

required

Reason code

Example:

"EC"

credits.source

string

required

Source of credits request

Example:

"CSR"

credits.type

enum<string>

required

Credit type. Currently, supports only Gift Card

Available options:

GIFT_CARD

Example:

"GIFT_CARD"

credits.attributes

object

Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs

Example:

{
  "giftCardNumber": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
}

credits.employeeId

string

Employee (ID or name) who initiated a the credits request

Example:

"12312232"

credits.note

string

Note

Example:

"Credit request initiated"

credits.paymentCounter

integer

A sequential or incremental counter associated with a payment for an order. Applicable in refund scenarios to identify the specific payment for refund.

Example:

1

credits.policyCode

string

Merchant-defined policy code, varies from merchant to merchant. If omitted, the default policy is used.

Example:

"RC1"

credits.subReasonCode

string

Subreason code

Example:

"ACC"

employeeId

string

Employee (ID or name) who initiated the request

Example:

"62272e917b12209e68751d94"

fees

object[]

Return fee details

isExchange

boolean

default:false

true: Return includes one or more exchanges. false: Only returns, no exchange.

Example:

false

reasonCode

string

Merchant-defined reason code for return

Example:

"Incorrect item"

refunds

object[]

Return fee details

returnedAt

string

Merchant-defined time for return (UTC)

Example:

"2022-07-11T15:03:14.642Z"

totalRefundAmount

number

Merchant-defined total refund amount

Example:

21.5

Response

201

application/json

Return request accepted

Details of returned order

items

object[]

Item details

Return details

refundStatus

enum<string>

Refund status

Available options:

REFUND_INITIATED,

REFUND_SUCCESS,

REFUND_FAILURE,

REFUND_PENDING

Example:

"REFUND_INITIATED"

totalRefundAmount

number

Merchant-defined total refund amount

Example:

21.5

Was this page helpful?

curl --request POST \
  --url https://api.fabric.inc/v3/orders/{orderId}/actions/submit-return-request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "attributes": {
    "fraudCheckSessionId": "59f1d2b88de74aef96d3ec900ad548e0",
    "fraudStatus": "FRAUD_PASS"
  },
  "credits": [
    {
      "amount": 21.5,
      "attributes": {
        "giftCardNumber": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
      },
      "currency": "USD",
      "employeeId": "12312232",
      "note": "Credit request initiated",
      "paymentCounter": 1,
      "policyCode": "RC1",
      "reasonCode": "EC",
      "source": "CSR",
      "subReasonCode": "ACC",
      "type": "GIFT_CARD"
    }
  ],
  "employeeId": "62272e917b12209e68751d94",
  "fees": [
    {
      "amount": 34.56,
      "name": "RETURN_FEE",
      "reason": "Return fee",
      "type": "FEE"
    }
  ],
  "isExchange": false,
  "items": [
    {
      "exchange": {
        "isRefundingDisabled": true,
        "items": [
          {
            "initiateReshipment": true,
            "itemId": 1234,
            "itemUnitPrice": 10,
            "quantity": 10,
            "sku": "P1234"
          }
        ],
        "refund": {
          "amount": 34.56,
          "conversion": 1,
          "currency": "USD"
        }
      },
      "fees": [
        {
          "amount": 34.56,
          "name": "RETURN_FEE",
          "reason": "Return fee",
          "type": "FEE"
        }
      ],
      "isPolicyOverride": true,
      "orderLineItemId": "1",
      "quantity": 1,
      "reasonCode": "Incorrect order",
      "refundAmount": 21.5,
      "refunds": [
        {
          "amount": 34.56,
          "name": "RETURN_FEE",
          "reason": "Return fee",
          "type": "FEE"
        }
      ],
      "returnType": "RECEIVED",
      "scannedAt": "2022-07-11T15:03:14.642Z",
      "shipmentId": "62b37697c67b204dd18a7465",
      "shipmentLineId": "12",
      "subReasonCode": "Incorrect specification"
    }
  ],
  "reasonCode": "Incorrect item",
  "refunds": [
    {
      "amount": 34.56,
      "name": "RETURN_FEE",
      "reason": "Return fee",
      "type": "FEE"
    }
  ],
  "returnedAt": "2022-07-11T15:03:14.642Z",
  "source": "CSR",
  "totalRefundAmount": 21.5
}'

{
  "items": [
    {
      "lineItemId": "62f3dfc438bcab1951be0a19",
      "policyCode": "policyCode",
      "refundAmount": 21.5,
      "returnQuantity": 2,
      "returnStatus": "VALID"
    }
  ],
  "refundStatus": "REFUND_INITIATED",
  "totalRefundAmount": 21.5
}

Release Notes

Authorizations

Headers

Path Parameters

Body

Response