Skip to main content
WEBHOOK
return
{
  "at": "2023-11-07T05:31:56Z",
  "order": {
    "customer": {
      "name": {
        "given": "<string>",
        "surname": "<string>"
      },
      "emailAddress": "[email protected]",
      "phoneNumber": "<string>"
    },
    "discounts": {
      "amount": "<string>",
      "currency": "<string>"
    },
    "id": "64e4da943dd822979a70bd12",
    "items": [
      {
        "fulfillmentLocationId": "123",
        "id": "<string>",
        "price": {
          "amount": "<string>",
          "currency": "<string>"
        },
        "product": {
          "name": "<string>",
          "externalId": "<string>"
        },
        "quantity": 1,
        "variant": {
          "name": "<string>",
          "externalId": "<string>",
          "sku": "<string>",
          "weight": {
            "kg": 1
          }
        },
        "externalId": "123"
      }
    ],
    "lineItemsTotal": {
      "amount": "<string>",
      "currency": "<string>"
    },
    "name": "<string>",
    "shippingCost": {
      "amount": "<string>",
      "currency": "<string>"
    },
    "taxes": {
      "amount": "<string>",
      "currency": "<string>"
    },
    "total": {
      "amount": "<string>",
      "currency": "<string>"
    },
    "externalId": "<string>"
  },
  "return": {
    "createdAt": "2023-11-07T05:31:56Z",
    "destination": {
      "mailingAddress": {
        "city": "<string>",
        "country": "<string>",
        "line1": "<string>",
        "postalCode": "<string>",
        "state": "<string>",
        "line2": ""
      },
      "phoneNumber": "<string>"
    },
    "giftCards": [
      {
        "amount": {
          "amount": "<string>",
          "currency": "<string>"
        },
        "code": "<string>",
        "externalId": "<string>"
      }
    ],
    "id": "<string>",
    "items": [
      {
        "id": "<string>",
        "orderItem": {
          "id": "<string>",
          "line_item_id": "<string>"
        },
        "quantity": 123,
        "reason": "<string>",
        "assessments": [
          {
            "assignedUser": {
              "email": "<string>",
              "firstName": "<string>",
              "id": "<string>",
              "lastName": "<string>",
              "name": "<string>"
            },
            "responses": [
              {
                "type": "<string>",
                "value": "<string>"
              }
            ]
          }
        ],
        "customerComment": "<string>",
        "exchangeItem": {
          "product": {
            "externalId": "<string>",
            "name": "<string>"
          },
          "quantity": 123,
          "variant": {
            "externalId": "<string>",
            "name": "<string>"
          }
        },
        "externalReturnLineItemId": "<string>",
        "greenReturn": true,
        "multipleChoiceQuestions": [
          {
            "answer": "<string>",
            "question": "<string>"
          }
        ],
        "productAdjustment": "<string>",
        "productId": "<string>",
        "reasonCode": "<string>",
        "reasonCodes": [
          "<string>"
        ],
        "reasons": [
          "<string>"
        ],
        "refund": {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          },
          "type": "<string>"
        },
        "shipmentGroupIds": [
          "<string>"
        ],
        "sku": "<string>",
        "status": "<string>",
        "variantId": "<string>"
      }
    ],
    "order": {
      "id": "64e4da943dd822979a70bd12",
      "name": "<string>"
    },
    "source": {
      "emailAddress": "[email protected]",
      "mailingAddress": {
        "city": "<string>",
        "country": "<string>",
        "line1": "<string>",
        "postalCode": "<string>",
        "state": "<string>",
        "line2": ""
      },
      "name": {
        "given": "<string>",
        "surname": "<string>"
      },
      "phoneNumber": "<string>"
    },
    "status": "open",
    "updatedAt": "2023-11-07T05:31:56Z",
    "compensationMethods": [
      "refund"
    ],
    "exchange": {
      "items": [
        {
          "id": "<string>",
          "quantity": 1,
          "variant": {
            "name": "<string>",
            "externalId": "<string>",
            "sku": "<string>",
            "weight": {
              "kg": 1
            }
          },
          "originalPrice": {
            "amount": "<string>",
            "currency": "<string>"
          },
          "price": {
            "amount": "<string>",
            "currency": "<string>",
            "tax": "<string>"
          },
          "product": {
            "name": "<string>",
            "externalId": "<string>"
          }
        }
      ],
      "provision": "deferred",
      "itemCount": 123,
      "order": {
        "externalId": "<string>"
      },
      "totalTax": {
        "amount": "<string>",
        "currency": "<string>"
      }
    },
    "externalOrderIds": [
      "<string>"
    ],
    "internalCreatedByName": "<string>",
    "notes": [
      {
        "message": "<string>",
        "image": "<string>"
      }
    ],
    "shipment": {
      "carrier": "<string>",
      "externalLocationId": "<string>",
      "formLabel": "<string>",
      "itemIds": [
        "<string>"
      ],
      "postageLabel": "<string>",
      "shipmentGroupId": "<string>",
      "status": "unknown",
      "tracker": "<string>",
      "trackingUrl": "<string>"
    },
    "shipments": [
      {
        "carrier": "<string>",
        "externalLocationId": "<string>",
        "formLabel": "<string>",
        "itemIds": [
          "<string>"
        ],
        "postageLabel": "<string>",
        "shipmentGroupId": "<string>",
        "status": "unknown",
        "tracker": "<string>",
        "trackingUrl": "<string>"
      }
    ],
    "shopifyOrderIds": [
      "<string>"
    ],
    "tags": [
      {
        "name": "<string>",
        "source": "<string>"
      }
    ],
    "totals": {
      "charge": {
        "amount": {
          "amount": "<string>",
          "currency": "<string>"
        }
      },
      "exchange": {
        "amount": {
          "amount": "<string>",
          "currency": "<string>"
        }
      },
      "refund": {
        "amount": {
          "amount": "<string>",
          "currency": "<string>"
        }
      },
      "storeCredit": {
        "amount": {
          "amount": "<string>",
          "currency": "<string>"
        }
      }
    },
    "type": "return"
  },
  "type": "backfill"
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Return event webhook.

Return event

at
string<date-time>

Event time

order
Order · object

Order for return.

return
Return · object

Return.

type
enum<string>

Event type

Available options:
backfill,
created,
updated

Response

Success. Return a 2xx status code to indicate success.