@rapharacing/schemas/src/schemas/returnrequest.json

OpenAPI to JSON Schema to be used with middy for CC response validation

{
  "type": "object",
  "properties": {
    "cancellable": {
      "type": "boolean",
      "example": true,
      "description": "Boolean flag for whether the return request is cancellable"
    },
    "code": {
      "type": "string",
      "example": "00000001",
      "description": "Return request code"
    },
    "creationTime": {
      "type": "string",
      "format": "date-time",
      "example": "2020-12-31T09:00:00+0000",
      "description": "Date of the return request creation"
    },
    "deliveryCost": {
      "description": "Delivery cost",
      "$ref": "_definitions.json#/definitions/Price",
      "originalRef": "Price"
    },
    "order": {
      "description": "Order related to the return request",
      "$ref": "_definitions.json#/definitions/Order",
      "originalRef": "Order"
    },
    "refundDeliveryCost": {
      "type": "boolean",
      "example": false,
      "description": "Boolean flag for whether there is a delivery cost for refund"
    },
    "returnEntries": {
      "type": "array",
      "description": "Entries of the return request which contains information about the returned product",
      "items": {
        "$ref": "_definitions.json#/definitions/ReturnRequestEntry",
        "originalRef": "ReturnRequestEntry"
      }
    },
    "returnLabelDownloadUrl": {
      "type": "string",
      "description": "URL of the return label"
    },
    "rma": {
      "type": "string",
      "example": "00000001",
      "description": "Return merchandise authorization number"
    },
    "status": {
      "type": "string",
      "description": "Status of return request"
    },
    "subTotal": {
      "description": "Subtotal price",
      "$ref": "_definitions.json#/definitions/Price",
      "originalRef": "Price"
    },
    "totalPrice": {
      "description": "Total price",
      "$ref": "_definitions.json#/definitions/Price",
      "originalRef": "Price"
    }
  },
  "title": "ReturnRequest",
  "description": "Representation of a return request for an order",
  "$schema": "http://json-schema.org/schema#"
}