action fulfillment_get_returns {
  label: "List Returns"
  description: "Retrieves summary return activity during the queried timespan. Although return knowledge can be learned from `GET /orders/{id}` it can take an unknown amount of time for an order that is refused or undeliverable to return to an FDC facility. Instead we recommend regularly querying this API."
  provider: fulfillment
  method: GET
  path: "/returns"
  encoding: json
  input: {
    type: "object"
    properties: {
      fromDate: {
        type: "string"
      }
      limit: {
        type: "integer"
      }
      page: {
        type: "integer"
      }
      toDate: {
        type: "string"
      }
    }
    required: ["fromDate", "toDate"]
    additionalProperties: false
  }
  output: {
    type: "object"
    properties: {
      data: {
        type: "array"
        items: {
          type: "object"
          required: ["id", "updatedBy", "createdBy", "status", "reason", "createdAt", "updatedAt"]
          properties: {
            comments: {
              type: "string"
            }
            createdAt: {
              type: "string"
              format: "date-time"
            }
            createdBy: {
              type: "object"
              additionalProperties: true
            }
            id: {
              type: "integer"
            }
            order: {
              type: "object"
              properties: {
                id: {
                  type: "integer"
                }
                merchantId: {
                  type: "integer"
                }
                merchantOrderId: {
                  type: "string"
                }
              }
            }
            reason: {
              type: "object"
              required: ["id", "title"]
              properties: {
                id: {
                  type: "integer"
                }
                title: {
                  type: "string"
                }
              }
            }
            returnedBy: {
              type: "string"
            }
            rmaItems: {
              type: "array"
              items: {
                type: "object"
                properties: {
                  comments: {
                    type: "string"
                  }
                  id: {
                    type: "integer"
                  }
                  item: {
                    type: "object"
                    properties: {
                      id: {
                        type: "integer"
                      }
                      sku: {
                        type: "string"
                      }
                    }
                  }
                  nonRestockedReason: {
                    type: "object"
                    properties: {
                      id: {
                        type: "integer"
                      }
                      title: {
                        type: "string"
                      }
                    }
                  }
                  quantityExpected: {
                    type: "integer"
                  }
                  quantityRestocked: {
                    type: "integer"
                  }
                  quantityReturned: {
                    type: "integer"
                  }
                  quantityShipped: {
                    type: "integer"
                  }
                }
              }
            }
            rmaNumber: {
              type: "string"
            }
            status: {
              type: "object"
              required: ["id", "title"]
              properties: {
                id: {
                  type: "integer"
                }
                title: {
                  type: "string"
                }
              }
            }
            updatedAt: {
              type: "string"
              format: "date-time"
            }
            updatedBy: {
              type: "object"
              required: ["id"]
              properties: {
                id: {
                  type: "integer"
                }
              }
            }
          }
        }
      }
      meta: {
        type: "object"
        properties: {
          pagination: {
            type: "object"
            properties: {
              count: {
                type: "integer"
                description: "Count of records returned in response, this will be equal to or less then the limit parameter"
              }
              currentPage: {
                type: "integer"
                description: "Current page of the response, this will match the page parameter"
              }
              total: {
                type: "integer"
                description: "Total number of records available to request"
              }
              totalPages: {
                type: "integer"
                description: "Total number of pages available to request"
              }
            }
          }
        }
      }
    }
  }
}